Sophie

Sophie

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

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" />
<!-- qdeclarativeorganizeritem.cpp -->
  <title>Qt Mobility 1.2: QML OrganizerItem Element</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><a href="http://qt.nokia.com/doc/4.7/qdeclarativeelements.html">QML Elements</a></li>
<li>QML OrganizerItem Element</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#methods">Methods</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QML OrganizerItem Element</h1>
<span class="subtitle"></span>
<!-- $$$OrganizerItem-brief -->
<p>The OrganizerItem element represents the in-memory version of a calendar organizer item, and has no tie to a specific backend calendar store. <a href="#details">More...</a></p>
<!-- @@@OrganizerItem -->
<p>This element was introduced in  Mobility 1.1.</p>
<ul>
<li><a href="qml-organizeritem-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-organizeritem.html#description-prop">description</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-organizeritem.html#details-prop">details</a></b></b> : list&lt;Detail&gt;</li>
<li class="fn"><b><b><a href="qml-organizeritem.html#displayLabel-prop">displayLabel</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-organizeritem.html#guid-prop">guid</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-organizeritem.html#isFloatingTime-prop">isFloatingTime</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-organizeritem.html#isOccurrence-prop">isOccurrence</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-organizeritem.html#itemEndTime-prop">itemEndTime</a></b></b> : date</li>
<li class="fn"><b><b><a href="qml-organizeritem.html#itemId-prop">itemId</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-organizeritem.html#itemStartTime-prop">itemStartTime</a></b></b> : date</li>
<li class="fn"><b><b><a href="qml-organizeritem.html#manager-prop">manager</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-organizeritem.html#modified-prop">modified</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-organizeritem.html#type-prop">type</a></b></b> : string</li>
</ul>
<a name="methods"></a>
<h2>Methods</h2>
<ul>
<li class="fn"><b><b><a href="qml-organizeritem.html#addComment-method">addComment</a></b></b></li>
<li class="fn"><b><b><a href="qml-organizeritem.html#addDetail-method">addDetail</a></b></b></li>
<li class="fn"><b><b><a href="qml-organizeritem.html#clearComments-method">clearComments</a></b></b></li>
<li class="fn"><b><b><a href="qml-organizeritem.html#clearDetails-method">clearDetails</a></b></b></li>
<li class="fn"><b><b><a href="qml-organizeritem.html#detail-method">detail</a></b></b></li>
<li class="fn"><b><b><a href="qml-organizeritem.html#details-method">details</a></b></b></li>
<li class="fn"><b><b><a href="qml-organizeritem.html#removeDetail-method">removeDetail</a></b></b></li>
<li class="fn"><b><b><a href="qml-organizeritem.html#save-method">save</a></b></b></li>
</ul>
<!-- $$$OrganizerItem-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p>A OrganizerItem has a number of mandatory details. Different subclasses of OrganizerItem (i.e&#x2e;, Event, <a href="qml-eventoccurrence.html">EventOccurrence</a>, Journal, Todo, <a href="qml-todooccurrence.html">TodoOccurrence</a>, Note) may have more mandatory details.</p>
<p>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.</p>
<p>The OrganizerItem element is part of the <b>QtMobility.organizer 1.1</b> module.</p>
<p><b>See also </b><a href="qml-event.html">Event</a>, <a href="qml-eventoccurrence.html">EventOccurrence</a>, <a href="qml-journal.html">Journal</a>, <a href="qml-todo.html">Todo</a>, <a href="qml-todooccurrence.html">TodoOccurrence</a>, <a href="qml-note.html">Note</a>, <a href="qorganizermanager.html">QOrganizerManager</a>, and <a href="qorganizeritem.html">QOrganizerItem</a>.</p>
<!-- @@@OrganizerItem -->
<h2>Property Documentation</h2>
<!-- $$$description -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="description-prop"></a><span class="name">description</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the description text of the organizer item.</p>
<p>This property group was introduced in  Mobility 1.1.</p>
</div></div><!-- @@@description -->
<br/>
<!-- $$$details -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="details-prop"></a><span class="qmlreadonly">read-only</span><span class="name">details</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-list.html">list</a></span>&lt;<span class="type"><a href="qml-detail.html">Detail</a></span>&gt;</p></td></tr></table></div><div class="qmldoc"><p>This property holds the list of <a href="qml-detail.html">Detail</a> elements that the organizer item has.</p>
<p>This property group was introduced in  Mobility 1.1.</p>
</div></div><!-- @@@details -->
<br/>
<!-- $$$displayLabel -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="displayLabel-prop"></a><span class="name">displayLabel</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the display label of the organizer item.</p>
<p>This property group was introduced in  Mobility 1.1.</p>
</div></div><!-- @@@displayLabel -->
<br/>
<!-- $$$guid -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="guid-prop"></a><span class="name">guid</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the GUID string of the organizer item.</p>
<p>This property group was introduced in  Mobility 1.1.</p>
</div></div><!-- @@@guid -->
<br/>
<!-- $$$isFloatingTime -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="isFloatingTime-prop"></a><span class="qmlreadonly">read-only</span><span class="name">isFloatingTime</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>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.</p>
<p>This property group was introduced in  Mobility 1.1.</p>
</div></div><!-- @@@isFloatingTime -->
<br/>
<!-- $$$isOccurrence -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="isOccurrence-prop"></a><span class="qmlreadonly">read-only</span><span class="name">isOccurrence</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>If this <a href="qml-organizeritem.html">OrganizerItem</a> is an occurrence item, returns true, otherwise returns false.</p>
<p>This is a read only property.</p>
<p>This property group was introduced in  Mobility 1.1.</p>
</div></div><!-- @@@isOccurrence -->
<br/>
<!-- $$$itemEndTime -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="itemEndTime-prop"></a><span class="qmlreadonly">read-only</span><span class="name">itemEndTime</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-date.html">date</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the end date time of the <a href="qml-organizeritem.html">OrganizerItem</a> object. For different organizer item type, the return value is different, too.</p>
<p>This property group was introduced in  Mobility 1.1.</p>
<p><b>See also </b><a href="qdeclarativeorganizeritem.html#OrganizerItemType-enum">QDeclarativeOrganizerItem::OrganizerItemType</a>.</p>
</div></div><!-- @@@itemEndTime -->
<br/>
<!-- $$$itemId -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="itemId-prop"></a><span class="qmlreadonly">read-only</span><span class="name">itemId</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the id of the <a href="qml-organizeritem.html">OrganizerItem</a> object. This property is read only.</p>
<p>This property group was introduced in  Mobility 1.1.</p>
</div></div><!-- @@@itemId -->
<br/>
<!-- $$$itemStartTime -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="itemStartTime-prop"></a><span class="qmlreadonly">read-only</span><span class="name">itemStartTime</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-date.html">date</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the start date time of the <a href="qml-organizeritem.html">OrganizerItem</a> object. For differrent organizer item type, the return value is differrent, too.</p>
<p>This property group was introduced in  Mobility 1.1.</p>
<p><b>See also </b><a href="qdeclarativeorganizeritem.html#OrganizerItemType-enum">QDeclarativeOrganizerItem::OrganizerItemType</a>.</p>
</div></div><!-- @@@itemStartTime -->
<br/>
<!-- $$$manager -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="manager-prop"></a><span class="qmlreadonly">read-only</span><span class="name">manager</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the manager uri which the <a href="qml-organizeritem.html">OrganizerItem</a> object comes from.</p>
<p>This property group was introduced in  Mobility 1.1.</p>
</div></div><!-- @@@manager -->
<br/>
<!-- $$$modified -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="modified-prop"></a><span class="qmlreadonly">read-only</span><span class="name">modified</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-bool.html">bool</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the dirty flag of the <a href="qml-organizeritem.html">OrganizerItem</a> object. If the <a href="qml-organizeritem.html">OrganizerItem</a> has been changed, returns true, otherwise returns false.</p>
<p>This property group was introduced in  Mobility 1.1.</p>
<p><b>See also </b><a href="qml-organizeritem.html#save-method">OrganizerItem::save</a>.</p>
</div></div><!-- @@@modified -->
<br/>
<!-- $$$type -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="type-prop"></a><span class="qmlreadonly">read-only</span><span class="name">type</span> : <span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-string.html">string</a></span></p></td></tr></table></div><div class="qmldoc"><p>This property holds the type name of the organizer item. This property is read only.</p>
<p>This property group was introduced in  Mobility 1.1.</p>
</div></div><!-- @@@type -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$addComment -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="addComment-method"></a>OrganizerItem::<span class="name">addComment</span> ( <span class="type">comment</span> )</p></td></tr></table></div><div class="qmldoc"><p>Addes a <i>comment</i> for the organizer item.</p>
<p>This documentation was introduced in  Mobility 1.1.</p>
<p><b>See also </b><a href="qml-organizeritem.html#clearComments-method">OrganizerItem::clearComments()</a>.</p>
</div></div><!-- @@@addComment -->
<br/>
<!-- $$$addDetail -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="addDetail-method"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-bool.html">bool</a></span> OrganizerItem::<span class="name">addDetail</span> ( <span class="type"><a href="qml-organizeritem.html#detail-method">detail</a></span> )</p></td></tr></table></div><div class="qmldoc"><p>Adds the given organizer item <i>detail</i> to the organizer item, returns true if successful, otherwise returns false.</p>
<p><b>Note:</b>: If the <i>detail</i> has been added into the same organizer item before, this operation will be ignored, so if you want to add a <i>detail</i> multiple times, the <i>detail</i> should be copied before calling this function.</p>
<p>This documentation was introduced in  Mobility 1.1.</p>
</div></div><!-- @@@addDetail -->
<br/>
<!-- $$$clearComments -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="clearComments-method"></a>OrganizerItem::<span class="name">clearComments</span> ()</p></td></tr></table></div><div class="qmldoc"><p>Removes all comments from the organizer item.</p>
<p>This documentation was introduced in  Mobility 1.1.</p>
<p><b>See also </b><a href="qml-organizeritem.html#addComment-method">OrganizerItem::addComment()</a>.</p>
</div></div><!-- @@@clearComments -->
<br/>
<!-- $$$clearDetails -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="clearDetails-method"></a>OrganizerItem::<span class="name">clearDetails</span> ()</p></td></tr></table></div><div class="qmldoc"><p>Removes all details from the organizer item.</p>
<p>This documentation was introduced in  Mobility 1.1.</p>
<p><b>See also </b><a href="qml-organizeritem.html#removeDetail-method">OrganizerItem::removeDetail()</a>.</p>
</div></div><!-- @@@clearDetails -->
<br/>
<!-- $$$detail -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="detail-method"></a><span class="type"><a href="qml-detail.html">Detail</a></span> OrganizerItem::<span class="name">detail</span> ( <span class="type">name</span> )</p></td></tr></table></div><div class="qmldoc"><p>This method returns an <a href="qml-detail.html">Detail</a> object which detail name is <i>name</i>.</p>
<p>This documentation was introduced in  Mobility 1.1.</p>
</div></div><!-- @@@detail -->
<br/>
<!-- $$$details -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="details-method"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-list.html">list</a></span>&lt;<span class="type"><a href="qml-detail.html">Detail</a></span>&gt; OrganizerItem::<span class="name">details</span> ( <span class="type">name</span> )</p></td></tr></table></div><div class="qmldoc"><p>This method returns a list of details which detail name is <i>name</i>.</p>
<p>This documentation was introduced in  Mobility 1.1.</p>
</div></div><!-- @@@details -->
<br/>
<!-- $$$removeDetail -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="removeDetail-method"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qml-bool.html">bool</a></span> OrganizerItem::<span class="name">removeDetail</span> ( <span class="type"><a href="qml-organizeritem.html#detail-method">detail</a></span> )</p></td></tr></table></div><div class="qmldoc"><p>Removes given <i>detail</i> from the organizer item. If the detail is not removable, returns false.</p>
<p>This documentation was introduced in  Mobility 1.1.</p>
<p><b>See also </b><a href="qml-detail.html#removable-prop">Detail::removable</a>.</p>
</div></div><!-- @@@removeDetail -->
<br/>
<!-- $$$save -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlFuncNode"><p><a name="save-method"></a>OrganizerItem::<span class="name">save</span> ()</p></td></tr></table></div><div class="qmldoc"><p>Saves this <a href="qml-organizeritem.html">OrganizerItem</a> if the item has been modified.</p>
<p>This documentation was introduced in  Mobility 1.1.</p>
<p><b>See also </b><a href="qml-organizeritem.html#modified-prop">OrganizerItem::modified</a>.</p>
</div></div><!-- @@@save -->
<br/>
  <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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional