QImageDocumentSelectorDialog Class Reference
[QtBaseModule]

Detailed Description

The QImageDocumentSelectorDialog class allows the user to select an image from a list of image documents available on the device.

QImageDocumentSelectorDialog is a convenience class that presents the QImageDocumentSelector widget in a dialog.

The following code uses QImageDocumentSelectorDialog to allow the user to select a picture taken by the camera:

    QImageDocumentSelectorDialog dialog( this );

    dialog.setFilter( QContentFilter::category( "Camera" ) );

    if( QtopiaApplication::execDialog( &dialog ) ) {
        // Accept
        QContent picture = dialog.selectedDocument();
    } else {
        // Reject
    }

See also QImageDocumentSelector, QDocumentSelector, and QDocumentSelectorDialog.

Member Function Documentation

QImageDocumentSelectorDialog::QImageDocumentSelectorDialog ( QWidget * parent = 0 )

Construct an image document selector the given parent.

The dialog lists all documents with the image mime type. The dialog is modal by default.

QImageDocumentSelectorDialog::~QImageDocumentSelectorDialog ()

Destroys the widget.

QStringList QImageDocumentSelectorDialog::defaultCategories () const

Returns the categories checked by default in the document selector's category filter dialog.

See also setDefaultCategories().

const QContentSet & QImageDocumentSelectorDialog::documents () const

Returns the content set of image documents listed by the selector.

See also selectedDocument().

QContentFilter QImageDocumentSelectorDialog::filter () const

Returns the current documents filter.

The filter defines the subset of image documents on the device the user can select from.

See also setFilter() and QContentSet::filter().

QDrmRights::Permissions QImageDocumentSelectorDialog::mandatoryPermissions () const

Returns the permissions a document must have in order to be choosable by the document selector.

See also setMandatoryPermissions(), setSelectPermission(), and selectPermission().

QDrmRights::Permission QImageDocumentSelectorDialog::selectPermission () const

Returns the permissions a document should give in order to be choosable.

The permissions effectively describe the document's intended usage.

See also setSelectPermission(), mandatoryPermissions(), and setMandatoryPermissions().

QContent QImageDocumentSelectorDialog::selectedDocument () const

Returns a QContent for the currently selected image, or an invalid QContent if there is no current selection.

See also documents().

void QImageDocumentSelectorDialog::setDefaultCategories ( const QStringList & categories )

Sets the categories checked by default in the document selector's category filter dialog.

If a supplied category does not match those available in the category filter dialog, the document selector will not filter with that category. Upon invocation this function will set the default checked categories within the category filter dialog, and filter according to the supplied categories. Note: Once the dialog has been shown once, this function no longer has any effect.

Filtering according to categories is applied after the filter defined by filter()

See also defaultCategories(), filter(), and setFilter().

void QImageDocumentSelectorDialog::setFilter ( const QContentFilter & filter )

Sets the filter which defines the subset of image documents on the device the user can select from.

See also filter() and QContentSet::filter().

void QImageDocumentSelectorDialog::setMandatoryPermissions ( QDrmRights::Permissions permissions )

Sets the permissions a document must have in order to be choosable from the document selector.

Unlike select permissions, if a document is missing a mandatory permission it will not be activated, and the document cannot be chosen.

Because the permissions are mandatory, passing QDrmRights::InvalidPermission as a parameter does not exhibit the same behavior as in setSelectPermission().

See also mandatoryPermissions(), setSelectPermission(), and selectPermission().

void QImageDocumentSelectorDialog::setSelectPermission ( QDrmRights::Permission permission )

Sets the permission a document should give in order to be choosable. The permissions effectively specify the intended usage for that document.

If a document does not have provide the given permission, the document selector will try to activate and thus acquire permissions for the document. If the document cannot be activated with that permission, it will not be choosable from the list and visual indication of this is given.

If the permission is QDrmRights::InvalidPermission the default permissions for the document is used.

See also selectPermission(), setMandatoryPermissions(), and mandatoryPermissions().

void QImageDocumentSelectorDialog::setSortCriteria ( const QContentSortCriteria & sort )

Sets the document sort criteria.

This will set the document selector sort mode to SortCriteria.

See also sortCriteria() and setSortMode().

void QImageDocumentSelectorDialog::setSortMode ( QDocumentSelector::SortMode sortMode )

Sets the document sortMode.

The default mode is QDocumentSelector::Alphabetical.

See also sortMode().

void QImageDocumentSelectorDialog::setThumbnailSize ( const QSize & size )

Sets the maximum size of a thumbnail.

The default size is QSize( 65, 65 ).

See also thumbnailSize().

QContentSortCriteria QImageDocumentSelectorDialog::sortCriteria () const

Returns the current document sort criteria.

See also setSortCriteria().

QDocumentSelector::SortMode QImageDocumentSelectorDialog::sortMode () const

Returns current document sort mode.

See also setSortMode().

QSize QImageDocumentSelectorDialog::thumbnailSize () const

Returns the current maximum size of a thumbnail.

See also setThumbnailSize().