akonadi
#include <collectionpropertiespage.h>

Public Member Functions | |
CollectionPropertiesPage (QWidget *parent=0) | |
~CollectionPropertiesPage () | |
virtual bool | canHandle (const Collection &collection) const |
virtual void | load (const Collection &collection)=0 |
QString | pageTitle () const |
virtual void | save (Collection &collection)=0 |
void | setPageTitle (const QString &title) |
Detailed Description
A single page in a collection properties dialog.
The collection properties dialog can be extended by custom collection properties pages, which provide gui elements for viewing and changing collection attributes.
The following example shows how to create a simple collection properties page for the secrecy attribute from the Akonadi::Attribute example.
Definition at line 99 of file collectionpropertiespage.h.
Constructor & Destructor Documentation
|
explicit |
Creates a new collection properties page.
- Parameters
-
parent The parent widget.
Definition at line 37 of file collectionpropertiespage.cpp.
CollectionPropertiesPage::~CollectionPropertiesPage | ( | ) |
Destroys the collection properties page.
Definition at line 43 of file collectionpropertiespage.cpp.
Member Function Documentation
|
virtual |
Checks if this page can actually handle the given collection.
Returns true
if the collection can be handled, false
otherwise The default implementation returns always true
. When false
is returned this page is not shown in the properties dialog.
- Parameters
-
collection The collection to check.
Reimplemented in Akonadi::CachePolicyPage.
Definition at line 48 of file collectionpropertiespage.cpp.
|
pure virtual |
Loads the page content from the given collection.
- Parameters
-
collection The collection to load.
Implemented in Akonadi::CachePolicyPage.
QString Akonadi::CollectionPropertiesPage::pageTitle | ( | ) | const |
Returns the page title.
Definition at line 53 of file collectionpropertiespage.cpp.
|
pure virtual |
Saves page content to the given collection.
- Parameters
-
collection Reference to the collection to save to.
Implemented in Akonadi::CachePolicyPage.
void CollectionPropertiesPage::setPageTitle | ( | const QString & | title | ) |
Sets the page title.
- Parameters
-
title Translated, preferbly short tab title.
Definition at line 58 of file collectionpropertiespage.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:27:47 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.