← Back to branch summary

~ubuntu-branches/ubuntu/quantal/qtmobility/quantal

« back to all changes in this revision

Viewing changes to doc/html/qorganizercollectionid.html

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2010-11-16 16:18:07 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20101116161807-k2dzt2nyse975r3l
Tags: 1.1.0-0ubuntu1
* New upstream release
* Syncronise with Debian, no remaining changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/qorganizercollectionid.html
47
47
    </div>
48
48
    <div id="shortCut">
49
49
      <ul>
50
 
        <li class="shortCut-topleft-inactive"><span><a href="index.html">Mobility 1.1 BETA</a></span></li>
 
50
        <li class="shortCut-topleft-inactive"><span><a href="index.html">Mobility 1.1</a></span></li>
51
51
        <li class="shortCut-topleft-active"><a href="http://doc.qt.nokia.com">ALL VERSIONS        </a></li>
52
52
      </ul>
53
53
     </div>
142
142
<h3>Contents</h3>
143
143
<ul>
144
144
<li class="level1"><a href="#public-functions">Public Functions</a></li>
 
145
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
145
146
<li class="level1"><a href="#related-non-members">Related Non-Members</a></li>
146
147
<li class="level1"><a href="#details">Detailed Description</a></li>
147
148
</ul>
156
157
<h2>Public Functions</h2>
157
158
<table class="alignedsummary">
158
159
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#QOrganizerCollectionId">QOrganizerCollectionId</a></b> ()</td></tr>
159
 
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#QOrganizerCollectionId-2">QOrganizerCollectionId</a></b> ( const QOrganizerCollectionId &amp; <i>other</i> )</td></tr>
 
160
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#QOrganizerCollectionId-2">QOrganizerCollectionId</a></b> ( QOrganizerCollectionEngineId * <i>engineItemId</i> )</td></tr>
 
161
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#QOrganizerCollectionId-3">QOrganizerCollectionId</a></b> ( const QOrganizerCollectionId &amp; <i>other</i> )</td></tr>
160
162
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#dtor.QOrganizerCollectionId">~QOrganizerCollectionId</a></b> ()</td></tr>
161
 
<tr><td class="memItemLeft rightAlign topAlign"> QOrganizerCollectionLocalId </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#localId">localId</a></b> () const</td></tr>
 
163
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#isNull">isNull</a></b> () const</td></tr>
162
164
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#managerUri">managerUri</a></b> () const</td></tr>
163
 
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#setLocalId">setLocalId</a></b> ( const QOrganizerCollectionLocalId &amp; <i>id</i> )</td></tr>
164
 
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#setManagerUri">setManagerUri</a></b> ( const QString &amp; <i>uri</i> )</td></tr>
 
165
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#toString">toString</a></b> () const</td></tr>
165
166
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#operator-not-eq">operator!=</a></b> ( const QOrganizerCollectionId &amp; <i>other</i> ) const</td></tr>
166
167
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#operator-lt">operator&lt;</a></b> ( const QOrganizerCollectionId &amp; <i>other</i> ) const</td></tr>
167
168
<tr><td class="memItemLeft rightAlign topAlign"> QOrganizerCollectionId &amp; </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#operator-eq">operator=</a></b> ( const QOrganizerCollectionId &amp; <i>other</i> )</td></tr>
168
169
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#operator-eq-eq">operator==</a></b> ( const QOrganizerCollectionId &amp; <i>other</i> ) const</td></tr>
169
170
</table>
170
171
<hr />
 
172
<a name="static-public-members"></a>
 
173
<h2>Static Public Members</h2>
 
174
<table class="alignedsummary">
 
175
<tr><td class="memItemLeft rightAlign topAlign"> QOrganizerCollectionId </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#fromString">fromString</a></b> ( const QString &amp; <i>idString</i> )</td></tr>
 
176
</table>
 
177
<hr />
171
178
<a name="related-non-members"></a>
172
179
<h2>Related Non-Members</h2>
173
180
<table class="alignedsummary">
174
 
<tr><td class="memItemLeft rightAlign topAlign"> typedef </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html#QOrganizerCollectionLocalId-typedef">QOrganizerCollectionLocalId</a></b></td></tr>
 
181
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qorganizercollectionid.html">QOrganizerCollectionEngineId</a></b></td></tr>
175
182
</table>
176
183
<a name="details"></a>
177
184
<hr />
178
185
<div class="descr"/>
179
186
<h2>Detailed Description</h2>
180
187
<p>The QOrganizerCollectionId class provides information that uniquely identifies a collection in a particular manager.</p>
181
 
<p>It consists of a manager URI which identifies the manager which manages the collection, and the local id of the collection in that manager.</p>
182
 
<p>A &quot;null&quot; QOrganizerCollectionId has an empty manager URI, and an invalid <a href="qorganizercollectionid.html#QOrganizerCollectionLocalId-typedef">QOrganizerCollectionLocalId</a> (0).</p>
 
188
<p>It consists of a manager URI which identifies the manager which manages the collection, and the id of the collection in that manager.</p>
 
189
<p>A &quot;null&quot; QOrganizerCollectionId has an empty manager URI, and an invalid QOrganizerCollectionId (0).</p>
183
190
</div>
184
 
<p>See also <a href="qorganizercollectionid.html#QOrganizerCollectionLocalId-typedef">QOrganizerCollectionLocalId</a>.</p>
185
191
<hr />
186
192
<div class="func"/>
187
193
<h2>Member Function Documentation</h2>
188
194
<h3 class="fn"><a name="QOrganizerCollectionId"></a>QOrganizerCollectionId::QOrganizerCollectionId ()</h3>
189
 
<p>Constructs a new organizeritem id</p>
190
 
<h3 class="fn"><a name="QOrganizerCollectionId-2"></a>QOrganizerCollectionId::QOrganizerCollectionId ( const QOrganizerCollectionId &amp; <i>other</i> )</h3>
191
 
<p>Constructs a new organizeritem id as a copy of <i>other</i></p>
 
195
<p>Constructs a new, null collection id</p>
 
196
<h3 class="fn"><a name="QOrganizerCollectionId-2"></a>QOrganizerCollectionId::QOrganizerCollectionId ( <a href="qorganizercollectionid.html">QOrganizerCollectionEngineId</a> * <i>engineItemId</i> )</h3>
 
197
<p>Constructs a manager-unique id which wraps the given engine-unique item id <i>engineItemId</i>. This id takes ownership of the engine-unique item id and will delete it when the id goes out of scope. Engine implementors must not delete the <i>engineItemId</i> or undefined behaviour will occur.</p>
 
198
<h3 class="fn"><a name="QOrganizerCollectionId-3"></a>QOrganizerCollectionId::QOrganizerCollectionId ( const QOrganizerCollectionId &amp; <i>other</i> )</h3>
 
199
<p>Constructs a new collection id as a copy of <i>other</i></p>
192
200
<h3 class="fn"><a name="dtor.QOrganizerCollectionId"></a>QOrganizerCollectionId::~QOrganizerCollectionId ()</h3>
193
 
<p>Cleans up the memory in use by the organizeritem id</p>
194
 
<h3 class="fn"><a name="localId"></a><a href="qorganizercollectionid.html#QOrganizerCollectionLocalId-typedef">QOrganizerCollectionLocalId</a> QOrganizerCollectionId::localId () const</h3>
195
 
<p>Returns the manager-local id of the organizeritem identified by this organizeritem id</p>
196
 
<p>See also <a href="qorganizercollectionid.html#setLocalId">setLocalId</a>().</p>
197
 
<h3 class="fn"><a name="managerUri"></a>QString QOrganizerCollectionId::managerUri () const</h3>
198
 
<p>Returns the URI of the manager which contains the organizeritem identified by this id</p>
199
 
<p>See also <a href="qorganizercollectionid.html#setManagerUri">setManagerUri</a>().</p>
200
 
<h3 class="fn"><a name="setLocalId"></a>void QOrganizerCollectionId::setLocalId ( const <a href="qorganizercollectionid.html#QOrganizerCollectionLocalId-typedef">QOrganizerCollectionLocalId</a> &amp; <i>id</i> )</h3>
201
 
<p>Sets the manager-local id of the organizeritem identified by this organizeritem id to <i>id</i></p>
202
 
<p>See also <a href="qorganizercollectionid.html#localId">localId</a>().</p>
203
 
<h3 class="fn"><a name="setManagerUri"></a>void QOrganizerCollectionId::setManagerUri ( const QString &amp; <i>uri</i> )</h3>
204
 
<p>Sets the URI of the manager which contains the organizeritem identified by this id to <i>uri</i></p>
205
 
<p>See also <a href="qorganizercollectionid.html#managerUri">managerUri</a>().</p>
 
201
<p>Cleans up the memory in use by the collection id</p>
 
202
<h3 class="fn"><a name="fromString"></a>QOrganizerCollectionId QOrganizerCollectionId::fromString ( const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>idString</i> )<tt> [static]</tt></h3>
 
203
<p>Deserializes the given <i>idString</i>. Returns a default-constructed (null) item id if the given <i>idString</i> is not a valid, serialized item id, or if the manager engine from which the id came could not be found.</p>
 
204
<h3 class="fn"><a name="isNull"></a>bool QOrganizerCollectionId::isNull () const</h3>
 
205
<p>Returns true if the id part of this id is a null (default constructed) id; otherwise, returns false.</p>
 
206
<h3 class="fn"><a name="managerUri"></a><a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> QOrganizerCollectionId::managerUri () const</h3>
 
207
<p>Returns the URI of the manager which contains the collection identified by this id</p>
 
208
<h3 class="fn"><a name="toString"></a><a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> QOrganizerCollectionId::toString () const</h3>
 
209
<p>Serializes the id to a string. The format of the string will be: &quot;qtorganizer:managerName:constructionParams:serializedEngineLocalItemId&quot;</p>
206
210
<h3 class="fn"><a name="operator-not-eq"></a>bool QOrganizerCollectionId::operator!= ( const QOrganizerCollectionId &amp; <i>other</i> ) const</h3>
207
 
<p>Returns true if either the manager URI or local id of the organizeritem id is different to that of <i>other</i></p>
 
211
<p>Returns true if either the manager URI or id of the collection id is different to that of <i>other</i></p>
208
212
<h3 class="fn"><a name="operator-lt"></a>bool QOrganizerCollectionId::operator&lt; ( const QOrganizerCollectionId &amp; <i>other</i> ) const</h3>
209
 
<p>Returns true if this id is less than the <i>other</i> id. This id will be considered less than the <i>other</i> id if the manager URI of this id is alphabetically less than the manager URI of the <i>other</i> id. If both ids have the same manager URI, this id will be considered less than the <i>other</i> id if the local id of this id is less than the local id of the <i>other</i> id.</p>
210
 
<p>The invalid, empty id consists of an empty manager URI and the invalid, zero local id, and hence will be less than any non-invalid id.</p>
211
 
<p>This operator is provided primarily to allow use of a <a href="qorganizercollectionid.html">QOrganizerCollectionId</a> as a key in a QMap.</p>
 
213
<p>Returns true if this id is less than the <i>other</i> id. This id will be considered less than the <i>other</i> id if the manager URI of this id is alphabetically less than the manager URI of the <i>other</i> id. If both ids have the same manager URI, this id will be considered less than the <i>other</i> id if the id of this id is less than the id of the <i>other</i> id.</p>
 
214
<p>The invalid, empty id consists of an empty manager URI and the invalid, zero id, and hence will be less than any non-invalid id.</p>
 
215
<p>This operator is provided primarily to allow use of a <a href="qorganizercollectionid.html">QOrganizerCollectionId</a> as a key in a <a href="http://qt.nokia.com/doc/4.6/qmap.html">QMap</a>.</p>
212
216
<h3 class="fn"><a name="operator-eq"></a>QOrganizerCollectionId &amp; QOrganizerCollectionId::operator= ( const QOrganizerCollectionId &amp; <i>other</i> )</h3>
213
 
<p>Assigns the organizeritem id to be equal to <i>other</i></p>
 
217
<p>Assigns the collection id to be equal to <i>other</i></p>
214
218
<h3 class="fn"><a name="operator-eq-eq"></a>bool QOrganizerCollectionId::operator== ( const QOrganizerCollectionId &amp; <i>other</i> ) const</h3>
215
 
<p>Returns true if the organizeritem id has the same manager URI and local id as <i>other</i></p>
 
219
<p>Returns true if the collection id has the same manager URI and id as <i>other</i></p>
216
220
</div>
217
221
<hr />
218
222
<div class="relnonmem"/>
219
223
<h2>Related Non-Members</h2>
220
 
<h3 class="fn"><a name="QOrganizerCollectionLocalId-typedef"></a>typedef QOrganizerCollectionLocalId</h3>
221
 
<p>The QOrganizerCollectionLocalId type represents the unique id of a collection within its manager.</p>
222
 
<p>Most collection-related operations within a <a href="qorganizeritemmanager.html">QOrganizerItemManager</a> accept a QOrganizerCollectionLocalId. Some operations (involving links to collections outside a particular manager) also accept a manager URI - this combination is stored in a <a href="qorganizercollectionid.html">QOrganizerCollectionId</a>.</p>
223
 
<p>An invalid QOrganizerCollectionLocalId is represented by a zero (0) value.</p>
224
 
<p>See also <a href="qorganizercollectionid.html">QOrganizerCollectionId</a>.</p>
 
224
<h3> class <a href="qorganizercollectionid.html">QOrganizerCollectionEngineId</a></h3><p>The QOrganizerCollectionEngineId class uniquely identifies an item within a particular engine plugin. <a href="qorganizercollectionid.html#details">More...</a></p>
225
225
</div>
226
226
        <!-- /div -->
227
227
        <div class="feedback t_button">