Sophie

Sophie

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

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" />
<!-- qorganizercollection.cpp -->
  <title>Qt Mobility 1.2: QOrganizerCollection 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>QOrganizerCollection</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="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QOrganizerCollection Class Reference</h1>
<!-- $$$QOrganizerCollection-brief -->
<p>The QOrganizerCollection class represents a collection of items in a manager. <a href="#details">More...</a></p>
<!-- @@@QOrganizerCollection -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QOrganizerCollection&gt;</span></pre><p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qorganizercollection-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="qorganizercollection.html#QOrganizerCollection">QOrganizerCollection</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#QOrganizerCollection-2">QOrganizerCollection</a></b> ( const QOrganizerCollection &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#dtor.QOrganizerCollection">~QOrganizerCollection</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QOrganizerCollectionId </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#id">id</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariantMap </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#metaData">metaData</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#metaData-2">metaData</a></b> ( const QString &amp; <i>key</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#setId">setId</a></b> ( const QOrganizerCollectionId &amp; <i>id</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#setMetaData">setMetaData</a></b> ( const QVariantMap &amp; <i>metaData</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#setMetaData-2">setMetaData</a></b> ( const QString &amp; <i>key</i>, const QVariant &amp; <i>value</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#operator-not-eq">operator!=</a></b> ( const QOrganizerCollection &amp; <i>other</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QOrganizerCollection &amp; </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#operator-eq">operator=</a></b> ( const QOrganizerCollection &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#operator-eq-eq">operator==</a></b> ( const QOrganizerCollection &amp; <i>other</i> ) const</td></tr>
</table>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#KeyColor-var">KeyColor</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#KeyDescription-var">KeyDescription</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#KeyImage-var">KeyImage</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QLatin1Constant </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollection.html#KeyName-var">KeyName</a></b></td></tr>
</table>
<a name="details"></a>
<!-- $$$QOrganizerCollection-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QOrganizerCollection class represents a collection of items in a manager.</p>
<p>A collection has an id and optionally some metadata, and contains zero or more items. Each different manager will have different requirements before a collection may be saved in it. Some managers do not allow collections to be saved at all, while others may require a collection to have some minimal amount of meta data defined in it prior to save. For example, most managers require a valid value for the <tt>QOrganizerCollection::KeyName</tt> meta data key to be set prior to save.</p>
<p>Every <a href="qorganizeritem.html">QOrganizerItem</a> is contained within a collection when stored in a manager. To save an item in a collection, the client should call <a href="qorganizeritem.html#setCollectionId">QOrganizerItem::setCollectionId</a>() on the item, passing in the id of the destination collection as the argument, and then save the item in the manager. To move an item from one collection to another, the client must fetch the item from the manager, set the collection id in the item to the id of the collection to which the client wishes the item to be moved, and then resave the item in the manager. That is, the collection which an item is part of is treated as a property of the item.</p>
</div>
<!-- @@@QOrganizerCollection -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QOrganizerCollection[overload1]$$$QOrganizerCollection -->
<h3 class="fn"><a name="QOrganizerCollection"></a>QOrganizerCollection::<span class="name">QOrganizerCollection</span> ()</h3>
<p>Constructs a new collection</p>
<!-- @@@QOrganizerCollection -->
<!-- $$$QOrganizerCollection$$$QOrganizerCollectionconstQOrganizerCollection& -->
<h3 class="fn"><a name="QOrganizerCollection-2"></a>QOrganizerCollection::<span class="name">QOrganizerCollection</span> ( const <span class="type">QOrganizerCollection</span> &amp; <i>other</i> )</h3>
<p>Constructs a new copy of the <i>other</i> collection</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@QOrganizerCollection -->
<!-- $$$~QOrganizerCollection[overload1]$$$~QOrganizerCollection -->
<h3 class="fn"><a name="dtor.QOrganizerCollection"></a>QOrganizerCollection::<span class="name">~QOrganizerCollection</span> ()</h3>
<p>Cleans up any memory in use by the collection</p>
<!-- @@@~QOrganizerCollection -->
<!-- $$$id[overload1]$$$id -->
<h3 class="fn"><a name="id"></a><span class="type"><a href="qorganizercollectionid.html">QOrganizerCollectionId</a></span> QOrganizerCollection::<span class="name">id</span> () const</h3>
<p>Returns the complete id of the collection, which includes the manager uri and the manager id of the collection</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizercollection.html#setId">setId</a>().</p>
<!-- @@@id -->
<!-- $$$metaData[overload1]$$$metaData -->
<h3 class="fn"><a name="metaData"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html#QVariantMap-typedef">QVariantMap</a></span> QOrganizerCollection::<span class="name">metaData</span> () const</h3>
<p>Returns the meta data of the collection</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizercollection.html#setMetaData">setMetaData</a>().</p>
<!-- @@@metaData -->
<!-- $$$metaData$$$metaDataconstQString& -->
<h3 class="fn"><a name="metaData-2"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> QOrganizerCollection::<span class="name">metaData</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>key</i> ) const</h3>
<p>Returns the meta data of the collection for the given <i>key</i></p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@metaData -->
<!-- $$$setId[overload1]$$$setIdconstQOrganizerCollectionId& -->
<h3 class="fn"><a name="setId"></a><span class="type">void</span> QOrganizerCollection::<span class="name">setId</span> ( const <span class="type"><a href="qorganizercollectionid.html">QOrganizerCollectionId</a></span> &amp; <i>id</i> )</h3>
<p>Sets the id of the collection to <i>id</i>. If the id is set to a null (default-constructed) id, saving the collection will cause the manager to save the collection as a new collection (if it supports that operation).</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizercollection.html#id">id</a>().</p>
<!-- @@@setId -->
<!-- $$$setMetaData[overload1]$$$setMetaDataconstQVariantMap& -->
<h3 class="fn"><a name="setMetaData"></a><span class="type">void</span> QOrganizerCollection::<span class="name">setMetaData</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html#QVariantMap-typedef">QVariantMap</a></span> &amp; <i>metaData</i> )</h3>
<p>Sets the meta data of the collection to <i>metaData</i>. Not all managers support arbitrary meta data for collections. You can see whether the meta data is compatible with the manager by calling <a href="qorganizermanager.html#compatibleCollection">QOrganizerManager::compatibleCollection</a>(). Attempting to save a collection with unsupported meta data in a manager will cause an error in the operation.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qorganizercollection.html#metaData">metaData</a>().</p>
<!-- @@@setMetaData -->
<!-- $$$setMetaData$$$setMetaDataconstQString&constQVariant& -->
<h3 class="fn"><a name="setMetaData-2"></a><span class="type">void</span> QOrganizerCollection::<span class="name">setMetaData</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>key</i>, const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> &amp; <i>value</i> )</h3>
<p>Sets the meta data of the collection for the given <i>key</i> to the given <i>value</i>. Not all managers support all of the standard meta data keys (see <a href="qorganizercollection.html">QOrganizerCollection</a>), and some will support extra or even arbitrary keys. Similarly, not all managers support all possible data types for the meta data <i>value</i>. Attempting to save a collection with unsupported meta data in a manager will cause an error in the operation.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@setMetaData -->
<!-- $$$operator!=[overload1]$$$operator!=constQOrganizerCollection& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QOrganizerCollection::<span class="name">operator!=</span> ( const <span class="type">QOrganizerCollection</span> &amp; <i>other</i> ) const</h3>
<p>Returns true if the id of the collection is not the same as that of the <i>other</i> collection. Does not check that the metadata of the collections is not equal.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQOrganizerCollection& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QOrganizerCollection</span> &amp; QOrganizerCollection::<span class="name">operator=</span> ( const <span class="type">QOrganizerCollection</span> &amp; <i>other</i> )</h3>
<p>Assigns this collection to be equal to the <i>other</i> collection</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQOrganizerCollection& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QOrganizerCollection::<span class="name">operator==</span> ( const <span class="type">QOrganizerCollection</span> &amp; <i>other</i> ) const</h3>
<p>Returns true if the id of the collection is the same as that of the <i>other</i> collection. Does not check that the metadata of the collections is equal.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@operator== -->
</div>
<div class="vars">
<h2>Member Variable Documentation</h2>
<!-- $$$KeyColor -->
<h3 class="fn"><a name="KeyColor-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QOrganizerCollection::<span class="name">KeyColor</span></h3>
<p>The constant key value which identifies the color meta data of a collection.</p>
<!-- @@@KeyColor -->
<!-- $$$KeyDescription -->
<h3 class="fn"><a name="KeyDescription-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QOrganizerCollection::<span class="name">KeyDescription</span></h3>
<p>The constant key value which identifies the description meta data of a collection.</p>
<!-- @@@KeyDescription -->
<!-- $$$KeyImage -->
<h3 class="fn"><a name="KeyImage-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QOrganizerCollection::<span class="name">KeyImage</span></h3>
<p>The constant key value which identifies the image meta data of a collection.</p>
<!-- @@@KeyImage -->
<!-- $$$KeyName -->
<h3 class="fn"><a name="KeyName-var"></a>const <span class="type"><a href="qlatin1constant.html">QLatin1Constant</a></span> QOrganizerCollection::<span class="name">KeyName</span></h3>
<p>The constant key value which identifies the name meta data of a collection.</p>
<!-- @@@KeyName -->
</div>
  <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