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, const QStringList &pages, QWidget *parent=0)
	CollectionPropertiesDialog (const Collection &collection, 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:

	collection	The collection which properties should be shown.
	parent	The 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:

	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

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:

factory

The 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