<?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" />
<!-- qorganizeritemdetail.cpp -->
<title>Qt Mobility 1.2: QOrganizerItemDetail 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>QOrganizerItemDetail</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-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</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">QOrganizerItemDetail Class Reference</h1>
<!-- $$$QOrganizerItemDetail-brief -->
<p>The QOrganizerItemDetail class represents a single, complete detail about an organizer item. <a href="#details">More...</a></p>
<!-- @@@QOrganizerItemDetail -->
<pre class="cpp"> <span class="preprocessor">#include <QOrganizerItemDetail></span></pre><p><b>Inherited by: </b><a href="qorganizereventtime.html">QOrganizerEventTime</a>, <a href="qorganizeritemcomment.html">QOrganizerItemComment</a>, <a href="qorganizeritemdescription.html">QOrganizerItemDescription</a>, <a href="qorganizeritemdisplaylabel.html">QOrganizerItemDisplayLabel</a>, <a href="qorganizeritemguid.html">QOrganizerItemGuid</a>, <a href="qorganizeritemlocation.html">QOrganizerItemLocation</a>, <a href="qorganizeritemparent.html">QOrganizerItemParent</a>, <a href="qorganizeritempriority.html">QOrganizerItemPriority</a>, <a href="qorganizeritemrecurrence.html">QOrganizerItemRecurrence</a>, <a href="qorganizeritemreminder.html">QOrganizerItemReminder</a>, <a href="qorganizeritemtag.html">QOrganizerItemTag</a>, <a href="qorganizeritemtimestamp.html">QOrganizerItemTimestamp</a>, <a href="qorganizeritemtype.html">QOrganizerItemType</a>, <a href="qorganizerjournaltime.html">QOrganizerJournalTime</a>, <a href="qorganizertodoprogress.html">QOrganizerTodoProgress</a>, and <a href="qorganizertodotime.html">QOrganizerTodoTime</a>.</p>
<p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qorganizeritemdetail-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#AccessConstraint-enum">AccessConstraint</a></b> { NoConstraint, ReadOnly, Irremovable }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#AccessConstraint-enum">AccessConstraints</a></b></td></tr>
</table>
<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="qorganizeritemdetail.html#QOrganizerItemDetail">QOrganizerItemDetail</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#QOrganizerItemDetail-2">QOrganizerItemDetail</a></b> ( const char * <i>thisDefinitionId</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#QOrganizerItemDetail-3">QOrganizerItemDetail</a></b> ( const QString & <i>thisDefinitionId</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#QOrganizerItemDetail-4">QOrganizerItemDetail</a></b> ( const QOrganizerItemDetail & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#dtor.QOrganizerItemDetail">~QOrganizerItemDetail</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> AccessConstraints </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#accessConstraints">accessConstraints</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#definitionName">definitionName</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#hasValue">hasValue</a></b> ( const QString & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#hasValue-3">hasValue</a></b> ( const QLatin1Constant & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#isEmpty">isEmpty</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#key">key</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#removeValue">removeValue</a></b> ( const QString & <i>key</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#removeValue-3">removeValue</a></b> ( const QLatin1Constant & <i>key</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#resetKey">resetKey</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#setValue">setValue</a></b> ( const QString & <i>key</i>, const QVariant & <i>value</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#setValue-3">setValue</a></b> ( const QLatin1Constant & <i>key</i>, const QVariant & <i>value</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> T </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#value">value</a></b> ( const QString & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> T </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#value-2">value</a></b> ( const QLatin1Constant & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#value-3">value</a></b> ( const QString & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#value-6">value</a></b> ( const QLatin1Constant & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#variantValue">variantValue</a></b> ( const QString & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#variantValue-3">variantValue</a></b> ( const QLatin1Constant & <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariantMap </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#variantValues">variantValues</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#operator-not-eq">operator!=</a></b> ( const QOrganizerItemDetail & <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QOrganizerItemDetail & </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#operator-eq">operator=</a></b> ( const QOrganizerItemDetail & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizeritemdetail.html#operator-eq-eq">operator==</a></b> ( const QOrganizerItemDetail & <i>other</i> ) const</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="qorganizeritemdetail.html#Q_DECLARE_CUSTOM_ORGANIZER_DETAIL">Q_DECLARE_CUSTOM_ORGANIZER_DETAIL</a></b></td></tr>
</table>
<a name="details"></a>
<!-- $$$QOrganizerItemDetail-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QOrganizerItemDetail class represents a single, complete detail about an organizer item.</p>
<p>All of the information for an organizer item is stored in one or more QOrganizerItemDetail objects.</p>
<p>A detail is a group of logically related bits of data - for example, a <a href="qorganizeritemtimestamp.html">QOrganizerItemTimestamp</a> is a single detail that has multiple fields (timestamp of creation, timestamp of last update, etc). Every QOrganizerItemDetail has the name of an associated <a href="qorganizeritemdetaildefinition.html">QOrganizerItemDetailDefinition</a> that describes the fields, their data type, and any restrictions on their values. Different organizer item managers might have different detail definitions for the same name, depending on their capabilities. For example, some managers might not support the last update timestamp field of the QOrganizerTimestamp detail, while a different manager may add an extra field for storing specific extra information not present in the default schema (e.g., a last accessed timestamp).</p>
<p>Both the names of all the fields, and the name of the associated <a href="qorganizeritemdetaildefinition.html">QOrganizerItemDetailDefinition</a> are stored as 8-bit strings encoded in Latin 1 for memory conservation. Note, however, that the values stored in each field are not constrained in this way, and full unicode QStrings or <a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a> data can be stored.</p>
<p>When a QOrganizerItemDetail has been retrieved in a <a href="qorganizeritem.html">QOrganizerItem</a> from a <a href="qorganizermanager.html">QOrganizerManager</a>, it may have certain access constraints provided with it, like <a href="qorganizeritemdetail.html#AccessConstraint-enum">ReadOnly</a> or <a href="qorganizeritemdetail.html#AccessConstraint-enum">Irremovable</a>. This might mean that the supplied detail is calculated or otherwise not modifiable by the user. Also, some details may be marked <a href="qorganizeritemdetail.html#AccessConstraint-enum">Irremovable</a>. These are typically things that an organizer item has to have - like a <a href="qorganizeritemtype.html">QOrganizerItemType</a>.</p>
<p>It is possible to inherit from QOrganizerItemDetail to provide convenience or standardized access to values. For example, <a href="qorganizereventtime.html">QOrganizerEventTime</a> provides a convenient API for manipulating a QOrganizerItemDetail to describe the start and end time of an event, according to the schema.</p>
<p>In general, QOrganizerItemDetail and the built in subclasses (like <a href="qorganizereventtime.html">QOrganizerEventTime</a>) provide constants for the names of fields (like <a href="qorganizereventtime.html#FieldStartDateTime-var">QOrganizerEventTime::FieldStartDateTime</a>). Typically the constants for field names start with <tt>Field</tt>, and the constants for predefined values of a field start with the name of that field (e.g. <tt>TypeEvent</tt> is a predefined constant for <tt>FieldType</tt>).</p>
<p>If you wish to create your own, customized organizer item detail, you should use the <a href="qorganizeritemdetail.html#Q_DECLARE_CUSTOM_ORGANIZER_DETAIL">Q_DECLARE_CUSTOM_ORGANIZER_DETAIL</a> macro in order to ensure proper operation, and declare your own field constants with <a href="qlatin1constant.html#Q_DECLARE_LATIN1_CONSTANT">Q_DECLARE_LATIN1_CONSTANT</a>. See the predefined detail subclasses (like <a href="qorganizereventtime.html">QOrganizerEventTime</a>, <a href="qorganizeritemtype.html">QOrganizerItemType</a>) for more information.</p>
<p>QOrganizerItemDetail objects act like type checked values. In general, you can assign them to and fro and have reasonable behaviour, like the following example.</p>
<pre class="cpp"> <span class="type"><a href="qorganizeritemdescription.html">QOrganizerItemDescription</a></span> description;
description<span class="operator">.</span>setDescription(<span class="string">"Some descriptive text"</span>);
<span class="comment">// description.value(QOrganizerItemDescription::FieldDescription) == "Some descriptive text";</span>
<span class="comment">// description.definitionName() == QOrganizerItemDescription::DefinitionName</span>
<span class="type">QOrganizerItemDetail</span> detail <span class="operator">=</span> description;
<span class="comment">// detail.value(QOrganizerItemDescription::FieldDescription) == "Some descriptive text";</span>
<span class="comment">// detail.definitionName() == QOrganizerItemDescription::DefinitionName</span>
<span class="type"><a href="qorganizeritemdescription.html">QOrganizerItemDescription</a></span> otherDescription <span class="operator">=</span> detail;
<span class="comment">// otherDescription.description() == "Some descriptive text";</span>
<span class="comment">// otherDescription.definitionName() == QOrganizerItemDescription::DefinitionName</span>
<span class="type"><a href="qorganizeritemdisplaylabel.html">QOrganizerItemDisplayLabel</a></span> label <span class="operator">=</span> detail;
<span class="comment">// label is now a default constructed QOrganizerItemDisplayLabel</span>
<span class="comment">// label.value(QOrganizerItemDescription::FieldDescription) is empty</span>
<span class="comment">// label.definitionName() == QOrganizerItemDisplayLabel::DefinitionName</span>
<span class="type"><a href="qorganizeritemdisplaylabel.html">QOrganizerItemDisplayLabel</a></span> otherLabel <span class="operator">=</span> description;
<span class="comment">// otherLabel is now a default constructed QOrganizerItemDisplayLabel</span>
<span class="comment">// otherLabel.value(QOrganizerItemDescription::FieldDescription) is empty</span>
<span class="comment">// otherLabel.definitionName() == QOrganizerItemDisplayLabel::DefinitionName</span></pre>
</div>
<p><b>See also </b><a href="qorganizeritem.html">QOrganizerItem</a>, <a href="qorganizeritemdetaildefinition.html">QOrganizerItemDetailDefinition</a>, <a href="qorganizeritemdetailfilter.html">QOrganizerItemDetailFilter</a>, <a href="qorganizeritemdetailrangefilter.html">QOrganizerItemDetailRangeFilter</a>, and <a href="qorganizeritemdetail.html#Q_DECLARE_CUSTOM_ORGANIZER_DETAIL">Q_DECLARE_CUSTOM_ORGANIZER_DETAIL</a>.</p>
<!-- @@@QOrganizerItemDetail -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$AccessConstraint$$$NoConstraint$$$ReadOnly$$$Irremovable -->
<h3 class="flags"><a name="AccessConstraint-enum"></a>enum QOrganizerItemDetail::<span class="name">AccessConstraint</span><br/>flags QOrganizerItemDetail::<span class="name">AccessConstraints</span></h3>
<p>This enum defines the access constraints for a detail. This information is typically provided by the manager when an organizer item is retrieved.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QOrganizerItemDetail::NoConstraint</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">Users can read, write, and otherwise modify this detail in any manner.</td></tr>
<tr><td class="topAlign"><tt>QOrganizerItemDetail::ReadOnly</tt></td><td class="topAlign"><tt>0x01</tt></td><td class="topAlign">Users cannot write or modify values in this detail.</td></tr>
<tr><td class="topAlign"><tt>QOrganizerItemDetail::Irremovable</tt></td><td class="topAlign"><tt>0x02</tt></td><td class="topAlign">Users cannot remove this detail from an organizer item.</td></tr>
</table>
<p>The AccessConstraints type is a typedef for <a href="qflags.html">QFlags</a><AccessConstraint>. It stores an OR combination of AccessConstraint values.</p>
<!-- @@@AccessConstraint -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QOrganizerItemDetail[overload1]$$$QOrganizerItemDetail -->
<h3 class="fn"><a name="QOrganizerItemDetail"></a>QOrganizerItemDetail::<span class="name">QOrganizerItemDetail</span> ()</h3>
<p>Constructs a new, empty detail</p>
<!-- @@@QOrganizerItemDetail -->
<!-- $$$QOrganizerItemDetail$$$QOrganizerItemDetailconstchar* -->
<h3 class="fn"><a name="QOrganizerItemDetail-2"></a>QOrganizerItemDetail::<span class="name">QOrganizerItemDetail</span> ( const <span class="type">char</span> * <i>thisDefinitionId</i> )</h3>
<p>Constructs a new, empty detail of the definition identified by <i>thisDefinitionId</i></p>
<p>The supplied pointer must be valid for the lifetime of the program. In general this means it should be a constant, and not allocated on the stack. If you cannot meet this requirement, use the alternative constructor that takes a <a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a> instead.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@QOrganizerItemDetail -->
<!-- $$$QOrganizerItemDetail$$$QOrganizerItemDetailconstQString& -->
<h3 class="fn"><a name="QOrganizerItemDetail-3"></a>QOrganizerItemDetail::<span class="name">QOrganizerItemDetail</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>thisDefinitionId</i> )</h3>
<p>Constructs a new, empty detail of the definition identified by <i>thisDefinitionId</i>. The definitionId must be restricted to the Latin 1 character set.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@QOrganizerItemDetail -->
<!-- $$$QOrganizerItemDetail$$$QOrganizerItemDetailconstQOrganizerItemDetail& -->
<h3 class="fn"><a name="QOrganizerItemDetail-4"></a>QOrganizerItemDetail::<span class="name">QOrganizerItemDetail</span> ( const <span class="type">QOrganizerItemDetail</span> & <i>other</i> )</h3>
<p>Constructs a detail that is a copy of <i>other</i></p>
<!-- @@@QOrganizerItemDetail -->
<!-- $$$~QOrganizerItemDetail[overload1]$$$~QOrganizerItemDetail -->
<h3 class="fn"><a name="dtor.QOrganizerItemDetail"></a>QOrganizerItemDetail::<span class="name">~QOrganizerItemDetail</span> ()</h3>
<p>Frees the memory used by this detail</p>
<!-- @@@~QOrganizerItemDetail -->
<!-- $$$accessConstraints[overload1]$$$accessConstraints -->
<h3 class="fn"><a name="accessConstraints"></a><span class="type"><a href="qorganizeritemdetail.html#AccessConstraint-enum">AccessConstraints</a></span> QOrganizerItemDetail::<span class="name">accessConstraints</span> () const</h3>
<p>Returns the access constraints associated with the detail.</p>
<p>Some details may not be written to, while other details may not be removed from an organizer item.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritemdetail.html#AccessConstraint-enum">QOrganizerItemDetail::AccessConstraints</a>.</p>
<!-- @@@accessConstraints -->
<!-- $$$definitionName[overload1]$$$definitionName -->
<h3 class="fn"><a name="definitionName"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QOrganizerItemDetail::<span class="name">definitionName</span> () const</h3>
<p>Returns the (unique) name of the definition which defines the semantics and structure of this detail. The actual <a href="qorganizeritemdetaildefinition.html">QOrganizerItemDetailDefinition</a> should be retrieved from the relevant <a href="qorganizermanager.html">QOrganizerManager</a> using this name.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@definitionName -->
<!-- $$$hasValue[overload1]$$$hasValueconstQString& -->
<h3 class="fn"><a name="hasValue"></a><span class="type">bool</span> QOrganizerItemDetail::<span class="name">hasValue</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>key</i> ) const</h3>
<p>Returns true if this detail has a field with the given <i>key</i>, or false otherwise.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@hasValue -->
<!-- $$$hasValue$$$hasValueconstQLatin1Constant& -->
<h3 class="fn"><a name="hasValue-3"></a><span class="type">bool</span> QOrganizerItemDetail::<span class="name">hasValue</span> ( const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> & <i>key</i> ) const</h3>
<p>Returns true if this detail has a field with the given <i>key</i>, or false otherwise.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@hasValue -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn"><a name="isEmpty"></a><span class="type">bool</span> QOrganizerItemDetail::<span class="name">isEmpty</span> () const</h3>
<p>Returns true if no values are contained in this detail. Note that context is stored as a value; hence, if a context is set, this function will return false.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@isEmpty -->
<!-- $$$key[overload1]$$$key -->
<h3 class="fn"><a name="key"></a><span class="type">int</span> QOrganizerItemDetail::<span class="name">key</span> () const</h3>
<p>Returns the key of this detail.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@key -->
<!-- $$$removeValue[overload1]$$$removeValueconstQString& -->
<h3 class="fn"><a name="removeValue"></a><span class="type">bool</span> QOrganizerItemDetail::<span class="name">removeValue</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>key</i> )</h3>
<p>Removes the value stored in this detail for the given <i>key</i>. Returns true if a value was stored for the given <i>key</i> and the operation succeeded, and false otherwise.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@removeValue -->
<!-- $$$removeValue$$$removeValueconstQLatin1Constant& -->
<h3 class="fn"><a name="removeValue-3"></a><span class="type">bool</span> QOrganizerItemDetail::<span class="name">removeValue</span> ( const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> & <i>key</i> )</h3>
<p>Removes the value stored in this detail for the given <i>key</i>. Returns true if a value was stored for the given <i>key</i> and the operation succeeded, and false otherwise.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@removeValue -->
<!-- $$$resetKey[overload1]$$$resetKey -->
<h3 class="fn"><a name="resetKey"></a><span class="type">void</span> QOrganizerItemDetail::<span class="name">resetKey</span> ()</h3>
<p>Causes the implicitly-shared detail to be detached from any other copies, and generates a new key for it. This ensures that calling <a href="qorganizeritem.html#saveDetail">QOrganizerItem::saveDetail</a>() will result in a new detail being saved, rather than another detail being updated.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@resetKey -->
<!-- $$$setValue[overload1]$$$setValueconstQString&constQVariant& -->
<h3 class="fn"><a name="setValue"></a><span class="type">bool</span> QOrganizerItemDetail::<span class="name">setValue</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>key</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> & <i>value</i> )</h3>
<p>Inserts <i>value</i> into the detail for the given <i>key</i> if <i>value</i> is valid. If <i>value</i> is invalid, removes the field with the given <i>key</i> from the detail. Returns true if the given <i>value</i> was set for the <i>key</i> (if the <i>value</i> was valid), or if the given <i>key</i> was removed from detail (if the <i>value</i> was invalid), and returns false if the key was unable to be removed (and the <i>value</i> was invalid)</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritemdetail.html#value">value</a>().</p>
<!-- @@@setValue -->
<!-- $$$setValue$$$setValueconstQLatin1Constant&constQVariant& -->
<h3 class="fn"><a name="setValue-3"></a><span class="type">bool</span> QOrganizerItemDetail::<span class="name">setValue</span> ( const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> & <i>key</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> & <i>value</i> )</h3>
<p>Inserts <i>value</i> into the detail for the given <i>key</i> if <i>value</i> is valid. If <i>value</i> is invalid, removes the field with the given <i>key</i> from the detail. Returns true if the given <i>value</i> was set for the <i>key</i> (if the <i>value</i> was valid), or if the given <i>key</i> was removed from detail (if the <i>value</i> was invalid), and returns false if the key was unable to be removed (and the <i>value</i> was invalid)</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@setValue -->
<!-- $$$value[overload1]$$$valueconstQString& -->
<h3 class="fn"><a name="value"></a><span class="type">T</span> QOrganizerItemDetail::<span class="name">value</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>key</i> ) const</h3>
<p>Returns the value of the template type associated with the given <i>key</i></p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizeritemdetail.html#setValue">setValue</a>().</p>
<!-- @@@value -->
<!-- $$$value$$$valueconstQLatin1Constant& -->
<h3 class="fn"><a name="value-2"></a><span class="type">T</span> QOrganizerItemDetail::<span class="name">value</span> ( const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> & <i>key</i> ) const</h3>
<p>Returns the value stored in this detail for the given <i>key</i> as a <a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a>, or an empty <a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a> if no value for the given <i>key</i> exists</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@value -->
<!-- $$$value$$$valueconstQString& -->
<h3 class="fn"><a name="value-3"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QOrganizerItemDetail::<span class="name">value</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>key</i> ) const</h3>
<p>This is an overloaded function.</p>
<p>Returns the value stored in this detail for the given <i>key</i> as a <a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a>, or an empty <a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a> if no value for the given <i>key</i> exists</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@value -->
<!-- $$$value$$$valueconstQLatin1Constant& -->
<h3 class="fn"><a name="value-6"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QOrganizerItemDetail::<span class="name">value</span> ( const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> & <i>key</i> ) const</h3>
<p>This is an overloaded function.</p>
<p>Returns the value of the template type associated with the given <i>key</i></p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@value -->
<!-- $$$variantValue[overload1]$$$variantValueconstQString& -->
<h3 class="fn"><a name="variantValue"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> QOrganizerItemDetail::<span class="name">variantValue</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> & <i>key</i> ) const</h3>
<p>Returns the value stored in this detail for the given <i>key</i> as a <a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a>, or an invalid <a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a> if no value for the given <i>key</i> exists</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@variantValue -->
<!-- $$$variantValue$$$variantValueconstQLatin1Constant& -->
<h3 class="fn"><a name="variantValue-3"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> QOrganizerItemDetail::<span class="name">variantValue</span> ( const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> & <i>key</i> ) const</h3>
<p>Returns the value stored in this detail for the given <i>key</i> as a <a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a>, or an invalid <a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a> if no value for the given <i>key</i> exists</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@variantValue -->
<!-- $$$variantValues[overload1]$$$variantValues -->
<h3 class="fn"><a name="variantValues"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html#QVariantMap-typedef">QVariantMap</a></span> QOrganizerItemDetail::<span class="name">variantValues</span> () const</h3>
<p>Returns the values stored in this detail as a map from value key to value</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@variantValues -->
<!-- $$$operator!=[overload1]$$$operator!=constQOrganizerItemDetail& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QOrganizerItemDetail::<span class="name">operator!=</span> ( const <span class="type">QOrganizerItemDetail</span> & <i>other</i> ) const</h3>
<p>Returns true if the values or id of this detail is different to those of the <i>other</i> detail</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQOrganizerItemDetail& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QOrganizerItemDetail</span> & QOrganizerItemDetail::<span class="name">operator=</span> ( const <span class="type">QOrganizerItemDetail</span> & <i>other</i> )</h3>
<p>Assigns this detail to <i>other</i></p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQOrganizerItemDetail& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QOrganizerItemDetail::<span class="name">operator==</span> ( const <span class="type">QOrganizerItemDetail</span> & <i>other</i> ) const</h3>
<p>Compares this detail to <i>other</i>. Returns true if the definition, access constraints and values of <i>other</i> are equal to those of this detail. The keys of each detail are not considered during the comparison, in order to allow details from different organizer items to be compared according to their values.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@operator== -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$Q_DECLARE_CUSTOM_ORGANIZER_DETAIL[overload1]$$$Q_DECLARE_CUSTOM_ORGANIZER_DETAIL -->
<h3 class="fn"><a name="Q_DECLARE_CUSTOM_ORGANIZER_DETAIL"></a><span class="name">Q_DECLARE_CUSTOM_ORGANIZER_DETAIL</span></h3>
<p>Macro for simplifying declaring custom (leaf) detail classes.</p>
<p>The first argument is the name of the class, and the second argument is a Latin-1 string literal naming the detail type.</p>
<p>If you are creating a convenience class for a type of <a href="qorganizeritemdetail.html">QOrganizerItemDetail</a>, you should use this macro when declaring your class to ensure that it interoperates with other organizer item functionality.</p>
<p>Here is an example of a class (<a href="qorganizeritemdescription.html">QOrganizerItemDescription</a>) using this macro. Note that the class provides some predefined constants and some convenience methods that return values associated with schema fields.</p>
<!-- @@@Q_DECLARE_CUSTOM_ORGANIZER_DETAIL -->
</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
>
1550
