KContacts::ContactGroup Class Reference

#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 ContactGroupReference &reference)
void	append (const ContactReference &reference)
void	append (const Data &data)
ContactGroupReference &	contactGroupReference (int index)
const ContactGroupReference &	contactGroupReference (int index) const
int	contactGroupReferenceCount () const
ContactReference &	contactReference (int index)
const ContactReference &	contactReference (int index) const
int	contactReferenceCount () const
int	count () const
Data &	data (int index)
const Data &	data (int index) const
int	dataCount () const
QString	id () const
QString	name () const
ContactGroup &	operator= (const ContactGroup &other)
bool	operator== (const ContactGroup &other) const
void	remove (const ContactGroupReference &reference)
void	remove (const ContactReference &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.nosp@m.@kde.nosp@m..org

Since

4.3

Definition at line 33 of file contactgroup.h.

Member Typedef Documentation

List

QList<ContactGroup> KContacts::ContactGroup::List

A list of contact groups.

Definition at line 310 of file contactgroup.h.

Constructor & Destructor Documentation

ContactGroup() [1/3]

ContactGroup::ContactGroup

(

)

Creates an empty contact group.

Definition at line 315 of file contactgroup.cpp.

ContactGroup() [2/3]

ContactGroup::ContactGroup

(

const ContactGroup &

other

)

Creates a contact group from an other group.

Definition at line 320 of file contactgroup.cpp.

ContactGroup() [3/3]

ContactGroup::ContactGroup

(

const QString &

name

)

Creates a contact group with the given name.

Definition at line 325 of file contactgroup.cpp.

~ContactGroup()

ContactGroup::~ContactGroup

(

)

Destroys the contact group.

Definition at line 331 of file contactgroup.cpp.

Member Function Documentation

append() [1/3]

void ContactGroup::append

(

const ContactGroupReference &

reference

)

Appends a new contact group reference to the contact group.

Definition at line 422 of file contactgroup.cpp.

append() [2/3]

void ContactGroup::append

(

const ContactReference &

reference

)

Appends a new contact reference to the contact group.

Definition at line 417 of file contactgroup.cpp.

append() [3/3]

void ContactGroup::append

(

const Data &

data

)

Appends a new contact data object to the contact group.

Definition at line 427 of file contactgroup.cpp.

contactGroupReference() [1/2]

ContactGroup::ContactGroupReference & ContactGroup::contactGroupReference

(

int

index

)

Returns the contact group reference at the given index.

Definition at line 389 of file contactgroup.cpp.

contactGroupReference() [2/2]

const ContactGroup::ContactGroupReference & ContactGroup::contactGroupReference

(

int

index

)

const

Returns the contact group reference at the given index.

Definition at line 396 of file contactgroup.cpp.

contactGroupReferenceCount()

int ContactGroup::contactGroupReferenceCount

(

)

const

Returns the number of group references in this group.

Definition at line 365 of file contactgroup.cpp.

contactReference() [1/2]

ContactGroup::ContactReference & ContactGroup::contactReference

(

int

index

)

Returns the contact reference at the given index.

Definition at line 375 of file contactgroup.cpp.

contactReference() [2/2]

const ContactGroup::ContactReference & ContactGroup::contactReference

(

int

index

)

const

Returns the contact reference at the given index.

Definition at line 382 of file contactgroup.cpp.

contactReferenceCount()

int ContactGroup::contactReferenceCount

(

)

const

Returns the number of contact references in this group.

Definition at line 360 of file contactgroup.cpp.

count()

int ContactGroup::count

(

)

const

Returns the number of contacts in this group.

That includes the contact references and contact data.

Definition at line 355 of file contactgroup.cpp.

data() [1/2]

ContactGroup::Data & ContactGroup::data

(

int

index

)

Returns the contact data object at the given index.

Definition at line 403 of file contactgroup.cpp.

data() [2/2]

const ContactGroup::Data & ContactGroup::data

(

int

index

)

const

Returns the contact data object at the given index.

Definition at line 410 of file contactgroup.cpp.

dataCount()

int ContactGroup::dataCount

(

)

const

Returns the number of contact data objects in this group.

Definition at line 370 of file contactgroup.cpp.

id()

QString ContactGroup::id

(

)

const

Returns the unique id of the contact group.

Definition at line 350 of file contactgroup.cpp.

mimeType()

QString ContactGroup::mimeType ( )

static

Returns the MIME type used for Contact Groups.

Definition at line 480 of file contactgroup.cpp.

name()

QString ContactGroup::name

(

)

const

Returns the i18n'd name of the contact group.

Definition at line 340 of file contactgroup.cpp.

operator=()

ContactGroup & ContactGroup::operator=

(

const ContactGroup &

other

)

Definition at line 462 of file contactgroup.cpp.

operator==()

bool ContactGroup::operator==

(

const ContactGroup &

other

)

const

Definition at line 471 of file contactgroup.cpp.

remove() [1/3]

void ContactGroup::remove

(

const ContactGroupReference &

reference

)

Removes the given contact group reference from the contact group.

Definition at line 437 of file contactgroup.cpp.

remove() [2/3]

void ContactGroup::remove

(

const ContactReference &

reference

)

Removes the given contact reference from the contact group.

Definition at line 432 of file contactgroup.cpp.

remove() [3/3]

void ContactGroup::remove

(

const Data &

data

)

Removes the given contact data object from the contact group.

Definition at line 442 of file contactgroup.cpp.

removeAllContactData()

void ContactGroup::removeAllContactData

(

)

Removes all contact data from the contact group.

Definition at line 457 of file contactgroup.cpp.

removeAllContactGroupReferences()

void ContactGroup::removeAllContactGroupReferences

(

)

Removes all contact group references from the contact group.

Definition at line 452 of file contactgroup.cpp.

removeAllContactReferences()

void ContactGroup::removeAllContactReferences

(

)

Removes all contact references from the contact group.

Definition at line 447 of file contactgroup.cpp.

setId()

void ContactGroup::setId

(

const QString &

id

)

Sets the unique id of the contact group.

Definition at line 345 of file contactgroup.cpp.

setName()

void ContactGroup::setName

(

const QString &

name

)

Sets the i18n'd name of the contact group.

Definition at line 335 of file contactgroup.cpp.

---

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

• contactgroup.h
• contactgroup.cpp