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

kabc

  • KABC
  • ContactGroup
  • ContactReference
Public Types | Public Member Functions
KABC::ContactGroup::ContactReference Class Reference

#include <contactgroup.h>

List of all members.

Public Types

typedef QList< ContactReference > List

Public Member Functions

 ContactReference ()
 ContactReference (const ContactReference &other)
 ContactReference (const QString &uid)
 ~ContactReference ()
QString custom (const QString &key) const
void insertCustom (const QString &key, const QString &value)
ContactReference & operator= (const ContactReference &)
bool operator== (const ContactReference &) const
QString preferredEmail () const
void removeCustom (const QString &key)
void setPreferredEmail (const QString &email)
void setUid (const QString &uid)
QString uid () const

Detailed Description

This class represents a contact reference.


Member Typedef Documentation

typedef QList<ContactReference> KABC::ContactGroup::ContactReference::List

A list of contact references.

Definition at line 59 of file contactgroup.h.


Constructor & Destructor Documentation

ContactGroup::ContactReference::ContactReference ( )

Creates an empty contact reference.

Definition at line 52 of file contactgroup.cpp.

ContactGroup::ContactReference::ContactReference ( const ContactReference &  other)

Creates a contact reference from an other reference.

Definition at line 57 of file contactgroup.cpp.

ContactGroup::ContactReference::ContactReference ( const QString &  uid)

Creates a contact reference for the given contact uid.

Definition at line 62 of file contactgroup.cpp.

ContactGroup::ContactReference::~ContactReference ( )

Destroys the contact reference.

Definition at line 68 of file contactgroup.cpp.


Member Function Documentation

QString ContactGroup::ContactReference::custom ( const QString &  key) const

Returns the value for the given key, or an empty string if the entry for that key does not exists.

Definition at line 102 of file contactgroup.cpp.

void ContactGroup::ContactReference::insertCustom ( const QString &  key,
const QString &  value 
)

Inserts a custom entry.

If an entry with the same key already exists, it is overwritten.

Parameters:
keyThe unique key.
valueThe value.

Definition at line 92 of file contactgroup.cpp.

ContactGroup::ContactReference & ContactGroup::ContactReference::operator= ( const ContactReference &  other)

Definition at line 107 of file contactgroup.cpp.

bool ContactGroup::ContactReference::operator== ( const ContactReference &  other) const

Definition at line 117 of file contactgroup.cpp.

QString ContactGroup::ContactReference::preferredEmail ( ) const

Returns the preferred email address, or an empty string if no preferred email address is set.

Definition at line 87 of file contactgroup.cpp.

void ContactGroup::ContactReference::removeCustom ( const QString &  key)

Removes the custom entry with the given key.

Definition at line 97 of file contactgroup.cpp.

void ContactGroup::ContactReference::setPreferredEmail ( const QString &  email)

Sets the preferred email address.

Definition at line 82 of file contactgroup.cpp.

void ContactGroup::ContactReference::setUid ( const QString &  uid)

Sets the contact uid of the contact reference.

Note:
That is the Akonadi Item ID of the contact that is referenced here.

Definition at line 72 of file contactgroup.cpp.

QString ContactGroup::ContactReference::uid ( ) const

Returns the contact uid of the contact reference.

Note:
That is the Akonadi Item ID of the contact that is referenced here.

Definition at line 77 of file contactgroup.cpp.


The documentation for this class was generated from the following files:
  • contactgroup.h
  • contactgroup.cpp

kabc

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • 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.5
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