Home · All Classes · Annotated · Functions

QPimRecord Class Reference

The QPimRecord class is the base class for PIM data recorded in the Qtopia 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
• virtual QString notes () const = 0
• bool pruneDeadCategories ( const QList<QString> & validCats )
• void reassignCategoryId ( const QString & oldId, const QString & newId )
• virtual void removeCustomField ( const QString & key )
• void setCategories ( const QList<QString> & categories )
• void setCategories ( const QString & id )
• virtual void setCustomField ( const QString & key, const QString & value )
• void setCustomFields ( const QMap<QString, QString> & fields )
• virtual void setNotes ( const QString & text ) = 0
• QUniqueId uid () const
• virtual bool operator!= ( const QPimRecord & other ) const
• virtual 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 Qtopia database.

The Pim record class contains data that is common to all data used by the PIM applications, in particular a unique ID and a set of categories.

A QPimRecord's ID is returned by uid() and is set with setUid(). Each category is represented by an integer. A QPimRecord's categories are returned by categories() and are set with setCategories().

QPimRecord comparisons are provided by operator==() and operator!=().

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().

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

Subclass should reimplement this function to return a reference to the categories for this object.

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

This is an overloaded member function, provided for convenience.

Subclass should reimplement this function to return a reference to the categories for this object.

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().

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

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

See also setCustomFields().

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

Subclass should reimplement this function to return a reference to the custom fields for this object.

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

This is an overloaded member function, provided for convenience.

Subclass should reimplement this function to return a reference to the custom fields for this object.

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

Returns the notes for the record.

See also setNotes().

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

Removes categories from record that do not appear in validCats

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 key.

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

Sets the record to belong to the set of categories specificed by categories.

See also categories().

void QPimRecord::setCategories ( const QString & id )

This is an overloaded member function, provided for convenience.

Sets the record to belong only to the category specified by id.

See also categories().

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

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

See also customField().

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

Sets the custom fields for the record to fields.

See also customFields().

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

Sets the notes for the record to text.

See also notes().

QUniqueId QPimRecord::uid () const

Returns the unique ID for this record.

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

Subclass should reimplement this function to return a reference to the unqiue id for this object.

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

This is an overloaded member function, provided for convenience.

Subclass should reimplement this function to return a reference to the unqiue id for this object.

bool QPimRecord::operator!= ( const QPimRecord & other ) const   [virtual]

Returns true if the record does not have the same Uid as other; otherwise returns false.

See also operator==().

bool QPimRecord::operator== ( const QPimRecord & other ) const   [virtual]

Returns true if the record has the same Uid as other; otherwise returns false.

See also operator!=().