QtMobility Reference Documentation

Contents

QML OrganizerItem Element

The OrganizerItem element represents the in-memory version of a calendar organizer item, and has no tie to a specific backend calendar store. More...

  • List of all members, including inherited members
  • Properties

    Methods

    Detailed Description

    A OrganizerItem has a number of mandatory details. Different subclasses of OrganizerItem (i.e., Event, EventOccurrence, Journal, Todo, TodoOccurrence, Note) may have more mandatory details.

    If some of the organizer item details are non-unique, all of this type of detail values can be accessed by dynamic properties. For example, there are 3 comment details stored in an event item, they can be accessed by event.comments property, which holds a list of all comment details. If the dynamic property does not exist (for unique details), an undefined value is returned. The list of dynamic detail properties depends on the engine implementations.

    The OrganizerItem element is part of the QtMobility.organizer 1.1 module.

    See also Event, EventOccurrence, Journal, Todo, TodoOccurrence, Note, QOrganizerManager, and QOrganizerItem.

    Property Documentation

    description : string

    This property holds the description text of the organizer item.

    This documentation was introduced in Qt Mobility Mobility 1.1.


    read-onlydetails : list<Detail>

    This property holds the list of Detail elements that the organizer item has.

    This documentation was introduced in Qt Mobility Mobility 1.1.


    displayLabel : string

    This property holds the display label of the organizer item.

    This documentation was introduced in Qt Mobility Mobility 1.1.


    guid : string

    This property holds the GUID string of the organizer item.

    This documentation was introduced in Qt Mobility Mobility 1.1.


    read-onlyisFloatingTime : bool

    This property indicates whether the organizer item created with floating date time. A floating time will always appear with the same value regardless of what time zone the user is in. A non-floating (absolute) time represents the same time regardless of the time zone, but will appear to change in value if the user's time zone changes. This property is read only.

    This documentation was introduced in Qt Mobility Mobility 1.1.


    read-onlyisOccurrence : bool

    If this OrganizerItem is an occurrence item, returns true, otherwise returns false.

    This is a read only property.

    This documentation was introduced in Qt Mobility Mobility 1.1.


    read-onlyitemEndTime : date

    This property holds the end date time of the OrganizerItem object. For different organizer item type, the return value is different, too.

    This documentation was introduced in Qt Mobility Mobility 1.1.

    See also QDeclarativeOrganizerItem::OrganizerItemType.


    read-onlyitemId : string

    This property holds the id of the OrganizerItem object. This property is read only.

    This documentation was introduced in Qt Mobility Mobility 1.1.


    read-onlyitemStartTime : date

    This property holds the start date time of the OrganizerItem object. For differrent organizer item type, the return value is differrent, too.

    This documentation was introduced in Qt Mobility Mobility 1.1.

    See also QDeclarativeOrganizerItem::OrganizerItemType.


    read-onlymanager : string

    This property holds the manager uri which the OrganizerItem object comes from.

    This documentation was introduced in Qt Mobility Mobility 1.1.


    read-onlymodified : bool

    This property holds the dirty flag of the OrganizerItem object. If the OrganizerItem has been changed, returns true, otherwise returns false.

    This documentation was introduced in Qt Mobility Mobility 1.1.

    See also OrganizerItem::save.


    read-onlytype : string

    This property holds the type name of the organizer item. This property is read only.

    This documentation was introduced in Qt Mobility Mobility 1.1.


    Method Documentation

    OrganizerItem::addComment ( comment )

    Addes a comment for the organizer item.

    This documentation was introduced in Qt Mobility Mobility 1.1.

    See also OrganizerItem::clearComments().


    bool OrganizerItem::addDetail ( detail )

    Adds the given organizer item detail to the organizer item, returns true if successful, otherwise returns false.

    Note:: If the detail has been added into the same organizer item before, this operation will be ignored, so if you want to add a detail multiple times, the detail should be copied before calling this function.

    This documentation was introduced in Qt Mobility Mobility 1.1.


    OrganizerItem::clearComments ()

    Removes all comments from the organizer item.

    This documentation was introduced in Qt Mobility Mobility 1.1.

    See also OrganizerItem::addComment().


    OrganizerItem::clearDetails ()

    Removes all details from the organizer item.

    This documentation was introduced in Qt Mobility Mobility 1.1.

    See also OrganizerItem::removeDetail().


    Detail OrganizerItem::detail ( name )

    This method returns an Detail object which detail name is name.

    This documentation was introduced in Qt Mobility Mobility 1.1.


    list<Detail> OrganizerItem::details ( name )

    This method returns a list of details which detail name is name.

    This documentation was introduced in Qt Mobility Mobility 1.1.


    bool OrganizerItem::removeDetail ( detail )

    Removes given detail from the organizer item. If the detail is not removable, returns false.

    This documentation was introduced in Qt Mobility Mobility 1.1.

    See also Detail::removable.


    OrganizerItem::save ()

    Saves this OrganizerItem if the item has been modified.

    This documentation was introduced in Qt Mobility Mobility 1.1.

    See also OrganizerItem::modified.