MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9
QtMobility Reference Documentation

Contents

QML DocumentGalleryModel Element

The DocumentGalleryModel element is used to specify a model containing items from the document gallery. More...

This element was introduced in Mobility 1.1.

Properties

Methods

Detailed Description

This element is part of the QtMobility.gallery 1.1 module.

The properties that should be returned for each item by the query are specified in properties. In addition all queries return the following properties:

  • itemId The ID of an item.
  • itemType The type of an item.
 import Qt 4.7
 import QtMobility.gallery 1.1

 Rectangle {
     width: 1024
     height: 768

     GridView {
         anchors.fill: parent
         cellWidth: 128
         cellHeight: 128

         model: DocumentGalleryModel {
             rootType: DocumentGallery.Image
             properties: [ "url" ]
             filter: GalleryWildcardFilter {
                 property: "fileName";
                 value: "*.jpg";
             }
         }

         delegate: Image {
             source: url
             width: 128
             height: 128
         }
     }
 }

See also DocumentGalleryItem and DocumentGalleryType.

Property Documentation

autoUpdate : bool

This property holds whether a query should refresh its results automatically.

This property group was introduced in Mobility 1.1.


read-onlycount : int

This property holds the number of results returned by a query.

This property group was introduced in Mobility 1.1.


filter : GalleryFilter

This property contains criteria to used to filter the results of a query.

This property group was introduced in Mobility 1.1.


limit : int

This property contains the maximum number of items returned by a query.

This property group was introduced in Mobility 1.1.


offset : int

This property holds the offset of the first item returned by a query.

This property group was introduced in Mobility 1.1.


read-onlyprogress : real

This property holds the current progress of the request, from 0.0 (started) to 1.0 (finished).

This property group was introduced in Mobility 1.1.


properties : QStringList

This property holds the item properties a query should return values for. All supported properties are listed QDocumentGallery.

This property group was introduced in Mobility 1.1.


rootItem : variant

This property contains the id of an item that a query should return the descendants of.

This property group was introduced in Mobility 1.1.


rootType : enum

This property contains the type of item a query should return. It can be one of:

  • DocumentGallery.InvalidType
  • DocumentGallery.File
  • DocumentGallery.Folder
  • DocumentGallery.Document
  • DocumentGallery.Text
  • DocumentGallery.Audio
  • DocumentGallery.Image
  • DocumentGallery.Video
  • DocumentGallery.Playlist
  • DocumentGallery.Artist
  • DocumentGallery.AlbumArtist
  • DocumentGallery.Album
  • DocumentGallery.AudioGenre
  • DocumentGallery.PhotoAlbum

The default value is DocumentGallery.File

This property group was introduced in Mobility 1.1.


scope : enum

The property contains whether a query should count the direct descendants of the rootItem or all descendants.

This property group was introduced in Mobility 1.1.


sortProperties : QStringList

This property holds the properties the results of a query should be sorted on.

Prefixing a property name with the '+' character indicates it should be sorted in ascending order, and a '-' character prefix indicates a descending order. If there is no prefix ascending order is assumed.

This property group was introduced in Mobility 1.1.


read-onlystatus : enum

This property holds the status of a query. It can be one of:

  • Null No query parameters have been specified.
  • Active Items matching the query parameters are being fetched from the gallery.
  • Finished The query has finished
  • Idle The query is finished and will be automatically updated as new items become available.
  • Canceling The query was canceled but hasn't yet reached the canceled status.
  • Canceled The query was canceled.
  • Error Information about a type could not be retrieved due to an error.

This property group was introduced in Mobility 1.1.


Method Documentation

DocumentGalleryModel::cancel ()

Cancels an executing query.

This documentation was introduced in Mobility 1.1.


DocumentGalleryModel::clear ()

Clears the results of a query.

This documentation was introduced in Mobility 1.1.


DocumentGalleryModel::get ( int index )

Returns the result at index in a query model.

 query.get(0).title

This documentation was introduced in Mobility 1.1.


DocumentGalleryModel::property ( int index, string property )

Returns the value of property from the result at index.

 query.getProperty(0, "title")

This documentation was introduced in Mobility 1.1.


DocumentGalleryModel::reload ()

Re-queries the gallery.

This documentation was introduced in Mobility 1.1.


DocumentGalleryModel::set ( int index, jsobject dict )

Changes the item at index in the list model with the values in dict. Properties not appearing in dict are left unchanged.

This documentation was introduced in Mobility 1.1.


DocumentGalleryModel::setProperty ( int index, string property, variant value )

Changes the property of the result at index in a model to value.

 model.setProperty(0, "rating", 4)

This documentation was introduced in Mobility 1.1.


© 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.

All other trademarks are property of their respective owners. Privacy Policy


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.

Alternatively, this document may be used under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.