MailCommon::CollectionExpiryWidget Class

class MailCommon::CollectionExpiryWidget

The CollectionExpiryWidget class. More...

Header: #include <MailCommon/CollectionExpiryWidget>
CMake: find_package(KPim6MailCommon REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::MailCommon)
Inherits: QWidget

Public Functions

CollectionExpiryWidget(QWidget *parent = nullptr)
virtual ~CollectionExpiryWidget() override
void hideExpireNowButton()
void load(const MailCommon::CollectionExpirySettings &settings)
void save(Akonadi::Collection &collection, bool saveSettings, bool expireNow)
void save(const MailCommon::CollectionExpirySettings &collectionExpirySettings, Akonadi::Collection &collection, bool saveSettings, bool expireNow)
MailCommon::CollectionExpirySettings settings() const

Signals

void configChanged(bool changed = true)
void saveAndExpireRequested()

Static Public Members

bool canHandle(const Akonadi::Collection &col)

Detailed Description

Member Function Documentation

[explicit] CollectionExpiryWidget::CollectionExpiryWidget(QWidget *parent = nullptr)

Constructs the expiry widget with the given parent.

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

Destroys the expiry widget.

[static] bool CollectionExpiryWidget::canHandle(const Akonadi::Collection &col)

Returns true if expiry can be configured for the collection col.

[signal] void CollectionExpiryWidget::configChanged(bool changed = true)

Emitted when the configuration changes; changed tells whether it differs from the saved one.

void CollectionExpiryWidget::hideExpireNowButton()

Hides the "Save Settings and Expire Now" button.

void CollectionExpiryWidget::load(const MailCommon::CollectionExpirySettings &settings)

Loads the expiry settings into the widget.

void CollectionExpiryWidget::save(Akonadi::Collection &collection, bool saveSettings, bool expireNow)

Saves the settings shown in the widget into collection. If saveSettings is true, the settings are written by a job, otherwise they are only applied; if expireNow is true, old messages are expired immediately.

void CollectionExpiryWidget::save(const MailCommon::CollectionExpirySettings &collectionExpirySettings, Akonadi::Collection &collection, bool saveSettings, bool expireNow)

Saves collectionExpirySettings into collection. If saveSettings is true, the settings are written by a job, otherwise they are only applied; if expireNow is true, old messages are expired immediately.

[signal] void CollectionExpiryWidget::saveAndExpireRequested()

Emitted when the user requests to save the settings and expire now.

MailCommon::CollectionExpirySettings CollectionExpiryWidget::settings() const

Returns the expiry settings shown in the widget.