kabc
#include <contactgroup.h>
Classes | |
class | ContactGroupReference |
class | ContactReference |
class | Data |
Public Types | |
typedef QList< ContactGroup > | List |
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) |
ContactGroupReference & | contactGroupReference (unsigned int index) |
const ContactGroupReference & | contactGroupReference (unsigned int index) const |
unsigned int | contactGroupReferenceCount () const |
ContactReference & | contactReference (unsigned int index) |
const ContactReference & | contactReference (unsigned int index) const |
unsigned int | contactReferenceCount () const |
unsigned int | count () const |
Data & | data (unsigned int index) |
const Data & | data (unsigned int index) const |
unsigned int | dataCount () const |
QString | id () const |
QString | name () const |
ContactGroup & | operator= (const ContactGroup &) |
bool | operator== (const ContactGroup &) 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.
- Since
- 4.3
Definition at line 46 of file contactgroup.h.
Member Typedef Documentation
typedef QList<ContactGroup> KABC::ContactGroup::List |
A list of contact groups.
Definition at line 311 of file contactgroup.h.
Constructor & Destructor Documentation
ContactGroup::ContactGroup | ( | ) |
Creates an empty contact group.
Definition at line 323 of file contactgroup.cpp.
ContactGroup::ContactGroup | ( | const ContactGroup & | other | ) |
Creates a contact group from an other
group.
Definition at line 328 of file contactgroup.cpp.
ContactGroup::ContactGroup | ( | const QString & | name | ) |
Creates a contact group with the given name.
Definition at line 333 of file contactgroup.cpp.
ContactGroup::~ContactGroup | ( | ) |
Destroys the contact group.
Definition at line 339 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 430 of file contactgroup.cpp.
void ContactGroup::append | ( | const ContactGroupReference & | reference | ) |
Appends a new contact group reference
to the contact group.
Definition at line 435 of file contactgroup.cpp.
void ContactGroup::append | ( | const Data & | data | ) |
Appends a new contact data
object to the contact group.
Definition at line 440 of file contactgroup.cpp.
ContactGroup::ContactGroupReference & ContactGroup::contactGroupReference | ( | unsigned int | index | ) |
Returns the contact group reference at the given index
.
Definition at line 399 of file contactgroup.cpp.
const ContactGroup::ContactGroupReference & ContactGroup::contactGroupReference | ( | unsigned int | index | ) | const |
Returns the contact group reference at the given index
.
Definition at line 407 of file contactgroup.cpp.
unsigned int ContactGroup::contactGroupReferenceCount | ( | ) | const |
Returns the number of group references in this group.
Definition at line 373 of file contactgroup.cpp.
ContactGroup::ContactReference & ContactGroup::contactReference | ( | unsigned int | index | ) |
Returns the contact reference at the given index
.
Definition at line 383 of file contactgroup.cpp.
const ContactGroup::ContactReference & ContactGroup::contactReference | ( | unsigned int | index | ) | const |
Returns the contact reference at the given index
.
Definition at line 391 of file contactgroup.cpp.
unsigned int ContactGroup::contactReferenceCount | ( | ) | const |
Returns the number of contact references in this group.
Definition at line 368 of file contactgroup.cpp.
unsigned int ContactGroup::count | ( | ) | const |
Returns the number of contacts in this group.
That includes the contact references and contact data.
Definition at line 363 of file contactgroup.cpp.
ContactGroup::Data & ContactGroup::data | ( | unsigned int | index | ) |
Returns the contact data object at the given index
.
Definition at line 416 of file contactgroup.cpp.
const ContactGroup::Data & ContactGroup::data | ( | unsigned int | index | ) | const |
Returns the contact data object at the given index
.
Definition at line 423 of file contactgroup.cpp.
unsigned int ContactGroup::dataCount | ( | ) | const |
Returns the number of contact data objects in this group.
Definition at line 378 of file contactgroup.cpp.
QString ContactGroup::id | ( | ) | const |
Returns the unique id of the contact group.
Definition at line 358 of file contactgroup.cpp.
|
static |
Returns the MIME type used for Contact Groups.
Definition at line 493 of file contactgroup.cpp.
QString ContactGroup::name | ( | ) | const |
Returns the i18n'd name of the contact group.
Definition at line 348 of file contactgroup.cpp.
ContactGroup & ContactGroup::operator= | ( | const ContactGroup & | other | ) |
Definition at line 475 of file contactgroup.cpp.
bool ContactGroup::operator== | ( | const ContactGroup & | other | ) | const |
Definition at line 484 of file contactgroup.cpp.
void ContactGroup::remove | ( | const ContactReference & | reference | ) |
Removes the given contact reference
from the contact group.
Definition at line 445 of file contactgroup.cpp.
void ContactGroup::remove | ( | const ContactGroupReference & | reference | ) |
Removes the given contact group reference
from the contact group.
Definition at line 450 of file contactgroup.cpp.
void ContactGroup::remove | ( | const Data & | data | ) |
Removes the given contact data
object from the contact group.
Definition at line 455 of file contactgroup.cpp.
void ContactGroup::removeAllContactData | ( | ) |
Removes all contact data from the contact group.
Definition at line 470 of file contactgroup.cpp.
void ContactGroup::removeAllContactGroupReferences | ( | ) |
Removes all contact group references from the contact group.
Definition at line 465 of file contactgroup.cpp.
void ContactGroup::removeAllContactReferences | ( | ) |
Removes all contact references from the contact group.
Definition at line 460 of file contactgroup.cpp.
void ContactGroup::setId | ( | const QString & | id | ) |
Sets the unique id
of the contact group.
Definition at line 353 of file contactgroup.cpp.
void ContactGroup::setName | ( | const QString & | name | ) |
Sets the i18n'd name
of the contact group.
Definition at line 343 of file contactgroup.cpp.
The documentation for this class was generated from the following files:
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.