• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.8.3 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • CollectionComboBox
Signals | Public Member Functions
Akonadi::CollectionComboBox Class Reference

#include <collectioncombobox.h>

Inherits KComboBox.

List of all members.

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();
Author:
Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org
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:
parentThe 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:
modelThe custom model to use.
parentThe 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:
collectionThe 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:
  • collectioncombobox.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon Apr 30 2012 21:49:16 by doxygen 1.8.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs-4.8.3 API Reference

Skip menu "kdepimlibs-4.8.3 API Reference"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal