<?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" />
<!-- qorganizeritem.cpp -->
<title>Qt Mobility 1.2: QOrganizerItem Class Reference</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="modules.html">Modules</a></li>
<li><a href="qtorganizer.html">QtOrganizer</a></li>
<li>QOrganizerItem</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#related-non-members">Related Non-Members</a></li>
<li class="level1"><a href="#macros">Macros</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QOrganizerItem Class Reference</h1>
<!-- $$$QOrganizerItem-brief -->
<p>The QOrganizerItem class represents an event, todo, note, or journal entry <a href="#details">More...</a></p>
<!-- @@@QOrganizerItem -->
<pre class="cpp"> <span class="preprocessor">#include <QOrganizerItem></span></pre><p><b>Inherited by: </b><a href="qorganizerevent.html">QOrganizerEvent</a>, <a href="qorganizereventoccurrence.html">QOrganizerEventOccurrence</a>, <a href="qorganizerjournal.html">QOrganizerJournal</a>, <a href="qorganizernote.html">QOrganizerNote</a>, <a href="qorganizertodo.html">QOrganizerTodo</a>, and <a href="qorganizertodooccurrence.html">QOrganizerTodoOccurrence</a>.</p>
<p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qorganizeritem-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#QOrganizerItem">QOrganizerItem</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#QOrganizerItem-2">QOrganizerItem</a></b> ( const QOrganizerItem & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#dtor.QOrganizerItem">~QOrganizerItem</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#addComment">addComment</a></b> ( const QString & <i>comment</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#addTag">addTag</a></b> ( const QString & <i>tag</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#clearComments">clearComments</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#clearDetails">clearDetails</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#clearTags">clearTags</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QOrganizerCollectionId </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#collectionId">collectionId</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#comments">comments</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#description">description</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QOrganizerItemDetail </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#detail">detail</a></b> ( const QString & <i>definitionName</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QOrganizerItemDetail </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#detail-3">detail</a></b> ( const QLatin1Constant & <i>definitionName</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> T </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#detail-4">detail</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QOrganizerItemDetail> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#details">details</a></b> ( const QString & <i>definitionName</i> = QString() ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QOrganizerItemDetail> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#details-2">details</a></b> ( const QString & <i>definitionName</i>, const QString & <i>fieldName</i>, const QString & <i>value</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QOrganizerItemDetail> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#details-5">details</a></b> ( const QLatin1Constant & <i>definitionName</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QOrganizerItemDetail> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#details-6">details</a></b> ( const QLatin1Constant & <i>definitionName</i>, const QLatin1Constant & <i>fieldName</i>, const QString & <i>value</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<T> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#details-7">details</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<T> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#details-8">details</a></b> ( const QString & <i>fieldName</i>, const QString & <i>value</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#displayLabel">displayLabel</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#guid">guid</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QOrganizerItemId </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#id">id</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#isEmpty">isEmpty</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#removeDetail">removeDetail</a></b> ( QOrganizerItemDetail * <i>detail</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#saveDetail">saveDetail</a></b> ( QOrganizerItemDetail * <i>detail</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#setCollectionId">setCollectionId</a></b> ( const QOrganizerCollectionId & <i>collectionId</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#setComments">setComments</a></b> ( const QStringList & <i>comments</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#setDescription">setDescription</a></b> ( const QString & <i>description</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#setDescription-2">setDescription</a></b> ( const QOrganizerItemDescription & <i>description</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#setDisplayLabel">setDisplayLabel</a></b> ( const QString & <i>label</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#setDisplayLabel-2">setDisplayLabel</a></b> ( const QOrganizerItemDisplayLabel & <i>label</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#setGuid">setGuid</a></b> ( const QString & <i>guid</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#setId">setId</a></b> ( const QOrganizerItemId & <i>id</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#setTags">setTags</a></b> ( const QStringList & <i>tags</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#setType">setType</a></b> ( const QString & <i>type</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#setType-2">setType</a></b> ( const QOrganizerItemType & <i>type</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#tags">tags</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#type">type</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#operator-not-eq">operator!=</a></b> ( const QOrganizerItem & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QOrganizerItem & </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#operator-eq">operator=</a></b> ( const QOrganizerItem & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#operator-eq-eq">operator==</a></b> ( const QOrganizerItem & <i>other</i> ) const</td></tr>
</table>
<a name="related-non-members"></a>
<h2>Related Non-Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> uint </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#qHash-35">qHash</a></b> ( const QOrganizerItem & <i>key</i> )</td></tr>
</table>
<a name="macros"></a>
<h2>Macros</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritem.html#Q_DECLARE_CUSTOM_ORGANIZER_ITEM">Q_DECLARE_CUSTOM_ORGANIZER_ITEM</a></b></td></tr>
</table>
<a name="details"></a>
<!-- $$$QOrganizerItem-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QOrganizerItem class represents an event, todo, note, or journal entry</p>
<p>A QOrganizerItem object has an id and a collection of details (like a start date and location), as well as a collection id which identifies which <a href="qorganizercollection.html">QOrganizerCollection</a> the item is part of in a manager. Each detail (which can have multiple fields) is stored in an appropriate subclass of <a href="qorganizeritemdetail.html">QOrganizerItemDetail</a>, and the QOrganizerItem allows retrieving these details in various ways.</p>
<p>Most clients will want to use the convenient subclasses of QOrganizerItem (i.e., <a href="qorganizerevent.html">QOrganizerEvent</a> (and QOrganizerEventOccurence), <a href="qorganizertodo.html">QOrganizerTodo</a> (and QOrganizerTodoOccurence), <a href="qorganizerjournal.html">QOrganizerJournal</a> and <a href="qorganizernote.html">QOrganizerNote</a>) instead of manipulating instances of QOrganizerItem directly.</p>
<p>A QOrganizerItem instance represents the in-memory version of a calendar organizer item. It is possible for the contents of a QOrganizerItem to change independently of the contents that are stored persistently in a <a href="qorganizermanager.html">QOrganizerManager</a>. A QOrganizerItem has an id associated with it when it is first retrieved from a <a href="qorganizermanager.html">QOrganizerManager</a>, or after it has been first saved, and this allows clients to track changes using the signals in <a href="qorganizermanager.html">QOrganizerManager</a>. When saved in a manager, every item is placed into a <a href="qorganizercollection.html">QOrganizerCollection</a> in that manager, according to the collection id set in the item prior to save (or the default collection if no collection id was set in the item).</p>
<p>Different QOrganizerManagers may require an item to have certain details saved in it before it can be stored in that manager. By default, every item must have a <a href="qorganizeritemtype.html">QOrganizerItemType</a> detail which identifies the type of the item. Different subclasses of QOrganizerItem (i.e., <a href="qorganizerevent.html">QOrganizerEvent</a> (and QOrganizerEventOccurence), <a href="qorganizertodo.html">QOrganizerTodo</a> (and QOrganizerTodoOccurence), <a href="qorganizerjournal.html">QOrganizerJournal</a> and <a href="qorganizernote.html">QOrganizerNote</a>) may have other mandatory details, depending on the manager.</p>
</div>
<p><b>See also </b><a href="qorganizermanager.html">QOrganizerManager</a> and <a href="qorganizeritemdetail.html">QOrganizerItemDetail</a>.</p>
<!-- @@@QOrganizerItem -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QOrganizerItem[overload1]$$$QOrganizerItem -->
<h3 class="fn"><a name="QOrganizerItem"></a>QOrganizerItem::<span class="name">QOrganizerItem</span> ()</h3>
<p>Construct an empty organizer item.</p>
<p>The organizer item will have an empty display label, an empty id, and an empty description and have type <a href="qorganizeritemtype.html#TypeNote-var">QOrganizerItemType::TypeNote</a>. The <a href="qorganizeritem.html#isEmpty">isEmpty</a>() function will return true.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@QOrganizerItem -->
<!-- $$$QOrganizerItem$$$QOrganizerItemconstQOrganizerItem& -->
<h3 class="fn"><a name="QOrganizerItem-2"></a>QOrganizerItem::<span class="name">QOrganizerItem</span> ( const <span class="type">QOrganizerItem</span> & <i>other</i> )</h3>
<p>Initializes this <a href="qorganizeritem.html">QOrganizerItem</a> from <i>other</i></p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@QOrganizerItem -->
<!-- $$$~QOrganizerItem[overload1]$$$~QOrganizerItem -->
<h3 class="fn"><a name="dtor.QOrganizerItem"></a>QOrganizerItem::<span class="name">~QOrganizerItem</span> ()</h3>
<p>Frees the memory used by this <a href="qorganizeritem.html">QOrganizerItem</a></p>
<!-- @@@~QOrganizerItem -->
<!-- $$$addComment[overload1]$$$addCommentconstQString& -->
<h3 class="fn"><a name="addComment"></a><span class="type">void</span> QOrganizerItem::<span class="name">addComment</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>comment</i> )</h3>
<p>* Adds the comment <i>comment</i> to this item * *</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritemcomment.html">QOrganizerItemComment</a>.</p>
<!-- @@@addComment -->
<!-- $$$addTag[overload1]$$$addTagconstQString& -->
<h3 class="fn"><a name="addTag"></a><span class="type">void</span> QOrganizerItem::<span class="name">addTag</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>tag</i> )</h3>
<p>* Adds the <i>tag</i> to this item. * *</p>
<p>This function was introduced in Qt Mobility 1.2.</p>
<p><b>See also </b><a href="qorganizeritemtag.html">QOrganizerItemTag</a>.</p>
<!-- @@@addTag -->
<!-- $$$clearComments[overload1]$$$clearComments -->
<h3 class="fn"><a name="clearComments"></a><span class="type">void</span> QOrganizerItem::<span class="name">clearComments</span> ()</h3>
<p>* Removes all comments (arbitrary notes) about this item * *</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritemcomment.html">QOrganizerItemComment</a>.</p>
<!-- @@@clearComments -->
<!-- $$$clearDetails[overload1]$$$clearDetails -->
<h3 class="fn"><a name="clearDetails"></a><span class="type">void</span> QOrganizerItem::<span class="name">clearDetails</span> ()</h3>
<p>* Removes all details of the organizer item. * This function does not modify the id or type of the organizer item. * Calling <a href="qorganizeritem.html#isEmpty">isEmpty</a>() after calling this function will return true. * The empty item becomes a <a href="qorganizernote.html">QOrganizerNote</a>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@clearDetails -->
<!-- $$$clearTags[overload1]$$$clearTags -->
<h3 class="fn"><a name="clearTags"></a><span class="type">void</span> QOrganizerItem::<span class="name">clearTags</span> ()</h3>
<p>* Removes all tags associated with the item. * *</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritemtag.html">QOrganizerItemTag</a>.</p>
<!-- @@@clearTags -->
<!-- $$$collectionId[overload1]$$$collectionId -->
<h3 class="fn"><a name="collectionId"></a><span class="type"><a href="qorganizercollectionid.html">QOrganizerCollectionId</a></span> QOrganizerItem::<span class="name">collectionId</span> () const</h3>
<p>Returns the id of the collection which this item is part of, in the manager in which the item has been saved, if the item has previously been saved in a manager. If the item has not previously been saved in a manager, this function will return the id of the collection into which the client wishes the item to be saved when <a href="qorganizermanager.html#saveItem">QOrganizerManager::saveItem</a>() is called, which is set by calling <a href="qorganizeritem.html#setId">setId</a>(); otherwise, returns a null id.</p>
<p>An item always belongs to exactly one collection in a particular manager after it has been saved in the manager. If the item has previously been saved in the manager, in a particular collection, and the client sets the collection id of the item to the id of a different collection within that manager and then resaves the item, the item will be moved from its original collection into the specified collection if the move operation is supported by the manager; otherwise, the <a href="qorganizermanager.html#saveItem">QOrganizerManager::saveItem</a>() operation will fail and calling <a href="qorganizermanager.html#error">QOrganizerManager::error</a>() will return <tt>QOrganizerManager::NotSupportedError</tt>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritem.html#setCollectionId">setCollectionId</a>().</p>
<!-- @@@collectionId -->
<!-- $$$comments[overload1]$$$comments -->
<h3 class="fn"><a name="comments"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstringlist.html">QStringList</a></span> QOrganizerItem::<span class="name">comments</span> () const</h3>
<p>* Returns the list of comments (or arbitrary notes about the item) * which pertain to this item. * *</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritem.html#setComments">setComments</a>() and <a href="qorganizeritemcomment.html">QOrganizerItemComment</a>.</p>
<!-- @@@comments -->
<!-- $$$description[overload1]$$$description -->
<h3 class="fn"><a name="description"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QOrganizerItem::<span class="name">description</span> () const</h3>
<p>* Returns the human-readable description of the item * *</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritem.html#setDescription">setDescription</a>() and <a href="qorganizeritemdescription.html">QOrganizerItemDescription</a>.</p>
<!-- @@@description -->
<!-- $$$detail[overload1]$$$detailconstQString& -->
<h3 class="fn"><a name="detail"></a><span class="type"><a href="qorganizeritemdetail.html">QOrganizerItemDetail</a></span> QOrganizerItem::<span class="name">detail</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>definitionName</i> ) const</h3>
<p>Returns the first detail stored in the organizer item with the given <i>definitionName</i></p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@detail -->
<!-- $$$detail$$$detailconstQLatin1Constant& -->
<h3 class="fn"><a name="detail-3"></a><span class="type"><a href="qorganizeritemdetail.html">QOrganizerItemDetail</a></span> QOrganizerItem::<span class="name">detail</span> ( const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> & <i>definitionName</i> ) const</h3>
<p>Returns the first detail stored in the organizer item which with the given <i>definitionName</i>. The <i>definitionName</i> argument is typically the detail name constant provided by a specific subclass of <a href="qorganizeritemdetail.html">QOrganizerItemDetail</a>.</p>
<p>It would usually be more convenient to use the template version of this function.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@detail -->
<!-- $$$detail$$$detail -->
<h3 class="fn"><a name="detail-4"></a><span class="type">T</span> QOrganizerItem::<span class="name">detail</span> () const</h3>
<p>* * Returns the first detail of the template parameter type, as returned by the template <a href="qorganizeritem.html#details">details</a>() function. * The type must be a subclass of <a href="qorganizeritemdetail.html">QOrganizerItemDetail</a>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@detail -->
<!-- $$$details[overload1]$$$detailsconstQString& -->
<h3 class="fn"><a name="details"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span><<span class="type"><a href="qorganizeritemdetail.html">QOrganizerItemDetail</a></span>> QOrganizerItem::<span class="name">details</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>definitionName</i> = QString() ) const</h3>
<p>Returns a list of details with the given <i>definitionName</i> The definitionName string can be determined by the DefinitionName attribute of defined objects (e.g. QOrganizerItemPhoneNumber::DefinitionName) or by requesting a list of all the definition names using <a href="qorganizermanager.html#detailDefinitions">detailDefinitions()</a> or the asynchronous <a href="qorganizeritemdetaildefinitionfetchrequest.html#definitionNames">definitionNames()</a>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@details -->
<!-- $$$details$$$detailsconstQString&constQString&constQString& -->
<h3 class="fn"><a name="details-2"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span><<span class="type"><a href="qorganizeritemdetail.html">QOrganizerItemDetail</a></span>> QOrganizerItem::<span class="name">details</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>definitionName</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>fieldName</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>value</i> ) const</h3>
<p>Returns a list of details of the given <i>definitionName</i>, with fields named <i>fieldName</i> and with value <i>value</i>. The definitionName string can be determined by the DefinitionName attribute of defined objects (e.g. QOrganizerItemPhoneNumber::DefinitionName) or by requesting a list of all the definition names using <a href="qorganizermanager.html#detailDefinitions">detailDefinitions()</a> or the asynchronous <a href="qorganizeritemdetaildefinitionfetchrequest.html#definitionNames">definitionNames()</a>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@details -->
<!-- $$$details$$$detailsconstQLatin1Constant& -->
<h3 class="fn"><a name="details-5"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span><<span class="type"><a href="qorganizeritemdetail.html">QOrganizerItemDetail</a></span>> QOrganizerItem::<span class="name">details</span> ( const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> & <i>definitionName</i> ) const</h3>
<p>Returns a list of details of the given <i>definitionName</i>.</p>
<p>The <i>definitionName</i> argument is typically the detail name constant provided by a specific subclass of <a href="qorganizeritemdetail.html">QOrganizerItemDetail</a>.</p>
<p>It would usually be more convenient to use the template version of this function.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@details -->
<!-- $$$details$$$detailsconstQLatin1Constant&constQLatin1Constant&constQString& -->
<h3 class="fn"><a name="details-6"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span><<span class="type"><a href="qorganizeritemdetail.html">QOrganizerItemDetail</a></span>> QOrganizerItem::<span class="name">details</span> ( const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> & <i>definitionName</i>, const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> & <i>fieldName</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>value</i> )</h3>
<p>Returns a list of details of the given <i>definitionName</i>, with fields named <i>fieldName</i> and with value <i>value</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@details -->
<!-- $$$details$$$details -->
<h3 class="fn"><a name="details-7"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span><<span class="type">T</span>> QOrganizerItem::<span class="name">details</span> () const</h3>
<p>* * Returns a list of details of the template parameter type. The type must be * a subclass of <a href="qorganizeritemdetail.html">QOrganizerItemDetail</a>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@details -->
<!-- $$$details$$$detailsconstQString&constQString& -->
<h3 class="fn"><a name="details-8"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span><<span class="type">T</span>> QOrganizerItem::<span class="name">details</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>fieldName</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>value</i> ) const</h3>
<p>* * Returns a list of details of the template parameter type which have field called <i>fieldName</i>, with matching <i>value</i>. * The type must be a subclass of <a href="qorganizeritemdetail.html">QOrganizerItemDetail</a>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@details -->
<!-- $$$displayLabel[overload1]$$$displayLabel -->
<h3 class="fn"><a name="displayLabel"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QOrganizerItem::<span class="name">displayLabel</span> () const</h3>
<p>* Returns the display label of the item</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritem.html#setDisplayLabel">setDisplayLabel</a>().</p>
<!-- @@@displayLabel -->
<!-- $$$guid[overload1]$$$guid -->
<h3 class="fn"><a name="guid"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QOrganizerItem::<span class="name">guid</span> () const</h3>
<p>* Returns the globally unique identifier which identifies this item, * which is used for synchronization purposes.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritem.html#setGuid">setGuid</a>().</p>
<!-- @@@guid -->
<!-- $$$id[overload1]$$$id -->
<h3 class="fn"><a name="id"></a><span class="type"><a href="qorganizeritemid.html">QOrganizerItemId</a></span> QOrganizerItem::<span class="name">id</span> () const</h3>
<p>Returns the <a href="qorganizeritemid.html">QOrganizerItemId</a> that identifies this organizer item.</p>
<p>This may have been set when the organizer item was retrieved from a particular manager, or when the organizer item was first saved in a manager. The <a href="qorganizeritemid.html">QOrganizerItemId</a> is only valid within a specific manager. See <a href="qorganizermanager.html#saveItem">QOrganizerManager::saveItem</a>() for more information.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritem.html#setId">setId</a>().</p>
<!-- @@@id -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn"><a name="isEmpty"></a><span class="type">bool</span> QOrganizerItem::<span class="name">isEmpty</span> () const</h3>
<p>* Returns true if this <a href="qorganizeritem.html">QOrganizerItem</a> is empty, false if not. * * An empty <a href="qorganizeritem.html">QOrganizerItem</a> has an empty label and no extra details. * The type of the organizer item is irrelevant.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@isEmpty -->
<!-- $$$removeDetail[overload1]$$$removeDetailQOrganizerItemDetail* -->
<h3 class="fn"><a name="removeDetail"></a><span class="type">bool</span> QOrganizerItem::<span class="name">removeDetail</span> ( <span class="type"><a href="qorganizeritemdetail.html">QOrganizerItemDetail</a></span> * <i>detail</i> )</h3>
<p>* Removes the <i>detail</i> from the organizer item. * * The detail in the organizer item which has the same key as that of the given <i>detail</i> * will be removed if it exists. Only the key is used for comparison - that is, the * information in the detail may be different. * * If the detail's access constraint includes <tt>QOrganizerItemDetail::Irremovable</tt>, * this function will return false. * * Returns true if the detail was removed successfully, false if an error occurred. * * Note that the caller retains ownership of the detail.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@removeDetail -->
<!-- $$$saveDetail[overload1]$$$saveDetailQOrganizerItemDetail* -->
<h3 class="fn"><a name="saveDetail"></a><span class="type">bool</span> QOrganizerItem::<span class="name">saveDetail</span> ( <span class="type"><a href="qorganizeritemdetail.html">QOrganizerItemDetail</a></span> * <i>detail</i> )</h3>
<p>* Saves the given <i>detail</i> in the list of stored details, and sets the detail's id. * If another detail of the same type and id has been previously saved in * this organizer item, that detail is overwritten. Otherwise, a new id is generated * and set in the detail, and the detail is added to the organizer item. * * If the detail's access constraint includes <tt>QOrganizerItemDetail::ReadOnly</tt>, * this function will return true and save the detail in the organizer item, * however attempting to save the organizer item in a manager may fail (if that manager * decides that the read only detail should not be updated). * Details with the <tt>QOrganizerItemDetail::ReadOnly</tt> constraint set are typically provided * in a organizer item by the manager, and are usually information that is either * synthesized, or not intended to be changed by the user (e.g. presence information * for other organizer items). * * If <i>detail</i> is a <a href="qorganizeritemtype.html">QOrganizerItemType</a>, the existing organizer item type will * be overwritten with <i>detail</i>. There is never more than one organizer item type * in a organizer item. * * Returns true if the detail was saved successfully, otherwise returns false. * * Note that the caller retains ownership of the detail.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@saveDetail -->
<!-- $$$setCollectionId[overload1]$$$setCollectionIdconstQOrganizerCollectionId& -->
<h3 class="fn"><a name="setCollectionId"></a><span class="type">void</span> QOrganizerItem::<span class="name">setCollectionId</span> ( const <span class="type"><a href="qorganizercollectionid.html">QOrganizerCollectionId</a></span> & <i>collectionId</i> )</h3>
<p>Sets the id of the collection into which the client wishes the item to be saved to the given <i>collectionId</i>.</p>
<p>If the given <i>collectionId</i> is the null collection id, the client is specifying that the item should be saved into the collection in which the item is already saved (if the item has previously been saved in the manager, without having been removed since), or into the default collection of the manager (if the item has not previously been saved in the manager, or has been removed since the last time it was saved).</p>
<p>If the item has previously been saved in a particular manager, and the given <i>collectionId</i> is the id of a different collection than the one which the item is currently a part of in that manager, saving the item with <a href="qorganizermanager.html#saveItem">QOrganizerManager::saveItem</a>() will move the item from its original collection to the collection whose id is <i>collectionId</i>, if <i>collectionId</i> identifies a valid collection and the operation is supported by the manager.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritem.html#collectionId">collectionId</a>().</p>
<!-- @@@setCollectionId -->
<!-- $$$setComments[overload1]$$$setCommentsconstQStringList& -->
<h3 class="fn"><a name="setComments"></a><span class="type">void</span> QOrganizerItem::<span class="name">setComments</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstringlist.html">QStringList</a></span> & <i>comments</i> )</h3>
<p>* Sets the list of comments associated with the item to <i>comments</i>. * *</p>
<p>This function was introduced in Qt Mobility 1.2.</p>
<p><b>See also </b><a href="qorganizeritem.html#comments">comments</a>() and <a href="qorganizeritemtag.html">QOrganizerItemTag</a>.</p>
<!-- @@@setComments -->
<!-- $$$setDescription[overload1]$$$setDescriptionconstQString& -->
<h3 class="fn"><a name="setDescription"></a><span class="type">void</span> QOrganizerItem::<span class="name">setDescription</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>description</i> )</h3>
<p>* Sets the human-readable description of the item to <i>description</i> * *</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritem.html#description">description</a>() and <a href="qorganizeritemdescription.html">QOrganizerItemDescription</a>.</p>
<!-- @@@setDescription -->
<!-- $$$setDescription$$$setDescriptionconstQOrganizerItemDescription& -->
<h3 class="fn"><a name="setDescription-2"></a><span class="type">void</span> QOrganizerItem::<span class="name">setDescription</span> ( const <span class="type"><a href="qorganizeritemdescription.html">QOrganizerItemDescription</a></span> & <i>description</i> )</h3>
<p>* Sets the human-readable description of the item to <i>description</i></p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@setDescription -->
<!-- $$$setDisplayLabel[overload1]$$$setDisplayLabelconstQString& -->
<h3 class="fn"><a name="setDisplayLabel"></a><span class="type">void</span> QOrganizerItem::<span class="name">setDisplayLabel</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>label</i> )</h3>
<p>* Sets the display label of the item to <i>label</i> * *</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritem.html#displayLabel">displayLabel</a>() and <a href="qorganizeritemdisplaylabel.html">QOrganizerItemDisplayLabel</a>.</p>
<!-- @@@setDisplayLabel -->
<!-- $$$setDisplayLabel$$$setDisplayLabelconstQOrganizerItemDisplayLabel& -->
<h3 class="fn"><a name="setDisplayLabel-2"></a><span class="type">void</span> QOrganizerItem::<span class="name">setDisplayLabel</span> ( const <span class="type"><a href="qorganizeritemdisplaylabel.html">QOrganizerItemDisplayLabel</a></span> & <i>label</i> )</h3>
<p>* Sets the display label of the item to <i>label</i></p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@setDisplayLabel -->
<!-- $$$setGuid[overload1]$$$setGuidconstQString& -->
<h3 class="fn"><a name="setGuid"></a><span class="type">void</span> QOrganizerItem::<span class="name">setGuid</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>guid</i> )</h3>
<p>* Sets the item's globally unique identifier to <i>guid</i></p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritem.html#guid">guid</a>().</p>
<!-- @@@setGuid -->
<!-- $$$setId[overload1]$$$setIdconstQOrganizerItemId& -->
<h3 class="fn"><a name="setId"></a><span class="type">void</span> QOrganizerItem::<span class="name">setId</span> ( const <span class="type"><a href="qorganizeritemid.html">QOrganizerItemId</a></span> & <i>id</i> )</h3>
<p>* Sets the id of this organizer item to <i>id</i>. * * Note that this only affects this object, not any corresponding structures stored * by a <a href="qorganizermanager.html">QOrganizerManager</a>. * * If you change the id of a organizer item and save the organizer item * in a manager, the previously existing organizer item will still * exist. You can do this to create copies (possibly modified) * of an existing organizer item, or to save a organizer item in a different manager. * *</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritem.html#id">id</a>() and <a href="qorganizermanager.html#saveItem">QOrganizerManager::saveItem</a>().</p>
<!-- @@@setId -->
<!-- $$$setTags[overload1]$$$setTagsconstQStringList& -->
<h3 class="fn"><a name="setTags"></a><span class="type">void</span> QOrganizerItem::<span class="name">setTags</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstringlist.html">QStringList</a></span> & <i>tags</i> )</h3>
<p>* Sets the list of tags associated with the item to <i>tags</i>. * *</p>
<p>This function was introduced in Qt Mobility 1.2.</p>
<p><b>See also </b><a href="qorganizeritem.html#tags">tags</a>() and <a href="qorganizeritemtag.html">QOrganizerItemTag</a>.</p>
<!-- @@@setTags -->
<!-- $$$setType[overload1]$$$setTypeconstQString& -->
<h3 class="fn"><a name="setType"></a><span class="type">void</span> QOrganizerItem::<span class="name">setType</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>type</i> )</h3>
<p>* Sets the type of the organizer item to the given <i>type</i>. * *</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritem.html#type">type</a>() and <a href="qorganizeritemtype.html">QOrganizerItemType</a>.</p>
<!-- @@@setType -->
<!-- $$$setType$$$setTypeconstQOrganizerItemType& -->
<h3 class="fn"><a name="setType-2"></a><span class="type">void</span> QOrganizerItem::<span class="name">setType</span> ( const <span class="type"><a href="qorganizeritemtype.html">QOrganizerItemType</a></span> & <i>type</i> )</h3>
<p>* Sets the type of the organizer item to the given <i>type</i> detail.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@setType -->
<!-- $$$tags[overload1]$$$tags -->
<h3 class="fn"><a name="tags"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstringlist.html">QStringList</a></span> QOrganizerItem::<span class="name">tags</span> () const</h3>
<p>* Returns the list of tags for this item. Tags are used for non-exclusive categorization. * *</p>
<p>This function was introduced in Qt Mobility 1.2.</p>
<p><b>See also </b><a href="qorganizeritem.html#setTags">setTags</a>() and <a href="qorganizeritemtag.html">QOrganizerItemTag</a>.</p>
<!-- @@@tags -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn"><a name="type"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QOrganizerItem::<span class="name">type</span> () const</h3>
<p>* Returns the type of the organizer item. Every organizer item has exactly one type which * is either set manually (by saving a modified copy of the <a href="qorganizeritemtype.html">QOrganizerItemType</a> * in the organizer item, or by calling <a href="qorganizeritem.html#setType">setType</a>()) or synthesized automatically. * *</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritem.html#setType">setType</a>() and <a href="qorganizeritemtype.html">QOrganizerItemType</a>.</p>
<!-- @@@type -->
<!-- $$$operator!=[overload1]$$$operator!=constQOrganizerItem& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QOrganizerItem::<span class="name">operator!=</span> ( const <span class="type">QOrganizerItem</span> & <i>other</i> ) const</h3>
<p>* * Returns true if this organizer item's id or details are different to those of the <i>other</i> organizer item.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQOrganizerItem& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QOrganizerItem</span> & QOrganizerItem::<span class="name">operator=</span> ( const <span class="type">QOrganizerItem</span> & <i>other</i> )</h3>
<p>Replace the contents of this <a href="qorganizeritem.html">QOrganizerItem</a> with <i>other</i></p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQOrganizerItem& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QOrganizerItem::<span class="name">operator==</span> ( const <span class="type">QOrganizerItem</span> & <i>other</i> ) const</h3>
<p>Returns true if this organizer item is equal to the <i>other</i> organizer item, false if either the id, collection id or stored details are not the same</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@operator== -->
</div>
<div class="relnonmem">
<h2>Related Non-Members</h2>
<!-- $$$qHash$$$qHashconstQOrganizerItem& -->
<h3 class="fn"><a name="qHash-35"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qtglobal.html#uint-typedef">uint</a></span> <span class="name">qHash</span> ( const <span class="type">QOrganizerItem</span> & <i>key</i> )</h3>
<p>Returns the hash value for <i>key</i>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@qHash -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$Q_DECLARE_CUSTOM_ORGANIZER_ITEM[overload1]$$$Q_DECLARE_CUSTOM_ORGANIZER_ITEM -->
<h3 class="fn"><a name="Q_DECLARE_CUSTOM_ORGANIZER_ITEM"></a><span class="name">Q_DECLARE_CUSTOM_ORGANIZER_ITEM</span></h3>
<p>Macro for simplifying declaring convenience leaf classes for <a href="qorganizeritem.html">QOrganizerItem</a>.</p>
<p>The first argument is the name of the class, and the second argument is a Latin-1 string literal naming the item type.</p>
<p>If you are creating a convenience class for a type of <a href="qorganizeritem.html">QOrganizerItem</a>, you should use this macro when declaring your class to ensure that it interoperates with other organizer item functionality.</p>
<!-- @@@Q_DECLARE_CUSTOM_ORGANIZER_ITEM -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</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>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
50facae208d4a6f280e44a513b104320
>
files
>
1536
