Qt Mobility Reference Documentation

QGalleryQueryRequest Class Reference

The QGalleryQueryRequest class provides a request for a set of items from a gallery. More...

 #include <QGalleryQueryRequest>

Inherits QGalleryAbstractRequest.


Properties


Public Functions

QGalleryQueryRequest ( QObject * parent = 0 )
QGalleryQueryRequest ( QAbstractGallery * gallery, QObject * parent = 0 )
~QGalleryQueryRequest ()
QGalleryFilter filter () const
int initialCursorPosition () const
bool isLive () const
QString itemType () const
QGalleryItemList * items () const
int minimumPagedItems () const
QStringList propertyNames () const
QGalleryAbstractRequest::Scope scope () const
QVariant scopeItemId () const
void setFilter ( const QGalleryFilter & filter )
void setInitialCursorPosition ( int index )
void setItemType ( const QString & type )
void setLive ( bool live )
void setMinimumPagedItems ( int size )
void setPropertyNames ( const QStringList & names )
void setScope ( QGalleryAbstractRequest::Scope scope )
void setScopeItemId ( const QVariant & id )
void setSortPropertyNames ( const QStringList & names )
QStringList sortPropertyNames () const

Signals

void itemsChanged ( QGalleryItemList * items )

Reimplemented Protected Functions

virtual void setResponse ( QGalleryAbstractResponse * response )

Additional Inherited Members


Detailed Description

The QGalleryQueryRequest class provides a request for a set of items from a gallery.


Property Documentation

filter : QGalleryFilter

This property holds a filter identifying the items a request should return.

If no filter is set the results of the request will be determined by the itemType and scopeItemId properties.

Access functions:

QGalleryFilter filter () const
void setFilter ( const QGalleryFilter & filter )

initialCursorPosition : int

This property holds the index of the first item a request should return.

By default this is 0.

Access functions:

int initialCursorPosition () const
void setInitialCursorPosition ( int index )

itemType : QString

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

Access functions:

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

items : QGalleryItemList * const

This property holds the items returned by a request.

Access functions:

QGalleryItemList * items () const

Notifier signal:

void itemsChanged ( QGalleryItemList * items )

live : 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.

Access functions:

bool isLive () const
void setLive ( bool live )

minimumPagedItems : int

This property holds the minimum number of consecutive items the list returned by a request should cache.

By default this is 200.

Access functions:

int minimumPagedItems () const
void setMinimumPagedItems ( int size )

propertyNames : QStringList

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

Access functions:

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

scope : QGalleryAbstractRequest::Scope

This property holds whether all descendants of the scopeItemId should be returned by a request or just the direct descendants.

Access functions:

QGalleryAbstractRequest::Scope scope () const
void setScope ( QGalleryAbstractRequest::Scope scope )

scopeItemId : QVariant

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

Access functions:

QVariant scopeItemId () const
void setScopeItemId ( const QVariant & id )

See also scope.

sortPropertyNames : QStringList

This property holds a list of names of meta-data properties a request should sort its results 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.

Access functions:

QStringList sortPropertyNames () const
void setSortPropertyNames ( const QStringList & names )

Member Function Documentation

QGalleryQueryRequest::QGalleryQueryRequest ( QObject * parent = 0 )

Constructs a new gallery query request.

The parent is passed to QObject.

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

Contructs a new query request for the given gallery.

The parent is passed to QObject.

QGalleryQueryRequest::~QGalleryQueryRequest ()

Destroys a gallery query request.

void QGalleryQueryRequest::itemsChanged ( QGalleryItemList * items ) [signal]

Signals that the list of items returned by a request has changed.

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

Reimplemented from QGalleryAbstractRequest::setResponse().


Copyright © 2009-2010 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt Mobility Project 1.1.0