Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

QPimRecord Class Reference
[QtMessagingModule, QtPimModule, QtTelephonyModule, QtUiModule]

The QPimRecord class is the base class for PIM data recorded in the Qt Extended database. More...

    #include <QPimRecord>

Inherited by QAppointment, QContact, and QTask.

• List of all members, including inherited members

Public Functions

• virtual ~QPimRecord ()
• QList<QString> categories () const
• virtual QString customField ( const QString & key ) const
• QMap<QString, QString> customFields () const
• QMap<QString, QUniqueId> dependentChildren () const
• QList<QUniqueId> dependentChildrenOfType ( const QString & type ) const
• virtual QString notes () const = 0
• QUniqueId parentDependency () const
• QString parentDependencyType () const
• bool pruneDeadCategories ( const QList<QString> & categories )
• void reassignCategoryId ( const QString & oldId, const QString & newId )
• virtual void removeCustomField ( const QString & key )
• void setCategories ( const QList<QString> & categories )
• void setCategories ( const QString & identifier )
• virtual void setCustomField ( const QString & key, const QString & value )
• void setCustomFields ( const QMap<QString, QString> & fields )
• virtual void setNotes ( const QString & text ) = 0
• void setUid ( const QUniqueId & identifier )
• QUniqueId uid () const
• bool operator!= ( const QPimRecord & other ) const
• bool operator== ( const QPimRecord & other ) const

Protected Functions

• virtual QList<QString> & categoriesRef () = 0
• virtual const QList<QString> & categoriesRef () const = 0
• virtual QMap<QString, QString> & customFieldsRef () = 0
• virtual const QMap<QString, QString> & customFieldsRef () const = 0
• virtual QUniqueId & uidRef () = 0
• virtual const QUniqueId & uidRef () const = 0

Detailed Description

The QPimRecord class is the base class for PIM data recorded in the Qt Extended database.

The QPimRecord class contains data that is common to the differing kinds of PIM records such as contacts, tasks and appointments. It is an also abstract and as such should not be created explicitly. Instead use one of the subclasses, QContact, QAppointment or QTask.

See also Pim Library.

Member Function Documentation

QPimRecord::~QPimRecord ()   [virtual]

Destroys the record.

QList<QString> QPimRecord::categories () const

Returns the set of categories the record belongs to.

See also setCategories() and categoriesRef().

QList<QString> & QPimRecord::categoriesRef ()   [pure virtual protected]

Subclasses should re-implement this function to return a reference to the categories for this object.

See also categories().

const QList<QString> & QPimRecord::categoriesRef () const   [pure virtual protected]

This is an overloaded member function, provided for convenience.

Subclasses should re-implement this function to return a reference to the categories for this object.

See also categories().

QString QPimRecord::customField ( const QString & key ) const   [virtual]

Returns the string stored for the custom field key. Returns a null string if the field does not exist.

See also setCustomField() and customFields().

QMap<QString, QString> QPimRecord::customFields () const

Returns a map of custom field key and value pairs for the record.

See also setCustomFields(), customField(), and customFieldsRef().

QMap<QString, QString> & QPimRecord::customFieldsRef ()   [pure virtual protected]

Subclasses should re-implement this function to return a reference to the custom fields for this object.

See also customFields().

const QMap<QString, QString> & QPimRecord::customFieldsRef () const   [pure virtual protected]

This is an overloaded member function, provided for convenience.

Subclasses should re-implement this function to return a reference to the custom fields for this object.

See also customFields().

QMap<QString, QUniqueId> QPimRecord::dependentChildren () const

Returns the identifiers and type of dependency for any records that depend on this record.

See also dependentChildrenOfType().

QList<QUniqueId> QPimRecord::dependentChildrenOfType ( const QString & type ) const

Returns the record identifiers for any records that have the specified type of dependency on this record.

For example, if this record is a QContact, there may be QAppointment objects that have a "birthday" or "anniversary" dependency on this record.

See also dependentChildren().

QString QPimRecord::notes () const   [pure virtual]

Returns the notes for the record.

See also setNotes().

QUniqueId QPimRecord::parentDependency () const

If this record is a dependant of another record (for example, this record is the appointment that represents a contact's birthday), this function returns the identifier for the original record.

Otherwise, returns a null identifier.

See also parentDependencyType().

QString QPimRecord::parentDependencyType () const

If this record is a dependant of another record (for example, this record is the appointment that represents a contact's birthday), this function returns the type of the dependency. The types are defined by the PIM library, and include:

• "birthday" - the parent record is a QContact, and the dependent record is the QAppointment representing that contact's birthday
• "anniversary" - the parent record is a QContact, and the dependent record is the QAppointment representing that contact's anniversary
• "duedate" - the parent record is a QTask, and the dependent record is the QAppointment representing that task's due date.

If there is no dependency, this will return a null string.

See also parentDependency().

bool QPimRecord::pruneDeadCategories ( const QList<QString> & categories )

Removes categories from record that do not appear in the given set of valid categories. Returns true if the record was modified.

void QPimRecord::reassignCategoryId ( const QString & oldId, const QString & newId )

Renames category oldId in record to category newId.

void QPimRecord::removeCustomField ( const QString & key )   [virtual]

Removes the custom field for the given key.

void QPimRecord::setCategories ( const QList<QString> & categories )

Sets the record to belong to the given set of categories.

See also categories() and Categories.

void QPimRecord::setCategories ( const QString & identifier )

This is an overloaded member function, provided for convenience.

Sets the record to belong only to the given category identifier.

See also categories() and Categories.

void QPimRecord::setCustomField ( const QString & key, const QString & value )   [virtual]

Sets the string stored for the custom field key to the given value.

Keys with empty values will not be stored, and is equivalent to calling removeCustomField().

See also customField().

void QPimRecord::setCustomFields ( const QMap<QString, QString> & fields )

Sets the custom fields for the record to the given fields.

Custom fields allow storing data that doesn't fit into the existing fields for a given PIM record.

Keys with empty values will not be stored.

See also customFields() and setCustomField().

void QPimRecord::setNotes ( const QString & text )   [pure virtual]

Sets the notes for the record to the given text.

See also notes().

void QPimRecord::setUid ( const QUniqueId & identifier )

Sets the record to have given unique identifier.

See also uid().

QUniqueId QPimRecord::uid () const

Returns the unique identifier for this record.

See also setUid() and uidRef().

QUniqueId & QPimRecord::uidRef ()   [pure virtual protected]

Subclasses should re-implement this function to return a reference to the identifier for this object.

See also uid().

const QUniqueId & QPimRecord::uidRef () const   [pure virtual protected]

This is an overloaded member function, provided for convenience.

Subclasses should re-implement this function to return a reference to the identifier for this object.

See also uid().

bool QPimRecord::operator!= ( const QPimRecord & other ) const

Returns true if this record and the other record are not equal according to the contract specified by operator==().

See also operator==().

bool QPimRecord::operator== ( const QPimRecord & other ) const

Returns true if this record and the other record have all the same:

• identifier as returned by uid()
• categories
• parentDependency and parentDependencyType
• custom fields
• notes

and otherwise returns false.

See also operator!=().