Organizer QML APIQML Support for the Organizer API. OverviewTo be able to use this component the QML import statement needs to reference the module before it can used. Simply add the following to the QML file: import QtOrganizer 5.0 The Organizer API enables a client to request calendar, schedule and personal data from local or remote backends. The QML Organizer API delivers these capabilities in an easy to use form. The following describes the API. You can also study the Examples or try the Tutorials to help get started quickly. Organizer ItemsThe OrganizerItem element provides a generic interface for accessing events, todos, journals and notes. To actually access specific fields of an item, convenience sub elements of OrganizerItem are offered. These are Event, Todo, Journal and Note. Additionally, EventOccurrence and TodoOccurrence can be used for manipulating occurrences of events or todos. Recurring ItemsA recurring item is an item that occurs more than once; for example, a meeting that occurs every week for the next 10 weeks. A recurring item is created by creating an Event or Todo and setting a RecurrenceRule on it to specify the rules for when it should recur. See Recurrence and RecurrenceRule for detail references. CollectionsEvery item stored in an organizer store belongs to exactly one collection. A collection can have properties such as a name, a "color", a specified icon, a description, and so on. Collections may be added, modified, or removed if the backend store supports those operations. There will always be at least one (default) collection in an organizer manager, into which items are saved if no other collection is specified. Organizer Item DetailsSeveral sub elements of Detail are provided as part of the API. They are general in design but are intended to fulfill specific use-cases. Please note that certain backends may choose not to support one or more of these elements as they appear here. Organizer FiltersThe Organizer QML plugin supplies filters to search for organizer items with particular values for various properties in the organizer item, such as IDs, collections, and details, etc. Reference documentationMain Classes
Item Classes
Detail Leaf Classes
Item Selection And Sorting
ExamplesThe following sample applications show examples of API usage: TutorialsThe following tutorials are useful to work through the use of the Qt Quick Organizer API:: |