Akonadi::CollectionComboBox Class Reference

#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
bool	excludeVirtualCollections () const
QStringList	mimeTypeFilter () const
void	setAccessRightsFilter (Collection::Rights rights)
void	setDefaultCollection (const Collection &collection)
void	setExcludeVirtualCollections (bool b)
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();

Author

Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org

Since

4.4

Definition at line 62 of file collectioncombobox.h.

Constructor & Destructor Documentation

CollectionComboBox::CollectionComboBox ( QWidget *  parent = 0 )

explicit

Creates a new collection combobox.

Parameters

parent

The parent widget.

Definition at line 158 of file collectioncombobox.cpp.

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.

Definition at line 168 of file collectioncombobox.cpp.

CollectionComboBox::~CollectionComboBox

(

)

Destroys the collection combobox.

Definition at line 178 of file collectioncombobox.cpp.

Member Function Documentation

Akonadi::Collection::Rights CollectionComboBox::accessRightsFilter

(

)

const

Returns the access rights the collections are filtered by.

Definition at line 205 of file collectioncombobox.cpp.

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 CollectionComboBox::currentCollection

(

)

const

Returns the current selection.

Definition at line 215 of file collectioncombobox.cpp.

bool CollectionComboBox::excludeVirtualCollections

(

)

const

Since

4.12

Definition at line 230 of file collectioncombobox.cpp.

QStringList CollectionComboBox::mimeTypeFilter

(

)

const

Returns the content mimetype the collections are filtered by.

Don't assume this list has the original order.

Definition at line 195 of file collectioncombobox.cpp.

void CollectionComboBox::setAccessRightsFilter

(

Collection::Rights

rights

)

Sets the access rights the collections shall be filtered by.

Definition at line 200 of file collectioncombobox.cpp.

void CollectionComboBox::setDefaultCollection

(

const Collection &

collection

)

Sets the collection that shall be selected by default.

Definition at line 210 of file collectioncombobox.cpp.

void CollectionComboBox::setExcludeVirtualCollections

(

bool

b

)

Since

4.12

Definition at line 225 of file collectioncombobox.cpp.

void CollectionComboBox::setMimeTypeFilter

(

const QStringList &

mimetypes

)

Sets the content mimetypes the collections shall be filtered by.

Definition at line 183 of file collectioncombobox.cpp.

---

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

• collectioncombobox.h
• collectioncombobox.cpp