Akonadi::CachePolicyPage Class

A page in a collection properties dialog to configure the cache policy. More...

Header: #include <Akonadi/CachePolicyPage>
CMake: find_package(KPim6 REQUIRED COMPONENTS AkonadiWidgets)
target_link_libraries(mytarget PRIVATE KPim6::AkonadiWidgets)
Inherits: Akonadi::CollectionPropertiesPage

Public Types

enum GuiMode { UserMode, AdvancedMode }

Public Functions

CachePolicyPage(QWidget *parent, Akonadi::CachePolicyPage::GuiMode mode = UserMode)
virtual ~CachePolicyPage() override

Reimplemented Public Functions

virtual bool canHandle(const Akonadi::Collection &collection) const override
virtual void load(const Akonadi::Collection &collection) override
virtual void save(Akonadi::Collection &collection) override

Detailed Description

This page allows the user to fine tune the cache policy of a collection in the Akonadi storage. It provides two modes, a UserMode and an AdvancedMode. While the former should be used in end-user applications, the latter can be used in debugging tools.

Author: Till Adam <adam@kde.org>

See also Akonadi::CollectionPropertiesDialog and Akonadi::CollectionPropertiesPageFactory.

Member Type Documentation

enum CachePolicyPage::GuiMode

Describes the mode of the cache policy page.

Member Function Documentation

[explicit] CachePolicyPage::CachePolicyPage(QWidget *parent, Akonadi::CachePolicyPage::GuiMode mode = UserMode)

Creates a new cache policy page.

parent The parent widget. mode The UI mode that will be used for the page.

[override virtual noexcept] CachePolicyPage::~CachePolicyPage()

Destroys the cache policy page.

[override virtual] bool CachePolicyPage::canHandle(const Akonadi::Collection &collection) const

Reimplements: CollectionPropertiesPage::canHandle(const Akonadi::Collection &collection) const.

Checks if the cache policy page can actually handle the given collection.

[override virtual] void CachePolicyPage::load(const Akonadi::Collection &collection)

Reimplements: CollectionPropertiesPage::load(const Akonadi::Collection &collection).

Loads the page content from the given collection.

[override virtual] void CachePolicyPage::save(Akonadi::Collection &collection)

Reimplements: CollectionPropertiesPage::save(Akonadi::Collection &collection).

Saves page content to the given collection.