CustomField Class Reference

#include <customfields_p.h>

Public Types
typedef QVector< CustomField >	List
enum	Scope { LocalScope, GlobalScope, ExternalScope }
enum	Type {   TextType, NumericType, BooleanType, DateType,   TimeType, DateTimeType, UrlType }

Public Member Functions
	CustomField (const QString &key, const QString &title, Type type, Scope scope)
QString	key () const
Scope	scope () const
void	setKey (const QString &key)
void	setScope (Scope scope)
void	setTitle (const QString &title)
void	setType (Type type)
void	setValue (const QString &value)
QString	title () const
QVariantMap	toVariantMap () const
Type	type () const
QString	value () const

Static Public Member Functions
static CustomField	fromVariantMap (const QVariantMap &map, Scope scope)
static Type	stringToType (const QString &type)
static QString	typeToString (Type type)

Detailed Description

A class that represents non-standard contact fields.

There exists three scopes of fields. To the local scope belong all custom fields that are defined by the user and that exists only for one contact. The description for these fields are stored inside ContactMetaData as custom attribute of the Akonadi item that represents the contact. To the global scope belong all custom fields that are defined by the user but shall be available in all contacts of the address book. Their description is stored by CustomFieldManager in $HOME/.kde/share/config/akonadi_contactrc. All other custom fields belong to the external scope, they come with import of contacts from other PIM applications (e.g. further X- entries in vCards). Their description is created on the fly when editing the custom fields.

The description of a custom field covers the key, title and type.

Definition at line 47 of file customfields_p.h.

Member Enumeration Documentation

enum CustomField::Scope

Enumerator
LocalScope	Field has been defined by user for one contact.
GlobalScope	Field has been defined by user for all contacts.
ExternalScope	Field has been defined by the external data source (e.g. vCard)

Definition at line 62 of file customfields_p.h.

---

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

• customfields_p.h
• customfields.cpp