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

akonadi

  • Akonadi
  • CollectionPropertiesDialog
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Akonadi::CollectionPropertiesDialog Class Reference

#include <collectionpropertiesdialog.h>

Inherits KDialog.

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 vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

Definition at line 54 of file collectionpropertiesdialog.h.

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

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.

Definition at line 146 of file collectionpropertiesdialog.cpp.

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

Definition at line 153 of file collectionpropertiesdialog.cpp.

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.

Definition at line 160 of file collectionpropertiesdialog.cpp.

Member Function Documentation

QString 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

Definition at line 177 of file collectionpropertiesdialog.cpp.

void 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

Definition at line 165 of file collectionpropertiesdialog.cpp.

void CollectionPropertiesDialog::useDefaultPage ( bool  use)
static

Sets whether to use default page or not.

Since
4.4

Definition at line 172 of file collectionpropertiesdialog.cpp.


The documentation for this class was generated from the following files:
  • collectionpropertiesdialog.h
  • collectionpropertiesdialog.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon Dec 10 2012 13:48:12 by doxygen 1.8.1.2 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.9.4 API Reference

Skip menu "kdepimlibs-4.9.4 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