Akonadi::CollectionRequester Class Reference

#include <collectionrequester.h>

Inherits KHBox.

Public Slots
void	setCollection (const Akonadi::Collection &collection)

Signals
void	collectionChanged (const Akonadi::Collection &collection)

Public Member Functions
	CollectionRequester (QWidget *parent=0)
	CollectionRequester (const Akonadi::Collection &collection, QWidget *parent=0)
	~CollectionRequester ()
Collection::Rights	accessRightsFilter () const
void	changeCollectionDialogOptions (CollectionDialog::CollectionDialogOptions options)
Akonadi::Collection	collection () const
QStringList	mimeTypeFilter () const
void	setAccessRightsFilter (Collection::Rights rights)
void	setMimeTypeFilter (const QStringList &mimeTypes)

Detailed Description

A widget to request an Akonadi collection from the user.

This class is a widget showing a read-only lineedit displaying the currently chosen collection and a button invoking a dialog for choosing a collection.

Example:

// create a collection requester to select a collection of contacts
Akonadi::CollectionRequester requester( Akonadi::Collection::root(), this );
requester.setMimeTypeFilter( QStringList() << QString( "text/directory" ) );

...

const Akonadi::Collection collection = requester.collection();
if ( collection.isValid() ) {
  ...
}

Author

Ingo Klöcker kloec.nosp@m.ker@.nosp@m.kde.o.nosp@m.rg

Since

4.3

Definition at line 58 of file collectionrequester.h.

Constructor & Destructor Documentation

CollectionRequester::CollectionRequester ( QWidget *  parent = 0 )

explicit

Creates a collection requester.

Parameters

parent

The parent widget.

Definition at line 136 of file collectionrequester.cpp.

CollectionRequester::CollectionRequester ( const Akonadi::Collection &  collection, QWidget *  parent = 0  )

explicit

Creates a collection requester with an initial collection.

Parameters

collection	The initial collection.
parent	The parent widget.

Definition at line 143 of file collectionrequester.cpp.

CollectionRequester::~CollectionRequester

(

)

Destroys the collection requester.

Definition at line 151 of file collectionrequester.cpp.

Member Function Documentation

Collection::Rights CollectionRequester::accessRightsFilter

(

)

const

Returns the access rights that the listed collections shall match with.

Since

4.4

Definition at line 198 of file collectionrequester.cpp.

void CollectionRequester::changeCollectionDialogOptions

(

CollectionDialog::CollectionDialogOptions

options

)

Parameters

options

new collection dialog options

Definition at line 207 of file collectionrequester.cpp.

Collection CollectionRequester::collection

(

)

const

Returns the currently chosen collection, or an empty collection if none none was chosen.

Definition at line 156 of file collectionrequester.cpp.

void Akonadi::CollectionRequester::collectionChanged ( const Akonadi::Collection &  collection )

signal

This signal is emitted when the selected collection has changed.

Parameters

collection

The selected collection.

Since

4.5

QStringList CollectionRequester::mimeTypeFilter

(

)

const

Returns the mime types any of which the selected collection shall support.

Definition at line 182 of file collectionrequester.cpp.

void CollectionRequester::setAccessRightsFilter

(

Collection::Rights

rights

)

Sets the access rights that the listed collections shall match with.

Parameters

rights

the access rights to set

Since

4.4

Definition at line 191 of file collectionrequester.cpp.

void CollectionRequester::setCollection ( const Akonadi::Collection &  collection )

slot

Sets the collection of the requester.

Definition at line 161 of file collectionrequester.cpp.

void CollectionRequester::setMimeTypeFilter

(

const QStringList &

mimeTypes

)

Sets the mime types any of which the selected collection shall support.

Definition at line 175 of file collectionrequester.cpp.

---

The documentation for this class was generated from the following files:

• collectionrequester.h
• collectionrequester.cpp