QOrganizerItem Class Reference
The QOrganizerItem class represents an addressbook organizeritem. More...
#include <QOrganizerItem>
Inherited by QOrganizerEvent, QOrganizerEventOccurrence, QOrganizerJournal, QOrganizerNote, QOrganizerTodo, and QOrganizerTodoOccurrence.
Public Functions
| QOrganizerItem () |
| QOrganizerItem ( const QOrganizerItem & other ) |
| ~QOrganizerItem () |
void | addComment ( const QString & comment ) |
void | clearComments () |
void | clearDetails () |
QStringList | comments () const |
QString | description () const |
QOrganizerItemDetail | detail ( const QString & definitionName ) const |
QOrganizerItemDetail | detail ( const QLatin1Constant & definitionName ) const |
T | detail () const |
QList<QOrganizerItemDetail> | details ( const QString & definitionName = QString() ) const |
QList<QOrganizerItemDetail> | details ( const QString & definitionName, const QString & fieldName, const QString & value ) const |
QList<QOrganizerItemDetail> | details ( const QLatin1Constant & definitionName ) const |
QList<QOrganizerItemDetail> | details ( const QLatin1Constant & definitionName, const QLatin1Constant & fieldName, const QString & value ) |
QList<T> | details () const |
QList<T> | details ( const QString & fieldName, const QString & value ) const |
QString | displayLabel () const |
QString | guid () const |
QOrganizerItemId | id () const |
bool | isEmpty () const |
QOrganizerItemLocalId | localId () const |
bool | removeDetail ( QOrganizerItemDetail * detail ) |
bool | saveDetail ( QOrganizerItemDetail * detail ) |
void | setDescription ( const QString & description ) |
void | setDescription ( const QOrganizerItemDescription & description ) |
void | setDisplayLabel ( const QString & label ) |
void | setDisplayLabel ( const QOrganizerItemDisplayLabel & label ) |
void | setGuid ( const QString & guid ) |
void | setId ( const QOrganizerItemId & id ) |
void | setType ( const QString & type ) |
void | setType ( const QOrganizerItemType & type ) |
QString | type () const |
bool | operator!= ( const QOrganizerItem & other ) const |
QOrganizerItem & | operator= ( const QOrganizerItem & other ) |
bool | operator== ( const QOrganizerItem & other ) const |
Related Non-Members
uint | qHash ( const QOrganizerItem & key ) |
Macros
Detailed Description
The QOrganizerItem class represents an addressbook organizeritem.
Individual organizeritems, groups, and other types of organizeritems are represented with a QOrganizerItem object. In addition to the type, a QOrganizerItem consists of information that belongs to the organizeritem.
A QOrganizerItem object has a collection of details (like a start date and location). Each detail (which can have multiple fields) is stored in an appropriate subclass of QOrganizerItemDetail, and the QOrganizerItem allows retrieving these details in various ways.
A QOrganizerItem instance represents the in-memory version of a calendar organizeritem, and has no tie to a specific QOrganizerItemManager. It is possible for the contents of a QOrganizerItem to change independently of the contents that are stored persistently in a QOrganizerItemManager. A QOrganizerItem has an ID associated with it when it is first retrieved from a QOrganizerItemManager, or after it has been first saved, and this allows clients to track changes using the signals in QOrganizerItemManager.
A QOrganizerItem has a number of mandatory details:
- A QOrganizerItemType, with the type of the organizeritem (individual event, todo, journal etc)
- etc etc
See also QOrganizerItemManager and QOrganizerItemDetail.
Member Function Documentation
QOrganizerItem::QOrganizerItem ()
Construct an empty organizer item.
The organizer item will have an empty display label, an empty id, and an empty description and have type QOrganizerItemType::TypeNote. The isEmpty() function will return true.
QOrganizerItem::QOrganizerItem ( const QOrganizerItem & other )
Initializes this QOrganizerItem from other
QOrganizerItem::~QOrganizerItem ()
Frees the memory used by this QOrganizerItem
void QOrganizerItem::addComment ( const QString & comment )
Adds the comment comment to this item
void QOrganizerItem::clearComments ()
Clears the comments (arbitrary notes) about this item
void QOrganizerItem::clearDetails ()
Removes all details of the organizeritem. This function does not modify the id or type of the organizeritem. Calling isEmpty() after calling this function will return true. The empty item becomes a QOrganizerNote.
QStringList QOrganizerItem::comments () const
Returns the list of comments (or arbitrary notes about the item) which pertain to this item
QString QOrganizerItem::description () const
Returns the human-readable description of the item
See also setDescription().
QOrganizerItemDetail QOrganizerItem::detail ( const QString & definitionName ) const
Returns the first detail stored in the organizeritem with the given definitionName
Returns the first detail stored in the organizeritem which with the given definitionName. The definitionName argument is typically the detail name constant provided by a specific subclass of QOrganizerItemDetail.
It would usually be more convenient to use the template version of this function.
T QOrganizerItem::detail () const
Returns the first detail of the template parameter type, as returned by the template details() function. The type must be a subclass of QOrganizerItemDetail.
QList<QOrganizerItemDetail> QOrganizerItem::details ( const QString & definitionName = QString() ) const
Returns a list of details with the given definitionName The definitionName string can be determined by the DefinitionName attribute of defined objects (e.g. QOrganizerItemPhoneNumber::DefinitionName) or by requesting a list of all the definition names using detailDefinitions() or the asynchronous definitionNames().
QList<QOrganizerItemDetail> QOrganizerItem::details ( const QString & definitionName, const QString & fieldName, const QString & value ) const
Returns a list of details of the given definitionName, with fields named fieldName and with value value. The definitionName string can be determined by the DefinitionName attribute of defined objects (e.g. QOrganizerItemPhoneNumber::DefinitionName) or by requesting a list of all the definition names using detailDefinitions() or the asynchronous definitionNames().
Returns a list of details of the given definitionName.
The definitionName argument is typically the detail name constant provided by a specific subclass of QOrganizerItemDetail.
It would usually be more convenient to use the template version of this function.
QList<QOrganizerItemDetail> QOrganizerItem::details ( const QLatin1Constant & definitionName, const QLatin1Constant & fieldName, const QString & value )
Returns a list of details of the given definitionName, with fields named fieldName and with value value.
QList<T> QOrganizerItem::details () const
Returns a list of details of the template parameter type. The type must be a subclass of QOrganizerItemDetail.
QList<T> QOrganizerItem::details ( const QString & fieldName, const QString & value ) const
Returns a list of details of the template parameter type which have field called fieldName, with matching value. The type must be a subclass of QOrganizerItemDetail.
QString QOrganizerItem::displayLabel () const
Returns the display label of the item
See also setDisplayLabel().
QString QOrganizerItem::guid () const
Returns the globally unique identifier which identifies this item, which is used for synchronization purposes.
See also setGuid().
Returns the QOrganizerItemId that identifies this organizeritem.
This may have been set when the organizeritem was retrieved from a particular manager, or when the organizeritem was first saved in a manager. The QOrganizerItemId is only valid with a specific manager. See QOrganizerItemManager::saveItem() for more information.
See also setId() and localId().
bool QOrganizerItem::isEmpty () const
Returns true if this QOrganizerItem is empty, false if not.
An empty QOrganizerItem has an empty label and no extra details. The type of the organizeritem is irrelevant.
Returns the QOrganizerItemLocalId that identifies this organizeritem within its manager
This may have been set when the organizeritem was retrieved from a particular manager, or when the organizeritem was first saved in a manager. The QOrganizerItemLocalId is associated with a specific manager, but other organizeritems with the same local id might exist in different managers.
See QOrganizerItemManager::saveItem() for more information.
See also id().
bool QOrganizerItem::removeDetail ( QOrganizerItemDetail * detail )
Removes the detail from the organizeritem.
The detail in the organizeritem which has the same key as that of the given detail will be removed if it exists. Only the key is used for comparison - that is, the information in the detail may be different.
If the detail's access constraint includes QOrganizerItemDetail::Irremovable, this function will return false.
Returns true if the detail was removed successfully, false if an error occurred.
Note that the caller retains ownership of the detail.
bool QOrganizerItem::saveDetail ( QOrganizerItemDetail * detail )
Saves the given detail in the list of stored details, and sets the detail's id. If another detail of the same type and id has been previously saved in this organizeritem, that detail is overwritten. Otherwise, a new id is generated and set in the detail, and the detail is added to the organizeritem.
If the detail's access constraint includes QOrganizerItemDetail::ReadOnly, this function will return true and save the detail in the organizeritem, however attempting to save the organizeritem in a manager may fail (if that manager decides that the read only detail should not be updated). Details with the QOrganizerItemDetail::ReadOnly constraint set are typically provided in a organizeritem by the manager, and are usually information that is either synthesized, or not intended to be changed by the user (e.g. presence information for other organizeritems).
If detail is a QOrganizerItemType, the existing organizeritem type will be overwritten with detail. There is never more than one organizeritem type in a organizeritem.
Returns true if the detail was saved successfully, otherwise returns false.
Note that the caller retains ownership of the detail.
void QOrganizerItem::setDescription ( const QString & description )
Sets the human-readable description of the item to description
See also description().
void QOrganizerItem::setDescription ( const QOrganizerItemDescription & description )
Sets the human-readable description of the item to description
void QOrganizerItem::setDisplayLabel ( const QString & label )
Sets the display label of the item to label
See also displayLabel().
void QOrganizerItem::setDisplayLabel ( const QOrganizerItemDisplayLabel & label )
Sets the display label of the item to label
void QOrganizerItem::setGuid ( const QString & guid )
Sets the item's globally unique identifier to guid
See also guid().
void QOrganizerItem::setId ( const QOrganizerItemId & id )
Sets the id of this organizeritem to id.
Note that this only affects this object, not any corresponding structures stored by a QOrganizerItemManager.
If you change the id of a organizeritem and save the organizeritem in a manager, the previously existing organizeritem will still exist. You can do this to create copies (possibly modified) of an existing organizeritem, or to save a organizeritem in a different manager.
See also id() and QOrganizerItemManager::saveItem().
void QOrganizerItem::setType ( const QString & type )
Sets the type of the organizeritem to the given type.
See also type().
void QOrganizerItem::setType ( const QOrganizerItemType & type )
Sets the type of the organizeritem to the given type detail.
QString QOrganizerItem::type () const
Returns the type of the organizeritem. Every organizeritem has exactly one type which is either set manually (by saving a modified copy of the QOrganizerItemType in the organizeritem, or by calling setType()) or synthesized automatically.
See also setType().
bool QOrganizerItem::operator!= ( const QOrganizerItem & other ) const
Returns true if this organizeritems id or details are different to those of the other organizeritem.
QOrganizerItem & QOrganizerItem::operator= ( const QOrganizerItem & other )
Replace the contents of this QOrganizerItem with other
bool QOrganizerItem::operator== ( const QOrganizerItem & other ) const
Returns true if this organizeritem is equal to the other organizeritem, false if either the id or stored details are not the same