• Skip to content
  • Skip to link menu
KDE 4.8 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

akonadi

Public Types | Public Member Functions | Static Public Member Functions
CustomField Class Reference

#include <customfields_p.h>

List of all members.

Public Types

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

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

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal