kabc
#include <field.h>
Public Types | |
enum | FieldCategory { All = 0x0, Frequent = 0x01, Address = 0x02, Email = 0x04, Personal = 0x08, Organization = 0x10, CustomCategory = 0x20 } |
typedef QList< Field * > | List |
Public Member Functions | |
virtual int | category () |
virtual bool | equals (Field *field) |
virtual bool | isCustom () |
virtual QString | label () |
virtual bool | setValue (KABC::Addressee &, const QString &) |
QString | sortKey (const KABC::Addressee &) |
virtual QString | value (const KABC::Addressee &) |
Static Public Member Functions | |
static Field::List | allFields () |
static QString | categoryLabel (int category) |
static Field * | createCustomField (const QString &label, int category, const QString &key, const QString &app) |
static Field::List | defaultFields () |
static void | deleteFields () |
static Field::List | restoreFields (const KConfigGroup &cfg, const QString &identifier) |
static Field::List | restoreFields (const QString &identifier) |
static void | saveFields (KConfigGroup &cfg, const QString &identifier, const Field::List &fields) |
static void | saveFields (const QString &identifier, const Field::List &fields) |
Static Protected Member Functions | |
static void | createDefaultField (int id, int category=0) |
static void | createField (int id, int category=0) |
Detailed Description
Represents a field in the Addressbook.
This class represents a field in the Addressbook database. It provides methods for accessing meta-information about the field (such as label() or category()) as well as getting or setting the field's value in an instance of Addressee (value(), setValue()).
Furthermore, some static methods are provided for getting a list of all fields (allFields(), defaultFields()), for creating new fields (createCustomField()) and for saving or loading fields to/from a config file (saveFields(), restoreFields()).
Member Typedef Documentation
typedef QList<Field *> KABC::Field::List |
Member Enumeration Documentation
Represents the category a field belongs to.
Enumerator | |
---|---|
All |
All fields. |
Frequent |
Frequently used fields. |
Address |
Fields which belong to the address, such as Street, City, Zip, etc. |
Fields which store information about the e-mail contact, such as e-mail address or mail client. | |
Personal |
Personal fields, such as Birthday, Home Address fields, IM Address, etc. |
Organization |
Fields about the organization, such as Business Address fields, Department, Profession, etc. |
CustomCategory |
Custom (user-defined) fields. |
Member Function Documentation
|
static |
Returns a list of all fields.
|
virtual |
Returns the ored categories the field belongs to.
|
static |
Returns the translated label for category
.
- Parameters
-
category the category of type FieldCategory
- Returns
- the translated label
|
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
|
staticprotected |
Creates a field and appends it to the list of default fields.
- Parameters
-
id The identifier for the field category The optional category for the field
|
staticprotected |
Creates a field and appends it to the general list of fields.
- Parameters
-
id The identifier for the field category The optional category for the field
|
static |
Returns a list of the default fields.
|
static |
Delete all fields from list.
|
virtual |
Returns, if the field is equal with field
.
- Parameters
-
field the field to compare this field to
- Returns
true
if the fields are equal,false
otherwise
|
virtual |
Returns, if the field is a user-defined field.
- Returns
true
if this is a custom field,false
otherwise
|
virtual |
Returns the translated label for this field.
|
static |
Load the field settings from a config file.
- Parameters
-
cfg The config file object identifier The unique identifier
|
static |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Here, the list is loaded from KGlobal::config() from group "KABCFields".
- Parameters
-
identifier The unique identifier
|
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
|
static |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Here, the list is stored in KGlobal::config() in group "KABCFields".
- Parameters
-
identifier The unique identifier fields The list of the fields
|
virtual |
Sets the value of the field in the given Addressee.
- Returns
true
on success orfalse
, if the given string couldn't be converted to a valid value.
QString KABC::Field::sortKey | ( | const KABC::Addressee & | ) |
Returns a string, that can be used for sorting.
|
virtual |
Returns a string representation of the value the field has in the given Addressee.
- Returns
- the string representation of the value or QString(), if it is not possible to convert the value to a string.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:29:43 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.