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 ()
void	setCurrentPage (const QString &name)

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

collection	The collection which properties should be shown.
parent	The parent widget.

Definition at line 169 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

collection	The collection which properties should be shown.
pages	The object names of the pages that shall be loaded.
parent	The parent widget.

Since

4.6

Definition at line 176 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 183 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

page	the desired page

Returns

the page's object name

Since

4.7

Definition at line 203 of file collectionpropertiesdialog.cpp.

void CollectionPropertiesDialog::registerPage ( CollectionPropertiesPageFactory *  factory )

static

Register custom pages for the collection properties dialog.

Parameters

factory

The properties page factory that provides the custom page.

See also

Akonadi::CollectionPropertiesPageFactory

Definition at line 190 of file collectionpropertiesdialog.cpp.

void CollectionPropertiesDialog::setCurrentPage

(

const QString &

name

)

Sets the page to be shown in the tab widget.

Parameters

name	The object name of the page that is to be shown.

Since

4.10

Definition at line 215 of file collectionpropertiesdialog.cpp.

void CollectionPropertiesDialog::useDefaultPage ( bool  use )

static

Sets whether to use default page or not.

Since

4.4

Parameters

use	mode of default page's usage

Definition at line 198 of file collectionpropertiesdialog.cpp.

---

The documentation for this class was generated from the following files:

• collectionpropertiesdialog.h
• collectionpropertiesdialog.cpp