akonadi
Akonadi::CollectionComboBox Class Reference
A combobox for selecting an Akonadi collection. More...
#include <collectioncombobox.h>
Inherits KComboBox.
Signals | |
void | currentChanged (const Akonadi::Collection &collection) |
Public Member Functions | |
CollectionComboBox (QWidget *parent=0) | |
CollectionComboBox (QAbstractItemModel *model, QWidget *parent=0) | |
~CollectionComboBox () | |
Collection::Rights | accessRightsFilter () const |
Akonadi::Collection | currentCollection () const |
QStringList | mimeTypeFilter () const |
void | setAccessRightsFilter (Collection::Rights rights) |
void | setDefaultCollection (const Collection &collection) |
void | setMimeTypeFilter (const QStringList &mimetypes) |
Detailed Description
A combobox for selecting an Akonadi collection.
This widget provides a combobox to select a collection from the Akonadi storage. The available collections can be filtered by mime type and access rights.
Example:
using namespace Akonadi; QStringList contentMimeTypes; contentMimeTypes << KABC::Addressee::mimeType(); contentMimeTypes << KABC::ContactGroup::mimeType(); CollectionComboBox *box = new CollectionComboBox( this ); box->setMimeTypeFilter( contentMimeTypes ); box->setAccessRightsFilter( Collection::CanCreateItem ); ... const Collection collection = box->currentCollection();
- Since:
- 4.4
Definition at line 62 of file collectioncombobox.h.
Constructor & Destructor Documentation
Akonadi::CollectionComboBox::CollectionComboBox | ( | QWidget * | parent = 0 | ) | [explicit] |
Creates a new collection combobox.
- Parameters:
-
parent The parent widget.
Akonadi::CollectionComboBox::CollectionComboBox | ( | QAbstractItemModel * | model, |
QWidget * | parent = 0 |
||
) | [explicit] |
Creates a new collection combobox with a custom model
.
The filtering by content mime type and access rights is done on top of the custom model.
- Parameters:
-
model The custom model to use. parent The parent widget.
Akonadi::CollectionComboBox::~CollectionComboBox | ( | ) |
Destroys the collection combobox.
Member Function Documentation
Collection::Rights Akonadi::CollectionComboBox::accessRightsFilter | ( | ) | const |
Returns the access rights the collections are filtered by.
void Akonadi::CollectionComboBox::currentChanged | ( | const Akonadi::Collection & | collection | ) | [signal] |
This signal is emitted whenever the current selection has been changed.
- Parameters:
-
collection The current selection.
Akonadi::Collection Akonadi::CollectionComboBox::currentCollection | ( | ) | const |
Returns the current selection.
QStringList Akonadi::CollectionComboBox::mimeTypeFilter | ( | ) | const |
Returns the content mimetype the collections are filtered by.
Don't assume this list has the original order.
void Akonadi::CollectionComboBox::setAccessRightsFilter | ( | Collection::Rights | rights | ) |
Sets the access rights
the collections shall be filtered by.
void Akonadi::CollectionComboBox::setDefaultCollection | ( | const Collection & | collection | ) |
Sets the collection
that shall be selected by default.
void Akonadi::CollectionComboBox::setMimeTypeFilter | ( | const QStringList & | mimetypes | ) |
Sets the content mimetypes
the collections shall be filtered by.
The documentation for this class was generated from the following file: