Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 50facae208d4a6f280e44a513b104320 > files > 1380

qt-mobility-doc-1.2.0-13.mga5.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qml-organizer.qdoc -->
  <title>Qt Mobility 1.2: Organizer QML Plugin</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li>Organizer QML Plugin</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#overview">Overview</a></li>
<li class="level2"><a href="#organizer-items">Organizer Items</a></li>
<li class="level2"><a href="#recurring-items">Recurring Items</a></li>
<li class="level2"><a href="#collections">Collections</a></li>
<li class="level2"><a href="#organizer-item-details">Organizer Item Details</a></li>
<li class="level2"><a href="#organizer-filters">Organizer Filters</a></li>
<li class="level2"><a href="#times-in-organizer">Times in Organizer</a></li>
<li class="level2"><a href="#organizer-elements">Organizer Elements</a></li>
</ul>
</div>
<h1 class="title">Organizer QML Plugin</h1>
<span class="subtitle"></span>
<!-- $$$qml-organizer.html-description -->
<div class="descr"> <a name="details"></a>
<a name="overview"></a>
<h2>Overview</h2>
<p>The identifying string for this component is <i>&quot;QtMobility.organizer&quot;</i>. Use this in the QML <i>import</i> statement.</p>
<p>The Organizer API enables a client to request calendar, schedule and personal data from local or remote backends. The QML Organizer Plugin delivers these capabilities in an easy to use form.</p>
<a name="organizer-items"></a>
<h3>Organizer Items</h3>
<p>The <a href="qml-organizeritem.html">OrganizerItem</a> element provides a generic interface for accessing events, todos, journals and notes. To actually access specific fields of an item, convenience sub elements of <a href="qml-organizeritem.html">OrganizerItem</a> are offered. These are Event, Todo, Journal and Note. Additionally, <a href="qml-eventoccurrence.html">EventOccurrence</a> and <a href="qml-todooccurrence.html">TodoOccurrence</a> can be used for manipulating occurrences of event or todos.</p>
<a name="recurring-items"></a>
<h3>Recurring Items</h3>
<p>A 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 <a href="qml-recurrencerule.html">RecurrenceRule</a> on it to specify the rules for when it should recur. See <a href="qml-recurrence.html">Recurrence</a> and <a href="qml-recurrencerule.html">RecurrenceRule</a> for detail references.</p>
<a name="collections"></a>
<h3>Collections</h3>
<p>Every item stored in a organizer store belongs to exactly one collection. A collection can have properties such as a name, a &quot;color&quot;, a specified icon, a description, and so on. Collections may be added or removed if the backend store supports those operations, or modified. There will always be at least one collection in an organizer, and the organizer manager will always have a default collection into which items are saved if no other collection is specified.</p>
<a name="organizer-item-details"></a>
<h3>Organizer Item Details</h3>
<p>Several sub elements of ItemDetail are provided as part of the QtMobility Organizer 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; they may offer their own which provide similar functionality.</p>
<a name="organizer-filters"></a>
<h3>Organizer Filters</h3>
<p>The Organizer QML plugin supplies filters to search for organizer items with particular values for various properties in the organizer item details.</p>
<a name="times-in-organizer"></a>
<h3>Times in Organizer</h3>
<p>All time type properties in QML Organizer such as <a href="qml-organizeritem.html">OrganizerItem</a>.itemEndTime etc are returned in local time. But when assign new values to these properties, the time specs remain the same while saving these values into backend organizer engines.</p>
<a name="organizer-elements"></a>
<h3>Organizer Elements</h3>
<table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-audiblereminder.html">QML AudibleReminder Element</a></p></td><td class="tblDescr"><p>The AudibleReminder element contains information about an audible reminder of an item.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-changelogfilter.html">QML ChangeLogFilter Element</a></p></td><td class="tblDescr"><p>The ChangeLogFilter element provides a filter based around a organizer item timestamp criterion.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-collection.html">QML Collection Element</a></p></td><td class="tblDescr"><p>The Collection element represents a collection of items in an organizer manager.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-collectionfilter.html">QML CollectionFilter Element</a></p></td><td class="tblDescr"><p>The CollectionFilter element provides a filter based around a list of organizer item ids.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-comment.html">QML Comment Element</a></p></td><td class="tblDescr"><p>The Comment element contains the comment text of an organizer item.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-description.html">QML Description Element</a></p></td><td class="tblDescr"><p>The Description element contains the description text of an organizer item.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-detail.html">QML Detail Element</a></p></td><td class="tblDescr"><p>The Detail element represents a single, complete detail about a organizer item.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-detailfilter.html">QML DetailFilter Element</a></p></td><td class="tblDescr"><p>The DetailFilter element provides a filter based around a detail value criterion.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-detailrangefilter.html">QML DetailRangeFilter Element</a></p></td><td class="tblDescr"><p>The DetailRangeFilter element provides a filter based around a detail value range criterion.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-displaylabel.html">QML DisplayLabel Element</a></p></td><td class="tblDescr"><p>The DisplayLabel element contains the display label of an organizer item.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-emailreminder.html">QML EmailReminder Element</a></p></td><td class="tblDescr"><p>The EmailReminder element contains information about an email reminder of an item.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-event.html">QML Event Element</a></p></td><td class="tblDescr"><p>The Event element provides an event in time which may reoccur.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-eventoccurrence.html">QML EventOccurrence Element</a></p></td><td class="tblDescr"><p>The EventOccurrence element provides an occurrence of an event.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-eventtime.html">QML EventTime Element</a></p></td><td class="tblDescr"><p>The EventTime element contains the start and end dates and times of a recurring event series, or occurrence of an event.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-fetchhint.html">QML FetchHint Element</a></p></td><td class="tblDescr"><p>The FetchHint element provides hints to the manager about which organizer item information needs to be retrieved in an asynchronous fetch request or a synchronous function call.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-filter.html">QML Filter Element</a></p></td><td class="tblDescr"><p>The Filter element is used as a property of OrganizerModel, to allow selection of organizer items which have certain details or properties.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-guid.html">QML Guid Element</a></p></td><td class="tblDescr"><p>The Guid element contains the GUID string of an organizer item.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-idfilter.html">QML IdFilter Element</a></p></td><td class="tblDescr"><p>The IdFilter element provides a filter based around a list of organizer item ids.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-intersectionfilter.html">QML IntersectionFilter Element</a></p></td><td class="tblDescr"><p>The IntersectionFilter element provides a filter which intersects the results of other filters.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-invalidfilter.html">QML InvalidFilter Element</a></p></td><td class="tblDescr"><p>the InvalidFilter element provides a filter which will never match any organizer items.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-journal.html">QML Journal Element</a></p></td><td class="tblDescr"><p>The Journal element provides a journal which is associated with a particular point in time.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-journaltime.html">QML JournalTime Element</a></p></td><td class="tblDescr"><p>The JournalTime element contains the entry date and time of a journal item.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-location.html">QML Location Element</a></p></td><td class="tblDescr"><p>The Location element contains information about a location which is related to the organizer item in some manner.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-note.html">QML Note Element</a></p></td><td class="tblDescr"><p>The Note element provides a note which is not associated with any particular point in time.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-organizeritem.html">QML OrganizerItem Element</a></p></td><td class="tblDescr"><p>The OrganizerItem element represents the in-memory version of a calendar organizer item, and has no tie to a specific backend calendar store.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-organizermodel.html">QML OrganizerModel Element</a></p></td><td class="tblDescr"><p>The OrganizerModel element provides access to organizer items from the organizer store.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-parent.html">QML Parent Element</a></p></td><td class="tblDescr"><p>The Parent element contains information about the event or todo that generated this item.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-priority.html">QML Priority Element</a></p></td><td class="tblDescr"><p>The Priority element contains the priority of the organizer item, which may be used to resolve scheduling conflicts.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-recurrence.html">QML Recurrence Element</a></p></td><td class="tblDescr"><p>The Recurrence element contains a list of rules and dates on which the recurrent item occurs, and a list of rules and dates on which exceptions occur.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-recurrencerule.html">QML RecurrenceRule Element</a></p></td><td class="tblDescr"><p>The RecurrenceRule element represents a rule by which a organizer item repeats.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-reminder.html">QML Reminder Element</a></p></td><td class="tblDescr"><p>The Reminder element contains information about when and how the user wants to reminded of the item.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-sortorder.html">QML SortOrder Element</a></p></td><td class="tblDescr"><p>The SortOrder element defines how a list of organizer item should be ordered according to some criteria.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-tag.html">QML Tag Element</a></p></td><td class="tblDescr"><p>The Tag element contains the tag string of an organizer item.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-timestamp.html">QML Timestamp Element</a></p></td><td class="tblDescr"><p>The Timestamp element contains the created and last modified timestamp of an organizer item's creating date and time.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-todo.html">QML Todo Element</a></p></td><td class="tblDescr"><p>The Todo element provides a task which should be completed.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-todooccurrence.html">QML TodoOccurrence Element</a></p></td><td class="tblDescr"><p>The TodoOccurrence element provides an occurrence of an event.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-todoprogress.html">QML TodoProgress Element</a></p></td><td class="tblDescr"><p>The TodoProgress element contains information about the progress of a todo item.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-todotime.html">QML TodoTime Element</a></p></td><td class="tblDescr"><p>The TodoTime element contains the start and due dates and times of a recurring todo series, or occurrence of an todo item.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-type.html">QML Type Element</a></p></td><td class="tblDescr"><p>The Type element contains the type string of an organizer item.</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qml-unionfilter.html">QML UnionFilter Element</a></p></td><td class="tblDescr"><p>The UnionFilter element provides a filter which unions the results of other filters.</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qml-visualreminder.html">QML VisualReminder Element</a></p></td><td class="tblDescr"><p>The VisualReminder element contains information about a visual reminder of an item.</p></td></tr>
</table>
</div>
<p><b>See also </b><a href="qml-organizeritem.html#isFloatingTime-prop">OrganizerItem::isFloatingTime</a> and <a href="multimediabackend.html">.</a>.</p>
<!-- @@@qml-organizer.html -->
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
  <p>
     <acronym title="Copyright">&copy;</acronym> 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.</p>
  <p>
     All other trademarks are property of their respective owners. <a title="Privacy Policy"
     href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
  <br />
  <p>
    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.</p>
  <p>
    Alternatively, this document may be used under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU
    Free Documentation License version 1.3</a>
    as published by the Free Software Foundation.</p>
</div>
</body>
</html>