MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

Contents

QML OrganizerModel Element

The OrganizerModel element provides access to organizer items from the organizer store. More...

This element was introduced in Mobility 1.1.

Properties

Methods

Detailed Description

This element is part of the QtMobility.organizer 1.1 module.

OrganizerModel provides a model of organizer items from the organizer store. The contents of the model can be specified with filter, sortOrders and fetchHint properties. Whether the model is automatically updated when the store or organizer item changes, can be controlled with OrganizerModel::autoUpdate property.

There are two ways of accessing the organizer item data: via the model by using views and delegates, or alternatively via items list property. Of the two, the model access is preferred. Direct list access (i.e. non-model) is not guaranteed to be in order set by sortOrder.

At the moment the model roles provided by OrganizerModel are display and item. Through the item role can access any data provided by the OrganizerItem element.

Note: Both the startPeriod and endPeriod are set by default to the current time (when the OrganizerModel was created). In most cases, both (or at least one) of the startPeriod and endPeriod should be set; otherwise, the OrganizerModel will contain zero items because the startPeriod and endPeriod are the same value. For example, if only endPeriod is provided, the OrganizerModel will contain all items from now (the time of the OrganizerModel's creation) to the endPeriod time.

See also OrganizerItem and QOrganizerManager.

Property Documentation

autoUpdate : bool

This property indicates whether or not the organizer model should be updated automatically, default value is true.

This property group was introduced in Mobility 1.1.

See also OrganizerModel::update().


read-onlyavailableManagers : list<string>

This property holds the list of available manager names. This property is read only.

This property group was introduced in Mobility 1.1.


endPeriod : date

This property holds the end date and time period used by the organizer model to fetch organizer items. The default value is the datetime of OrganizerModel creation.

This property group was introduced in Mobility 1.1.


read-onlyerror : string

This property holds the latest error code returned by the organizer manager.

This property is read only.

This property group was introduced in Mobility 1.1.


read-onlyeventOccurrences : list<OrganizerItem>

This property holds a list of event occurrences in the organizer model.

This property group was introduced in Mobility 1.1.

See also EventOccurrence.


read-onlyevents : list<OrganizerItem>

This property holds a list of events in the organizer model.

This property group was introduced in Mobility 1.1.

See also Event.


fetchHint : FetchHint

This property holds the fetch hint instance used by the organizer model.

This property group was introduced in Mobility 1.1.

See also FetchHint.


filter : Filter

This property holds the filter instance used by the organizer model.

This property group was introduced in Mobility 1.1.

See also Filter.


read-onlyitemCount : int

This property holds the size of organizer items the OrganizerModel currently holds.

This property is read only.

This property group was introduced in Mobility 1.1.


read-onlyitems : list<OrganizerItem>

This property holds a list of organizer items in the organizer model.

This property group was introduced in Mobility 1.1.

See also OrganizerItem.


read-onlyjournals : list<OrganizerItem>

This property holds a list of journal items in the organizer model.

This property group was introduced in Mobility 1.1.

See also Journal.


manager : string

This property holds the manager name or manager uri of the organizer backend engine. The manager uri format: qtorganizer:<managerid>:<key>=<value>&<key>=<value>.

For example, memory organizer engine has an optional id parameter, if user want to share the same memory engine with multiple OrganizerModel instances, the manager property should declared like this:

 model : OrganizerModel {
    manager:"qtorganizer:memory:id=organizer1
 }

instead of just the manager name:

 model : OrganizerModel {
    manager:"memory"
 }

This property group was introduced in Mobility 1.1.

See also QOrganizerManager::fromUri().


read-onlymanagerName : string

This property holds the manager name of the organizer backend engine. This property is read only.

This property group was introduced in Mobility 1.1.

See also QOrganizerManager::fromUri().


read-onlynotes : list<OrganizerItem>

This property holds a list of note items in the organizer model.

This property group was introduced in Mobility 1.1.

See also Note.


read-onlyoccurrences : list<OrganizerItem>

This property holds a list of event or todo occurrence items in the organizer model. Note: This property is not currently supported yet.

This property group was introduced in Mobility 1.1.

See also Event, Todo, EventOccurrence, and TodoOccurrence.


read-onlysortOrders : list<SortOrder>

This property holds a list of sort orders used by the organizer model.

This property group was introduced in Mobility 1.1.

See also SortOrder.


startPeriod : date

This property holds the start date and time period used by the organizer model to fetch organizer items. The default value is the datetime of OrganizerModel creation.

This property group was introduced in Mobility 1.1.


read-onlytodoOccurrences : list<OrganizerItem>

This property holds a list of todo occurrences in the organizer model.

This property group was introduced in Mobility 1.1.

See also TodoOccurrence.


read-onlytodos : list<OrganizerItem>

This property holds a list of todos in the organizer model.

This property group was introduced in Mobility 1.1.

See also Todo.


Method Documentation

OrganizerModel::cancelUpdate ()

Cancel the running organizer model content update request.

This documentation was introduced in Mobility 1.1.

See also OrganizerModel::autoUpdate and OrganizerModel::update.


bool OrganizerModel::containsItems ( date start, date end )

Returns true if there is at least one OrganizerItem between the given date range. Both the start and end parameters are optional, if no end parameter, returns true if there are item(s) after start, if neither start nor end date time provided, returns true if items in the current model is not empty, otherwise return false.

This documentation was introduced in Mobility 1.1.

See also itemIds().


OrganizerModel::exportItems ( url url, list<string> profiles )

Export organizer items into a vcalendar file to the given url by optional profiles. At the moment only the local file url is supported in export method.

This documentation was introduced in Mobility 1.1.


OrganizerModel::fetchItems ( list<QString> itemIds )

Fetch a list of organizer items from the organizer store by given itemIds.

This documentation was introduced in Mobility 1.1.


OrganizerModel::importItems ( url url, list<string> profiles )

Import organizer items from a vcalendar by the given url and optional profiles.

This documentation was introduced in Mobility 1.1.


OrganizerItem OrganizerModel::item ( string itemId )

Returns the OrganizerItem object which item id is the given itemId.

This documentation was introduced in Mobility 1.1.


list<string> OrganizerModel::itemIds ( date start, date end )

Returns the list of organizer item ids between the given date range start and end, Both the start and end parameters are optional, if no end parameter, returns all item ids from start, if neither start nor end date time provided, returns all item ids in the current model.

This documentation was introduced in Mobility 1.1.

See also containsItems().


OrganizerModel::removeItem ( string itemId )

Removes the organizer item with the given itemId from the backend.

This documentation was introduced in Mobility 1.1.


OrganizerModel::removeItems ( list<string> itemId )

Removes the organizer items with the given ids from the backend.

This documentation was introduced in Mobility 1.1.


OrganizerModel::saveItem ( OrganizerItem item )

Saves the given item into the organizer backend.

This documentation was introduced in Mobility 1.1.


OrganizerModel::update ()

Manually update the organizer model content.

This documentation was introduced in Mobility 1.1.

See also OrganizerModel::autoUpdate.


© 2008-2011 Nokia Corporation and/or its subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation in Finland and/or other countries worldwide.

All other trademarks are property of their respective owners. Privacy Policy


Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.

Alternatively, this document may be used under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.