• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

akonadi

Akonadi::CollectionRequester

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)

Public Member Functions

Akonadi::Collection collection () const
 CollectionRequester (const Akonadi::Collection &collection, QWidget *parent=0)
 CollectionRequester (QWidget *parent=0)
QStringList mimeTypeFilter () const
void setMimeTypeFilter (const QStringList &mimeTypes)
 ~CollectionRequester ()

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

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

Creates a collection requester.

Parameters:
parent The parent widget.

Definition at line 102 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 110 of file collectionrequester.cpp.

CollectionRequester::~CollectionRequester (  ) 

Destroys the collection requester.

Definition at line 119 of file collectionrequester.cpp.


Member Function Documentation

Collection CollectionRequester::collection (  )  const

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

Definition at line 125 of file collectionrequester.cpp.

QStringList CollectionRequester::mimeTypeFilter (  )  const

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

See also:
Akonadi::CollectionDialog::mimeTypeFilter()

Definition at line 143 of file collectionrequester.cpp.

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

Sets the collection of the requester.

Definition at line 131 of file collectionrequester.cpp.

void CollectionRequester::setMimeTypeFilter ( const QStringList &  mimeTypes  ) 

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

See also:
Akonadi::CollectionDialog::setMimeTypeFilter()

Definition at line 137 of file collectionrequester.cpp.


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

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
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.7
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