KABC::Field

KABC::Field Class Reference

List of all members.

Detailed Description

Definition at line 33 of file field.h.


Public Types

typedef QValueList< Field * > List
enum  FieldCategory {
  All = 0x0, Frequent = 0x01, Address = 0x02, Email = 0x04,
  Personal = 0x08, Organization = 0x10, CustomCategory = 0x20
}

Public Member Functions

virtual QString label ()
virtual int category ()
virtual QString value (const KABC::Addressee &)
virtual bool setValue (KABC::Addressee &, const QString &)
QString sortKey (const KABC::Addressee &)
virtual bool isCustom ()
virtual bool equals (Field *field)

Static Public Member Functions

static QString categoryLabel (int category)
static Field::List allFields ()
static Field::List defaultFields ()
static Field * createCustomField (const QString &label, int category, const QString &key, const QString &app)
static void deleteFields ()
static void saveFields (KConfig *cfg, const QString &identifier, const Field::List &fields)
static void saveFields (const QString &identifier, const Field::List &fields)
static Field::List restoreFields (KConfig *cfg, const QString &identifier)
static Field::List restoreFields (const QString &identifier)

Static Protected Member Functions

static void createField (int id, int category=0)
static void createDefaultField (int id, int category=0)

Friends

class FieldImpl

Member Enumeration Documentation

enum KABC::Field::FieldCategory
 

  • All -
  • Frequent -
  • Address -
  • Email -
  • Personal -
  • Organization -
  • CustomCategory -

Definition at line 50 of file field.h.

Member Function Documentation

Field::List Field::allFields (   )  [static]
 

Returns a list of all fields.

Definition at line 246 of file field.src.cpp.

int Field::category (   )  [virtual]
 

Returns the ored categories the field belongs to.

Definition at line 88 of file field.src.cpp.

QString Field::categoryLabel (  int  category  )  [static]
 

Returns the translated label for field category.

Definition at line 93 of file field.src.cpp.

Field * Field::createCustomField (  const QString &  label,
int  category,
const QString &  key,
const QString &  app
)  [static]
 

Creates a custom field.

Parameters:
label The label for this field
category The category of this field
key Unique key for this field
app Unique app name for this field

Definition at line 370 of file field.src.cpp.

Field::List Field::defaultFields (   )  [static]
 

Returns a list of the default fields.

Definition at line 255 of file field.src.cpp.

void Field::deleteFields (   )  [static]
 

Delete all fields from list.

Definition at line 275 of file field.src.cpp.

bool Field::equals (  Field *  field  )  [virtual]
 

Returns, if the field is equal with.

Parameters:
field. 

Definition at line 359 of file field.src.cpp.

bool Field::isCustom (   )  [virtual]
 

Returns, if the field is a user-defined field.

Definition at line 241 of file field.src.cpp.

QString Field::label (   )  [virtual]
 

Returns the translated label for this field.

Definition at line 77 of file field.src.cpp.

Field::List Field::restoreFields (  const QString &  identifier  )  [static]
 

This is the same as above, with the difference, that the list is loaded from KGlobal::config() from group "KABCFields".

Definition at line 326 of file field.src.cpp.

Field::List Field::restoreFields (  KConfig *  cfg,
const QString &  identifier
)  [static]
 

Load the field settings from a config file.

Parameters:
cfg The config file object
identifier The unique identifier

Definition at line 334 of file field.src.cpp.

void Field::saveFields (  const QString &  identifier,
const Field::List &  fields
)  [static]
 

This is the same as above, with the difference, that the list is stored in KGlobal::config() in group "KABCFields".

Definition at line 295 of file field.src.cpp.

void Field::saveFields (  KConfig *  cfg,
const QString &  identifier,
const Field::List &  fields
)  [static]
 

Save the field settings to a config file.

Parameters:
cfg The config file object
identifier The unique identifier
fields The list of the fields

Definition at line 304 of file field.src.cpp.

bool Field::setValue (  KABC::Addressee &  ,
const QString & 
)  [virtual]
 

Sets the value of the field in the given Addressee.

Returns true on success or false, if the given string couldn't be converted to a valid value.

Definition at line 211 of file field.src.cpp.

QString Field::sortKey (  const KABC::Addressee &   ) 
 

Returns a string, that can be used for sorting.

Definition at line 224 of file field.src.cpp.

QString Field::value (  const KABC::Addressee &   )  [virtual]
 

Returns a string representation of the value the field has in the given Addressee.

Returns QString::null, if it is not possible to convert the value to a string.

Definition at line 115 of file field.src.cpp.

The documentation for this class was generated from the following files:

kabc

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys