KContacts::ContactGroup

#include <contactgroup.h>

Classes

class  ContactGroupReference
 
class  ContactReference
 
class  Data
 

Public Types

typedef QVector< ContactGroupList
 

Public Member Functions

 ContactGroup ()
 
 ContactGroup (const ContactGroup &other)
 
 ContactGroup (const QString &name)
 
 ~ContactGroup ()
 
void append (const ContactReference &reference)
 
void append (const ContactGroupReference &reference)
 
void append (const Data &data)
 
ContactGroupReferencecontactGroupReference (int index)
 
const ContactGroupReferencecontactGroupReference (int index) const
 
int contactGroupReferenceCount () const
 
ContactReferencecontactReference (int index)
 
const ContactReferencecontactReference (int index) const
 
int contactReferenceCount () const
 
int count () const
 
Datadata (int index)
 
const Datadata (int index) const
 
int dataCount () const
 
QString id () const
 
QString name () const
 
ContactGroupoperator= (const ContactGroup &other)
 
bool operator== (const ContactGroup &other) const
 
void remove (const ContactReference &reference)
 
void remove (const ContactGroupReference &reference)
 
void remove (const Data &data)
 
void removeAllContactData ()
 
void removeAllContactGroupReferences ()
 
void removeAllContactReferences ()
 
void setId (const QString &id)
 
void setName (const QString &name)
 

Static Public Member Functions

static QString mimeType ()
 

Detailed Description

This class represents a group of contacts.

It can contain two types of contacts, either a reference or data. The reference entry is just an unique identifier which identifies the real contact in the system. The data entry contains a name and an email address.

Author
Tobias Koenig tokoe[email protected]@kde[email protected].org
Since
4.3

Definition at line 32 of file contactgroup.h.

Member Typedef Documentation

A list of contact groups.

Definition at line 310 of file contactgroup.h.

Constructor & Destructor Documentation

ContactGroup::ContactGroup ( )

Creates an empty contact group.

Definition at line 320 of file contactgroup.cpp.

ContactGroup::ContactGroup ( const ContactGroup other)

Creates a contact group from an other group.

Definition at line 325 of file contactgroup.cpp.

ContactGroup::ContactGroup ( const QString name)

Creates a contact group with the given name.

Definition at line 330 of file contactgroup.cpp.

ContactGroup::~ContactGroup ( )

Destroys the contact group.

Definition at line 336 of file contactgroup.cpp.

Member Function Documentation

void ContactGroup::append ( const ContactReference reference)

Appends a new contact reference to the contact group.

Definition at line 427 of file contactgroup.cpp.

void ContactGroup::append ( const ContactGroupReference reference)

Appends a new contact group reference to the contact group.

Definition at line 432 of file contactgroup.cpp.

void ContactGroup::append ( const Data data)

Appends a new contact data object to the contact group.

Definition at line 437 of file contactgroup.cpp.

ContactGroup::ContactGroupReference & ContactGroup::contactGroupReference ( int  index)

Returns the contact group reference at the given index.

Definition at line 396 of file contactgroup.cpp.

const ContactGroup::ContactGroupReference & ContactGroup::contactGroupReference ( int  index) const

Returns the contact group reference at the given index.

Definition at line 404 of file contactgroup.cpp.

int ContactGroup::contactGroupReferenceCount ( ) const

Returns the number of group references in this group.

Definition at line 370 of file contactgroup.cpp.

ContactGroup::ContactReference & ContactGroup::contactReference ( int  index)

Returns the contact reference at the given index.

Definition at line 380 of file contactgroup.cpp.

const ContactGroup::ContactReference & ContactGroup::contactReference ( int  index) const

Returns the contact reference at the given index.

Definition at line 388 of file contactgroup.cpp.

int ContactGroup::contactReferenceCount ( ) const

Returns the number of contact references in this group.

Definition at line 365 of file contactgroup.cpp.

int ContactGroup::count ( ) const

Returns the number of contacts in this group.

That includes the contact references and contact data.

Definition at line 360 of file contactgroup.cpp.

ContactGroup::Data & ContactGroup::data ( int  index)

Returns the contact data object at the given index.

Definition at line 413 of file contactgroup.cpp.

const ContactGroup::Data & ContactGroup::data ( int  index) const

Returns the contact data object at the given index.

Definition at line 420 of file contactgroup.cpp.

int ContactGroup::dataCount ( ) const

Returns the number of contact data objects in this group.

Definition at line 375 of file contactgroup.cpp.

QString ContactGroup::id ( ) const

Returns the unique id of the contact group.

Definition at line 355 of file contactgroup.cpp.

QString ContactGroup::mimeType ( )
static

Returns the MIME type used for Contact Groups.

Definition at line 490 of file contactgroup.cpp.

QString ContactGroup::name ( ) const

Returns the i18n'd name of the contact group.

Definition at line 345 of file contactgroup.cpp.

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

Definition at line 472 of file contactgroup.cpp.

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

Definition at line 481 of file contactgroup.cpp.

void ContactGroup::remove ( const ContactReference reference)

Removes the given contact reference from the contact group.

Definition at line 442 of file contactgroup.cpp.

void ContactGroup::remove ( const ContactGroupReference reference)

Removes the given contact group reference from the contact group.

Definition at line 447 of file contactgroup.cpp.

void ContactGroup::remove ( const Data data)

Removes the given contact data object from the contact group.

Definition at line 452 of file contactgroup.cpp.

void ContactGroup::removeAllContactData ( )

Removes all contact data from the contact group.

Definition at line 467 of file contactgroup.cpp.

void ContactGroup::removeAllContactGroupReferences ( )

Removes all contact group references from the contact group.

Definition at line 462 of file contactgroup.cpp.

void ContactGroup::removeAllContactReferences ( )

Removes all contact references from the contact group.

Definition at line 457 of file contactgroup.cpp.

void ContactGroup::setId ( const QString id)

Sets the unique id of the contact group.

Definition at line 350 of file contactgroup.cpp.

void ContactGroup::setName ( const QString name)

Sets the i18n'd name of the contact group.

Definition at line 340 of file contactgroup.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Aug 3 2020 22:54:20 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.