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

akonadi

  • Akonadi
  • CollectionPropertiesDialog
Public Types | Public Member Functions | Static Public Member Functions
Akonadi::CollectionPropertiesDialog Class Reference

#include <collectionpropertiesdialog.h>

Inherits KDialog.

List of all members.

Public Types

enum  DefaultPage { GeneralPage, CachePage }

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 QString defaultPageObjectName (DefaultPage page)
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>

Member Enumeration Documentation

enum Akonadi::CollectionPropertiesDialog::DefaultPage

Enumerates the registered default pages which can be displayed.

Since:
4.7
Enumerator:
GeneralPage 

General properties page.

CachePage 

Cache properties page.

Definition at line 63 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. Use defaultPageObjectName() to fetch the object name for a registered default page.

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 QString Akonadi::CollectionPropertiesDialog::defaultPageObjectName ( DefaultPage  page) [static]

Returns the object name of one of the dialog's registered default pages.

The object name may be used in the QStringList constructor parameter to specify which default pages should be shown.

Parameters:
pagethe desired page
Returns:
the page's object name
Since:
4.7
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
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • 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.5
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