← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/html/qgalleryitemrequest.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/qgalleryitemrequest.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>
173
173
</table>
174
174
<ul>
175
175
<li class="fn">7 properties inherited from <a href="qgalleryabstractrequest.html#properties">QGalleryAbstractRequest</a></li>
 
176
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#properties">QObject</a></li>
176
177
</ul>
177
178
<hr />
178
179
<a name="public-functions"></a>
202
203
</table>
203
204
<ul>
204
205
<li class="fn">10 public functions inherited from <a href="qgalleryabstractrequest.html#public-functions">QGalleryAbstractRequest</a></li>
 
206
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-functions">QObject</a></li>
205
207
</ul>
206
208
<hr />
207
209
<a name="signals"></a>
208
210
<h2>Signals</h2>
209
211
<table class="alignedsummary">
 
212
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgalleryitemrequest.html#autoUpdateChanged">autoUpdateChanged</a></b> ()</td></tr>
210
213
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgalleryitemrequest.html#itemChanged">itemChanged</a></b> ()</td></tr>
211
214
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgalleryitemrequest.html#itemIdChanged">itemIdChanged</a></b> ()</td></tr>
212
215
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgalleryitemrequest.html#metaDataChanged">metaDataChanged</a></b> ( const QList&lt;int&gt; &amp; <i>keys</i> )</td></tr>
 
216
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgalleryitemrequest.html#propertyNamesChanged">propertyNamesChanged</a></b> ()</td></tr>
213
217
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgalleryitemrequest.html#resultSetChanged">resultSetChanged</a></b> ( QGalleryResultSet * <i>resultSet</i> )</td></tr>
214
218
</table>
215
219
<ul>
216
 
<li class="fn">7 signals inherited from <a href="qgalleryabstractrequest.html#signals">QGalleryAbstractRequest</a></li>
 
220
<li class="fn">8 signals inherited from <a href="qgalleryabstractrequest.html#signals">QGalleryAbstractRequest</a></li>
 
221
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#signals">QObject</a></li>
217
222
</ul>
218
223
<hr />
219
224
<a name="reimplemented-protected-functions"></a>
223
228
</table>
224
229
<ul>
225
230
<li class="fn">1 protected function inherited from <a href="qgalleryabstractrequest.html#protected-functions">QGalleryAbstractRequest</a></li>
 
231
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#protected-functions">QObject</a></li>
226
232
</ul>
227
233
<h3>Additional Inherited Members</h3>
228
234
<ul>
229
235
<li class="fn">3 public slots inherited from <a href="qgalleryabstractrequest.html#public-slots">QGalleryAbstractRequest</a></li>
 
236
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-slots">QObject</a></li>
 
237
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#public-variables">QObject</a></li>
 
238
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#static-public-members">QObject</a></li>
230
239
<li class="fn">1 protected function inherited from <a href="qgalleryabstractrequest.html#protected-functions">QGalleryAbstractRequest</a></li>
 
240
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#protected-functions">QObject</a></li>
 
241
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.6/qobject.html#protected-variables">QObject</a></li>
231
242
</ul>
232
243
<a name="details"></a>
233
244
<hr />
234
245
<div class="descr"/>
235
246
<h2>Detailed Description</h2>
236
247
<p>The QGalleryItemRequest class provides a request for the properties of a single item from a gallery.</p>
 
248
<p>QGalleryItemRequest executes a query which returns information about the gallery item specified in <a href="qgalleryitemrequest.html#itemId-prop">itemId</a>. The query will return an <a href="qgalleryitemrequest.html#itemUrl-prop">itemUrl</a>, an <a href="qgalleryitemrequest.html#itemType-prop">itemType</a>, <a href="qgalleryitemrequest.html#resources-prop">resources</a> and <a href="qgalleryitemrequest.html#metaData">meta-data</a> values for the properties listed in <a href="qgalleryitemrequest.html#propertyNames-prop">propertyNames</a>.</p>
 
249
<p>When the request has finished and if the item could be found the <a href="qgalleryitemrequest.html#valid-prop">valid</a> property will be true, if not it will be false.</p>
 
250
<p>If the <a href="qgalleryitemrequest.html#autoUpdate-prop">autoUpdate</a> property is true when the request is executed it will enter an <a href="qgalleryabstractrequest.html#State-enum">Idle</a> state on finishing and will refresh the queried information if the item changes. If the gallery can't provide updates it will instead go immediately to the <a href="qgalleryabstractrequest.html#State-enum">Finished</a> state. Automatic updates can be canceled by calling <a href="qgalleryabstractrequest.html#cancel">cancel</a>() on a idle request.</p>
237
251
</div>
 
252
<p>See also <a href="qdocumentgallery.html">QDocumentGallery</a>.</p>
238
253
<hr />
239
254
<div class="prop"/>
240
255
<h2>Property Documentation</h2>
246
261
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><b>autoUpdate</b> () const</td></tr>
247
262
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><b>setAutoUpdate</b> ( bool <i>enabled</i> )</td></tr>
248
263
</table>
249
 
<h3 class="fn"><a name="itemId-prop"></a>itemId : QVariant</h3>
 
264
<p><b>Notifier signal:</b></p>
 
265
<table class="alignedsummary">
 
266
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgalleryitemrequest.html#autoUpdateChanged">autoUpdateChanged</a></b> ()</td></tr>
 
267
</table>
 
268
<h3 class="fn"><a name="itemId-prop"></a>itemId : <a href="http://qt.nokia.com/doc/4.6/qvariant.html">QVariant</a></h3>
250
269
<p>This property holds the ID of an item the request should return the properties of.</p>
251
270
<p><b>Access functions:</b></p>
252
271
<table class="alignedsummary">
257
276
<table class="alignedsummary">
258
277
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgalleryitemrequest.html#itemIdChanged">itemIdChanged</a></b> ()</td></tr>
259
278
</table>
260
 
<h3 class="fn"><a name="itemType-prop"></a>itemType : const QString</h3>
 
279
<h3 class="fn"><a name="itemType-prop"></a>itemType : const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a></h3>
261
280
<p>This property holds the type of an item.</p>
262
281
<p><b>Access functions:</b></p>
263
282
<table class="alignedsummary">
267
286
<table class="alignedsummary">
268
287
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgalleryitemrequest.html#itemChanged">itemChanged</a></b> ()</td></tr>
269
288
</table>
270
 
<h3 class="fn"><a name="itemUrl-prop"></a>itemUrl : const QUrl</h3>
 
289
<h3 class="fn"><a name="itemUrl-prop"></a>itemUrl : const <a href="http://qt.nokia.com/doc/4.6/qurl.html">QUrl</a></h3>
271
290
<p>This property holds the URL of an item.</p>
272
291
<p><b>Access functions:</b></p>
273
292
<table class="alignedsummary">
277
296
<table class="alignedsummary">
278
297
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgalleryitemrequest.html#itemChanged">itemChanged</a></b> ()</td></tr>
279
298
</table>
280
 
<h3 class="fn"><a name="propertyNames-prop"></a>propertyNames : QStringList</h3>
 
299
<h3 class="fn"><a name="propertyNames-prop"></a>propertyNames : <a href="http://qt.nokia.com/doc/4.6/qstringlist.html">QStringList</a></h3>
281
300
<p>This property holds a list of names of meta-data properties a request should return values for.</p>
282
301
<p><b>Access functions:</b></p>
283
302
<table class="alignedsummary">
284
303
<tr><td class="memItemLeft topAlign rightAlign"> QStringList </td><td class="memItemRight bottomAlign"><b>propertyNames</b> () const</td></tr>
285
304
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><b>setPropertyNames</b> ( const QStringList &amp; <i>names</i> )</td></tr>
286
305
</table>
287
 
<h3 class="fn"><a name="resources-prop"></a>resources : const QList&lt;<a href="qgalleryresource.html">QGalleryResource</a>&gt;</h3>
 
306
<p><b>Notifier signal:</b></p>
 
307
<table class="alignedsummary">
 
308
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgalleryitemrequest.html#propertyNamesChanged">propertyNamesChanged</a></b> ()</td></tr>
 
309
</table>
 
310
<h3 class="fn"><a name="resources-prop"></a>resources : const <a href="http://qt.nokia.com/doc/4.6/qlist.html">QList</a>&lt;<a href="qgalleryresource.html">QGalleryResource</a>&gt;</h3>
288
311
<p>This property holds the resources of an item.</p>
289
312
<p><b>Access functions:</b></p>
290
313
<table class="alignedsummary">
308
331
<hr />
309
332
<div class="func"/>
310
333
<h2>Member Function Documentation</h2>
311
 
<h3 class="fn"><a name="QGalleryItemRequest"></a>QGalleryItemRequest::QGalleryItemRequest ( QObject * <i>parent</i> = 0 )</h3>
 
334
<h3 class="fn"><a name="QGalleryItemRequest"></a>QGalleryItemRequest::QGalleryItemRequest ( <a href="http://qt.nokia.com/doc/4.6/qobject.html">QObject</a> * <i>parent</i> = 0 )</h3>
312
335
<p>Constructs a new gallery item request.</p>
313
 
<p>The <i>parent</i> is passed to QObject.</p>
314
 
<h3 class="fn"><a name="QGalleryItemRequest-2"></a>QGalleryItemRequest::QGalleryItemRequest ( <a href="qabstractgallery.html">QAbstractGallery</a> * <i>gallery</i>, QObject * <i>parent</i> = 0 )</h3>
 
336
<p>The <i>parent</i> is passed to <a href="http://qt.nokia.com/doc/4.6/qobject.html">QObject</a>.</p>
 
337
<h3 class="fn"><a name="QGalleryItemRequest-2"></a>QGalleryItemRequest::QGalleryItemRequest ( <a href="qabstractgallery.html">QAbstractGallery</a> * <i>gallery</i>, <a href="http://qt.nokia.com/doc/4.6/qobject.html">QObject</a> * <i>parent</i> = 0 )</h3>
315
338
<p>Contructs a new item request for the given <i>gallery</i>.</p>
316
 
<p>The <i>parent</i> is passed to QObject.</p>
 
339
<p>The <i>parent</i> is passed to <a href="http://qt.nokia.com/doc/4.6/qobject.html">QObject</a>.</p>
317
340
<h3 class="fn"><a name="dtor.QGalleryItemRequest"></a>QGalleryItemRequest::~QGalleryItemRequest ()</h3>
318
341
<p>Destroys a gallery item request.</p>
 
342
<h3 class="fn"><a name="autoUpdateChanged"></a>void QGalleryItemRequest::autoUpdateChanged ()<tt> [signal]</tt></h3>
 
343
<p>Signals that the value of <a href="qgalleryitemrequest.html#autoUpdate-prop">autoUpdate</a> has changed.</p>
319
344
<h3 class="fn"><a name="itemChanged"></a>void QGalleryItemRequest::itemChanged ()<tt> [signal]</tt></h3>
320
345
<p>Signals that the properties of an item have changed.</p>
321
346
<h3 class="fn"><a name="itemIdChanged"></a>void QGalleryItemRequest::itemIdChanged ()<tt> [signal]</tt></h3>
322
347
<p>Signals that the value of the <a href="qgalleryitemrequest.html#itemId-prop">itemId</a> property has changed.</p>
323
 
<h3 class="fn"><a name="metaData"></a>QVariant QGalleryItemRequest::metaData ( int <i>key</i> ) const</h3>
 
348
<h3 class="fn"><a name="metaData"></a><a href="http://qt.nokia.com/doc/4.6/qvariant.html">QVariant</a> QGalleryItemRequest::metaData ( int <i>key</i> ) const</h3>
324
349
<p>Returns the value of a meta-data property identified by <i>key</i>.</p>
325
350
<p>See also <a href="qgalleryitemrequest.html#setMetaData">setMetaData</a>().</p>
326
 
<h3 class="fn"><a name="metaData-2"></a>QVariant QGalleryItemRequest::metaData ( const QString &amp; <i>property</i> ) const</h3>
 
351
<h3 class="fn"><a name="metaData-2"></a><a href="http://qt.nokia.com/doc/4.6/qvariant.html">QVariant</a> QGalleryItemRequest::metaData ( const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>property</i> ) const</h3>
327
352
<p>Returns the value of a meta-data <i>property</i>.</p>
328
 
<h3 class="fn"><a name="metaDataChanged"></a>void QGalleryItemRequest::metaDataChanged ( const QList&lt;int&gt; &amp; <i>keys</i> )<tt> [signal]</tt></h3>
 
353
<h3 class="fn"><a name="metaDataChanged"></a>void QGalleryItemRequest::metaDataChanged ( const <a href="http://qt.nokia.com/doc/4.6/qlist.html">QList</a>&lt;int&gt; &amp; <i>keys</i> )<tt> [signal]</tt></h3>
329
354
<p>Signals that the values of meta-data properties identified by <i>keys</i> have changed.</p>
330
355
<h3 class="fn"><a name="propertyAttributes"></a><a href="qgalleryproperty.html#Attribute-enum">QGalleryProperty::Attributes</a> QGalleryItemRequest::propertyAttributes ( int <i>key</i> ) const</h3>
331
356
<p>Returns the attributes of the property identified by <i>key</i>.</p>
332
 
<h3 class="fn"><a name="propertyKey"></a>int QGalleryItemRequest::propertyKey ( const QString &amp; <i>property</i> ) const</h3>
 
357
<h3 class="fn"><a name="propertyKey"></a>int QGalleryItemRequest::propertyKey ( const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>property</i> ) const</h3>
333
358
<p>Returns the key of <i>property</i>.</p>
334
 
<h3 class="fn"><a name="propertyType"></a>QVariant::Type QGalleryItemRequest::propertyType ( int <i>key</i> ) const</h3>
 
359
<h3 class="fn"><a name="propertyNamesChanged"></a>void QGalleryItemRequest::propertyNamesChanged ()<tt> [signal]</tt></h3>
 
360
<p>Signals that the value of <a href="qgalleryitemrequest.html#propertyNames-prop">propertyNames</a> has changed.</p>
 
361
<h3 class="fn"><a name="propertyType"></a><a href="http://qt.nokia.com/doc/4.6/qvariant.html#Type-enum">QVariant::Type</a> QGalleryItemRequest::propertyType ( int <i>key</i> ) const</h3>
335
362
<p>Returns the type of the property identified by <i>key</i>.</p>
336
363
<h3 class="fn"><a name="resultSet"></a><a href="qgalleryresultset.html">QGalleryResultSet</a> * QGalleryItemRequest::resultSet () const</h3>
337
364
<p>Returns the result set containing the meta-data of a type.</p>
338
365
<h3 class="fn"><a name="resultSetChanged"></a>void QGalleryItemRequest::resultSetChanged ( <a href="qgalleryresultset.html">QGalleryResultSet</a> * <i>resultSet</i> )<tt> [signal]</tt></h3>
339
366
<p>Signals that the <i>resultSet</i> containing the meta-data of an item has changed.</p>
340
 
<h3 class="fn"><a name="setMetaData"></a>bool QGalleryItemRequest::setMetaData ( int <i>key</i>, const QVariant &amp; <i>value</i> )</h3>
 
367
<h3 class="fn"><a name="setMetaData"></a>bool QGalleryItemRequest::setMetaData ( int <i>key</i>, const <a href="http://qt.nokia.com/doc/4.6/qvariant.html">QVariant</a> &amp; <i>value</i> )</h3>
341
368
<p>Sets the <i>value</i> of a meta-data property identified by <i>key</i>.</p>
342
369
<p>Returns true if the value was changed; otherwise returns false.</p>
343
370
<p>See also <a href="qgalleryitemrequest.html#metaData">metaData</a>().</p>
344
 
<h3 class="fn"><a name="setMetaData-2"></a>bool QGalleryItemRequest::setMetaData ( const QString &amp; <i>property</i>, const QVariant &amp; <i>value</i> )</h3>
 
371
<h3 class="fn"><a name="setMetaData-2"></a>bool QGalleryItemRequest::setMetaData ( const <a href="http://qt.nokia.com/doc/4.6/qstring.html">QString</a> &amp; <i>property</i>, const <a href="http://qt.nokia.com/doc/4.6/qvariant.html">QVariant</a> &amp; <i>value</i> )</h3>
345
372
<p>Sets the</p>
346
373
<table class="valuelist"><tr class="odd"><tr><th>Constant</th><th>Value</th><th>Description</th></tr>
347
374
<tr><td  class="topAlign"><tt>QGalleryItemRequest::of</tt></td><td class=" topAlign">?</td><td  class="topAlign">a meta-data <i>property</i>.</td></tr>