The QOrganizerItem class represents an event, todo, note, or journal entry More...
#include <QOrganizerItem>
Inherited by QOrganizerEvent, QOrganizerEventOccurrence, QOrganizerJournal, QOrganizerNote, QOrganizerTodo, and QOrganizerTodoOccurrence.
QOrganizerItem () | |
QOrganizerItem ( const QOrganizerItem & other ) | |
~QOrganizerItem () | |
void | addComment ( const QString & comment ) |
void | clearComments () |
void | clearDetails () |
QOrganizerCollectionId | collectionId () const |
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 |
uint | qHash ( const QOrganizerItem & key ) |
Q_DECLARE_CUSTOM_ORGANIZER_ITEM |
The QOrganizerItem class represents an event, todo, note, or journal entry
A QOrganizerItem object has an id and 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 organizer item, 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:
Different subclasses of QOrganizerItem (i.e., QOrganizerEvent, QOrganizerTodo, QOrganizerJournal and QOrganizerNote) may have more mandatory details.
See also QOrganizerItemManager and QOrganizerItemDetail.
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.
Initializes this QOrganizerItem from other
Frees the memory used by this QOrganizerItem
Adds the comment comment to this item
Clears the comments (arbitrary notes) about this item
Removes all details of the organizer item. This function does not modify the id or type of the organizer item. Calling isEmpty() after calling this function will return true. The empty item becomes a QOrganizerNote.
Note: only returns meaningful id if it has been saved in a manager. An item always belongs to exactly one collection (default, if not set).
Returns the list of comments (or arbitrary notes about the item) which pertain to this item
Returns the human-readable description of the item
See also setDescription().
Returns the first detail stored in the organizer item with the given definitionName
Returns the first detail stored in the organizer item 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.
Returns the first detail of the template parameter type, as returned by the template details() function. The type must be a subclass of QOrganizerItemDetail.
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().
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.
Returns a list of details of the given definitionName, with fields named fieldName and with value value.
Returns a list of details of the template parameter type. The type must be a subclass of QOrganizerItemDetail.
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.
Returns the display label of the item
See also setDisplayLabel().
Returns the globally unique identifier which identifies this item, which is used for synchronization purposes.
See also setGuid().
Returns the QOrganizerItemId that identifies this organizer item.
This may have been set when the organizer item was retrieved from a particular manager, or when the organizer item 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().
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 organizer item is irrelevant.
Returns the QOrganizerItemLocalId that identifies this organizer item within its manager
This may have been set when the organizer item was retrieved from a particular manager, or when the organizer item was first saved in a manager. The QOrganizerItemLocalId is associated with a specific manager, but other organizer items with the same local id might exist in different managers.
See QOrganizerItemManager::saveItem() for more information.
See also id().
Removes the detail from the organizer item.
The detail in the organizer item 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.
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 organizer item, that detail is overwritten. Otherwise, a new id is generated and set in the detail, and the detail is added to the organizer item.
If the detail's access constraint includes QOrganizerItemDetail::ReadOnly, this function will return true and save the detail in the organizer item, however attempting to save the organizer item 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 organizer item 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 organizer items).
If detail is a QOrganizerItemType, the existing organizer item type will be overwritten with detail. There is never more than one organizer item type in a organizer item.
Returns true if the detail was saved successfully, otherwise returns false.
Note that the caller retains ownership of the detail.
Sets the human-readable description of the item to description
See also description().
Sets the human-readable description of the item to description
Sets the display label of the item to label
See also displayLabel().
Sets the display label of the item to label
Sets the item's globally unique identifier to guid
See also guid().
Sets the id of this organizer item to id.
Note that this only affects this object, not any corresponding structures stored by a QOrganizerItemManager.
If you change the id of a organizer item and save the organizer item in a manager, the previously existing organizer item will still exist. You can do this to create copies (possibly modified) of an existing organizer item, or to save a organizer item in a different manager.
See also id() and QOrganizerItemManager::saveItem().
Sets the type of the organizer item to the given type.
See also type().
Sets the type of the organizer item to the given type detail.
Returns the type of the organizer item. Every organizer item has exactly one type which is either set manually (by saving a modified copy of the QOrganizerItemType in the organizer item, or by calling setType()) or synthesized automatically.
See also setType().
Returns true if this organizer item's id or details are different to those of the other organizer item.
Replace the contents of this QOrganizerItem with other
Returns true if this organizer item is equal to the other organizer item, false if either the id or stored details are not the same
Returns the hash value for key.
Macro for simplifying declaring convenience leaf classes for QOrganizerItem.
The first argument is the name of the class, and the second argument is a Latin-1 string literal naming the item type.
If you are creating a convenience class for a type of QOrganizerItem, you should use this macro when declaring your class to ensure that it interoperates with other organizer item functionality.