MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

QGalleryItemRequest Class Reference

The QGalleryItemRequest class provides a request for the properties of a single item from a gallery. More...

 #include <QGalleryItemRequest>

Inherits: QGalleryAbstractRequest.

This class was introduced in Qt Mobility 1.1.

Properties

Public Functions

QGalleryItemRequest ( QObject * parent = 0 )
QGalleryItemRequest ( QAbstractGallery * gallery, QObject * parent = 0 )
~QGalleryItemRequest ()
bool autoUpdate () const
bool isValid () const
QVariant itemId () const
QString itemType () const
QUrl itemUrl () const
QVariant metaData ( int key ) const
QVariant metaData ( const QString & property ) const
QGalleryProperty::Attributes propertyAttributes ( int key ) const
int propertyKey ( const QString & property ) const
QStringList propertyNames () const
QVariant::Type propertyType ( int key ) const
QList<QGalleryResource> resources () const
QGalleryResultSet * resultSet () const
void setAutoUpdate ( bool enabled )
void setItemId ( const QVariant & itemId )
bool setMetaData ( int key, const QVariant & value )
bool setMetaData ( const QString & property, const QVariant & value )
void setPropertyNames ( const QStringList & names )

Signals

void autoUpdateChanged ()
void itemChanged ()
void itemIdChanged ()
void metaDataChanged ( const QList<int> & keys )
void propertyNamesChanged ()
void resultSetChanged ( QGalleryResultSet * resultSet )

Reimplemented Protected Functions

virtual void setResponse ( QGalleryAbstractResponse * response )

Additional Inherited Members

Detailed Description

The QGalleryItemRequest class provides a request for the properties of a single item from a gallery.

QGalleryItemRequest executes a query which returns information about the gallery item specified in itemId. The query will return an itemUrl, an itemType, resources and meta-data values for the properties listed in propertyNames.

When the request has finished and if the item could be found the valid property will be true, if not it will be false.

If the autoUpdate property is true when the request is executed it will enter an Idle 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 Finished state. Automatic updates can be canceled by calling cancel() on a idle request.

See also QDocumentGallery.

Property Documentation

autoUpdate : bool

This property holds whether a the results of a request should be updated after a request has finished.

If this is true the request will go into the Idle state when the request has finished rather than returning to Inactive.

This property was introduced in Qt Mobility 1.1.

Access functions:

bool autoUpdate () const
void setAutoUpdate ( bool enabled )

Notifier signal:

void autoUpdateChanged ()

itemId : QVariant

This property holds the ID of an item the request should return the properties of.

This property was introduced in Qt Mobility 1.1.

Access functions:

QVariant itemId () const
void setItemId ( const QVariant & itemId )

Notifier signal:

void itemIdChanged ()

itemType : const QString

This property holds the type of an item.

This property was introduced in Qt Mobility 1.1.

Access functions:

QString itemType () const

Notifier signal:

void itemChanged ()

itemUrl : const QUrl

This property holds the URL of an item.

This property was introduced in Qt Mobility 1.1.

Access functions:

QUrl itemUrl () const

Notifier signal:

void itemChanged ()

propertyNames : QStringList

This property holds a list of names of meta-data properties a request should return values for.

This property was introduced in Qt Mobility 1.1.

Access functions:

QStringList propertyNames () const
void setPropertyNames ( const QStringList & names )

Notifier signal:

void propertyNamesChanged ()

resources : const QList<QGalleryResource>

This property holds the resources of an item.

This property was introduced in Qt Mobility 1.1.

Access functions:

QList<QGalleryResource> resources () const

Notifier signal:

void itemChanged ()

valid : const bool

This property holds whether the request currently holds valid type information.

This property was introduced in Qt Mobility 1.1.

Access functions:

bool isValid () const

Notifier signal:

void itemChanged ()

Member Function Documentation

QGalleryItemRequest::QGalleryItemRequest ( QObject * parent = 0 )

Constructs a new gallery item request.

The parent is passed to QObject.

QGalleryItemRequest::QGalleryItemRequest ( QAbstractGallery * gallery, QObject * parent = 0 )

Contructs a new item request for the given gallery.

The parent is passed to QObject.

This function was introduced in Qt Mobility 1.1.

QGalleryItemRequest::~QGalleryItemRequest ()

Destroys a gallery item request.

void QGalleryItemRequest::autoUpdateChanged () [signal]

Signals that the value of autoUpdate has changed.

This function was introduced in Qt Mobility 1.1.

void QGalleryItemRequest::itemChanged () [signal]

Signals that the properties of an item have changed.

This function was introduced in Qt Mobility 1.1.

void QGalleryItemRequest::itemIdChanged () [signal]

Signals that the value of the itemId property has changed.

This function was introduced in Qt Mobility 1.1.

QVariant QGalleryItemRequest::metaData ( int key ) const

Returns the value of a meta-data property identified by key.

This function was introduced in Qt Mobility 1.1.

See also setMetaData().

QVariant QGalleryItemRequest::metaData ( const QString & property ) const

Returns the value of a meta-data property.

This function was introduced in Qt Mobility 1.1.

void QGalleryItemRequest::metaDataChanged ( const QList<int> & keys ) [signal]

Signals that the values of meta-data properties identified by keys have changed.

This function was introduced in Qt Mobility 1.1.

QGalleryProperty::Attributes QGalleryItemRequest::propertyAttributes ( int key ) const

Returns the attributes of the property identified by key.

This function was introduced in Qt Mobility 1.1.

int QGalleryItemRequest::propertyKey ( const QString & property ) const

Returns the key of property.

This function was introduced in Qt Mobility 1.1.

void QGalleryItemRequest::propertyNamesChanged () [signal]

Signals that the value of propertyNames has changed.

This function was introduced in Qt Mobility 1.1.

QVariant::Type QGalleryItemRequest::propertyType ( int key ) const

Returns the type of the property identified by key.

This function was introduced in Qt Mobility 1.1.

QGalleryResultSet * QGalleryItemRequest::resultSet () const

Returns the result set containing the meta-data of a type.

This function was introduced in Qt Mobility 1.1.

void QGalleryItemRequest::resultSetChanged ( QGalleryResultSet * resultSet ) [signal]

Signals that the resultSet containing the meta-data of an item has changed.

This function was introduced in Qt Mobility 1.1.

bool QGalleryItemRequest::setMetaData ( int key, const QVariant & value )

Sets the value of a meta-data property identified by key.

Returns true if the value was changed; otherwise returns false.

This function was introduced in Qt Mobility 1.1.

See also metaData().

bool QGalleryItemRequest::setMetaData ( const QString & property, const QVariant & value )

Sets the

Constant Value Description
QGalleryItemRequest::of ? a meta-data property.

Returns true if the value was changed; otherwise returns false.

This function was introduced in Qt Mobility 1.1.

void QGalleryItemRequest::setResponse ( QGalleryAbstractResponse * response ) [virtual protected]

Reimplemented from QGalleryAbstractRequest::setResponse().

This function was introduced in Qt Mobility 1.1.