• Skip to content
  • Skip to link menu
KDE 4.6 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • CollectionRequester
Public Slots | Signals | Public Member Functions
Akonadi::CollectionRequester Class Reference

A widget to request an Akonadi collection from the user. More...

#include <collectionrequester.h>

Inherits KHBox.

List of all members.

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 <kloecker@kde.org>
Since:
4.3

Definition at line 58 of file collectionrequester.h.


Constructor & Destructor Documentation

Akonadi::CollectionRequester::CollectionRequester ( QWidget *  parent = 0) [explicit]

Creates a collection requester.

Parameters:
parentThe parent widget.
Akonadi::CollectionRequester::CollectionRequester ( const Akonadi::Collection &  collection,
QWidget *  parent = 0 
) [explicit]

Creates a collection requester with an initial collection.

Parameters:
collectionThe initial collection.
parentThe parent widget.
Akonadi::CollectionRequester::~CollectionRequester ( )

Destroys the collection requester.


Member Function Documentation

Collection::Rights Akonadi::CollectionRequester::accessRightsFilter ( ) const

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

Since:
4.4
Akonadi::Collection Akonadi::CollectionRequester::collection ( ) const

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

void Akonadi::CollectionRequester::collectionChanged ( const Akonadi::Collection &  collection) [signal]

This signal is emitted when the selected collection has changed.

Parameters:
collectionThe selected collection.
Since:
4.5
QStringList Akonadi::CollectionRequester::mimeTypeFilter ( ) const

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

void Akonadi::CollectionRequester::setAccessRightsFilter ( Collection::Rights  rights)

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

Since:
4.4
void Akonadi::CollectionRequester::setCollection ( const Akonadi::Collection &  collection) [slot]

Sets the collection of the requester.

void Akonadi::CollectionRequester::setMimeTypeFilter ( const QStringList &  mimeTypes)

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


The documentation for this class was generated from the following file:
  • collectionrequester.h

akonadi

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • 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
Generated for KDE-PIM Libraries by doxygen 1.7.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal