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

akonadi

  • Akonadi
  • CollectionPropertiesDialog
Public Member Functions | Static Public Member Functions

Akonadi::CollectionPropertiesDialog Class Reference

A generic and extensible dialog for collection properties. More...

#include <collectionpropertiesdialog.h>

Inherits KDialog.

List of all members.

Public Member Functions

 CollectionPropertiesDialog (const Collection &collection, QWidget *parent=0)
 CollectionPropertiesDialog (const Collection &collection, const QStringList &pages, QWidget *parent=0)
 ~CollectionPropertiesDialog ()

Static Public Member Functions

static void registerPage (CollectionPropertiesPageFactory *factory)
static void useDefaultPage (bool use)

Detailed Description

A generic and extensible dialog for collection properties.

This dialog allows you to show or modify the properties of a collection.

 Akonadi::Collection collection = ...

 CollectionPropertiesDialog dlg( collection, this );
 dlg.exec();

It can be extended by custom pages, which contains gui elements for custom properties.

See also:
Akonadi::CollectionPropertiesPage
Author:
Volker Krause <vkrause@kde.org>

Definition at line 54 of file collectionpropertiesdialog.h.


Constructor & Destructor Documentation

Akonadi::CollectionPropertiesDialog::CollectionPropertiesDialog ( const Collection &  collection,
QWidget *  parent = 0 
) [explicit]

Creates a new collection properties dialog.

Parameters:
collectionThe collection which properties should be shown.
parentThe parent widget.
Akonadi::CollectionPropertiesDialog::CollectionPropertiesDialog ( const Collection &  collection,
const QStringList &  pages,
QWidget *  parent = 0 
)

Creates a new collection properties dialog.

This constructor allows to specify the subset of registered pages that will be shown as well as their order. The pages have to set an objectName in their constructor to make it work. If an empty list is passed, all registered pages will be loaded.

Parameters:
collectionThe collection which properties should be shown.
pagesThe object names of the pages that shall be loaded.
parentThe parent widget.
Since:
4.6
Akonadi::CollectionPropertiesDialog::~CollectionPropertiesDialog ( )

Destroys the collection properties dialog.

Note:
Never call manually, the dialog is deleted automatically once all changes are written back to the Akonadi storage.

Member Function Documentation

static void Akonadi::CollectionPropertiesDialog::registerPage ( CollectionPropertiesPageFactory *  factory) [static]

Register custom pages for the collection properties dialog.

Parameters:
factoryThe properties page factory that provides the custom page.
See also:
Akonadi::CollectionPropertiesPageFactory
static void Akonadi::CollectionPropertiesDialog::useDefaultPage ( bool  use) [static]

Sets whether to use default page or not.

Since:
4.4

The documentation for this class was generated from the following file:
  • collectionpropertiesdialog.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.3
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