MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

QGalleryTypeRequest Class Reference

The QGalleryTypeRequest class provides an interface for requesting the properties of a type from a gallery. More...

 #include <QGalleryTypeRequest>

Inherits: QGalleryAbstractRequest.

This class was introduced in Qt Mobility 1.1.

Properties

Public Functions

QGalleryTypeRequest ( QObject * parent = 0 )
QGalleryTypeRequest ( QAbstractGallery * gallery, QObject * parent = 0 )
~QGalleryTypeRequest ()
bool autoUpdate () const
bool isValid () const
QString itemType () 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
QGalleryResultSet * resultSet () const
void setAutoUpdate ( bool enabled )
void setItemType ( const QString & itemType )
void setPropertyNames ( const QStringList & names )

Signals

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

Reimplemented Protected Functions

virtual void setResponse ( QGalleryAbstractResponse * response )

Additional Inherited Members

Detailed Description

The QGalleryTypeRequest class provides an interface for requesting the properties of a type from a gallery.

QGalleryItemRequest executes a query which returns information summarizing items of the type specified in itemType. The query will return meta-data values which describe the type as a whole such as the total number of items of that type.

When the request has finished and if the type is one recognized by the gallery 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 type 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 ()

itemType : QString

This property holds the type a request should return the properties of.

This property was introduced in Qt Mobility 1.1.

Access functions:

QString itemType () const
void setItemType ( const QString & itemType )

Notifier signal:

void itemTypeChanged ()

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 ()

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 typeChanged ()

Member Function Documentation

QGalleryTypeRequest::QGalleryTypeRequest ( QObject * parent = 0 )

Constructs a new gallery type request.

The parent is passed to QObject.

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

Contructs a new type request for the given gallery.

The parent is passed to QObject.

QGalleryTypeRequest::~QGalleryTypeRequest ()

Destroys a gallery type request.

void QGalleryTypeRequest::autoUpdateChanged () [signal]

Signals that the value of autoUpdate has changed.

This function was introduced in Qt Mobility 1.1.

void QGalleryTypeRequest::itemTypeChanged () [signal]

Signals that the itemType property has changed.

This function was introduced in Qt Mobility 1.1.

QVariant QGalleryTypeRequest::metaData ( int key ) const

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

This function was introduced in Qt Mobility 1.1.

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

Returns the value of a meta-data property.

This function was introduced in Qt Mobility 1.1.

void QGalleryTypeRequest::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 QGalleryTypeRequest::propertyAttributes ( int key ) const

Returns the attributes of the property identified by key.

This function was introduced in Qt Mobility 1.1.

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

Returns the key of property.

This function was introduced in Qt Mobility 1.1.

void QGalleryTypeRequest::propertyNamesChanged () [signal]

Signals that the value of propertyNames has changed.

This function was introduced in Qt Mobility 1.1.

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

Returns the type of the property identified by key.

This function was introduced in Qt Mobility 1.1.

QGalleryResultSet * QGalleryTypeRequest::resultSet () const

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

This function was introduced in Qt Mobility 1.1.

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

Signals that the resultSet containing the meta-data of a type has changed.

This function was introduced in Qt Mobility 1.1.

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

Reimplemented from QGalleryAbstractRequest::setResponse().

This function was introduced in Qt Mobility 1.1.

void QGalleryTypeRequest::typeChanged () [signal]

Signals that the properties of a type have changed.

This function was introduced in Qt Mobility 1.1.