KSieveUi::ManageSieveWidget Class

The ManageSieveWidget class Author: Laurent Montel <montel@kde.org>. More...

Header: #include <KSieveUi/ManageSieveWidget>
CMake: find_package(KPim6KSieveUi REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::KSieveUi)

Public Functions

ManageSieveWidget(QWidget *parent = nullptr)
virtual ~ManageSieveWidget() override
void addNewScript(const QString &title)
void enableDisableActions(bool &newScriptAction, bool &editScriptAction, bool &deleteScriptAction, bool &desactivateScriptAction)
KSieveUi::ManageSieveTreeView *treeView() const

Public Slots

void slotDeactivateScript()
void slotDeleteResult(KManageSieve::SieveJob *job, bool success)
void slotDeleteScript()
void slotEditScript()
void slotGotList(KManageSieve::SieveJob *job, bool success, const QStringList &listScript, const QString &activeScript)
void slotNewScript()
void slotRefresh()
void slotRenameScript()

Signals

void editScript(const KSieveUi::ManageSieveWidget::ScriptInfo &info)
void newScript(const KSieveUi::ManageSieveWidget::ScriptInfo &info)
void scriptDeleted(const QUrl &u)
void scriptRenamed(const QUrl &oldUrl, const QUrl &newUrl)
void serverSieveFound(bool imapFound)
void updateButtons(QTreeWidgetItem *item)
void updateSieveSettingsDone()

Protected Functions

virtual bool refreshList() = 0
virtual void updateSieveSettings() = 0

Private Slots

void setActiveScripts(KSieveCore::ParseUserScriptJob *job)
void slotCancelFetch()
void slotCheckNetworkStatus()
void slotContextMenuRequested(const QPoint &p)
void slotDoubleClicked(QTreeWidgetItem *item)
void slotItemChanged(QTreeWidgetItem *item, int col)
void slotRenameFinished(const QUrl &oldUrl, const QUrl &newUrl, const QString &errorStr, bool success)
void slotRenameResult(KManageSieve::SieveJob *job, bool success)
void slotSystemNetworkOnlineStateChanged(bool state)
void slotUpdateButtons()

Detailed Description

Member Function Documentation

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

Constructs a ManageSieveWidget with the given parent widget.

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

Destroys the ManageSieveWidget.

void ManageSieveWidget::addNewScript(const QString &title)

addNewScript title

[signal] void ManageSieveWidget::editScript(const KSieveUi::ManageSieveWidget::ScriptInfo &info)

Emitted when a script is being edited. info The script information.

void ManageSieveWidget::enableDisableActions(bool &newScriptAction, bool &editScriptAction, bool &deleteScriptAction, bool &desactivateScriptAction)

Enables or disables script management actions. newScriptAction true to enable new script action. editScriptAction true to enable edit script action. deleteScriptAction true to enable delete script action. desactivateScriptAction true to enable deactivate script action.

[signal] void ManageSieveWidget::newScript(const KSieveUi::ManageSieveWidget::ScriptInfo &info)

Emitted when a new script is created. info The script information.

[pure virtual protected] bool ManageSieveWidget::refreshList()

Refreshes the list of scripts. Returns true if the refresh was successful.

[signal] void ManageSieveWidget::scriptDeleted(const QUrl &u)

Emitted when a script is deleted. u The URL of the deleted script.

[signal] void ManageSieveWidget::scriptRenamed(const QUrl &oldUrl, const QUrl &newUrl)

Emitted when a script is renamed. oldUrl The old URL of the script. newUrl The new URL of the script.

[signal] void ManageSieveWidget::serverSieveFound(bool imapFound)

Emitted when a Sieve server is found. imapFound true if IMAP was found.

[private slot] void ManageSieveWidget::setActiveScripts(KSieveCore::ParseUserScriptJob *job)

[private slot] void ManageSieveWidget::slotCancelFetch()

[private slot] void ManageSieveWidget::slotCheckNetworkStatus()

[private slot] void ManageSieveWidget::slotContextMenuRequested(const QPoint &p)

[slot] void ManageSieveWidget::slotDeactivateScript()

Deactivates the selected script.

[slot] void ManageSieveWidget::slotDeleteResult(KManageSieve::SieveJob *job, bool success)

Handles the result when a script is deleted. job The Sieve job. success true if the deletion was successful.

[slot] void ManageSieveWidget::slotDeleteScript()

Deletes the selected script.

[private slot] void ManageSieveWidget::slotDoubleClicked(QTreeWidgetItem *item)

[slot] void ManageSieveWidget::slotEditScript()

Edits the selected script.

[slot] void ManageSieveWidget::slotGotList(KManageSieve::SieveJob *job, bool success, const QStringList &listScript, const QString &activeScript)

Handles the result when the script list is retrieved. job The Sieve job. success true if the operation was successful. listScript The list of scripts. activeScript The currently active script.

[private slot] void ManageSieveWidget::slotItemChanged(QTreeWidgetItem *item, int col)

[slot] void ManageSieveWidget::slotNewScript()

Creates a new script.

[slot] void ManageSieveWidget::slotRefresh()

Refreshes the script list.

[private slot] void ManageSieveWidget::slotRenameFinished(const QUrl &oldUrl, const QUrl &newUrl, const QString &errorStr, bool success)

[private slot] void ManageSieveWidget::slotRenameResult(KManageSieve::SieveJob *job, bool success)

[slot] void ManageSieveWidget::slotRenameScript()

Renames the selected script.

[private slot] void ManageSieveWidget::slotSystemNetworkOnlineStateChanged(bool state)

[private slot] void ManageSieveWidget::slotUpdateButtons()

KSieveUi::ManageSieveTreeView *ManageSieveWidget::treeView() const

Returns the tree view widget. Returns The ManageSieveTreeView instance.

[signal] void ManageSieveWidget::updateButtons(QTreeWidgetItem *item)

Emitted when a tree widget item is updated. item The updated tree widget item.

[pure virtual protected] void ManageSieveWidget::updateSieveSettings()

Updates the Sieve settings.

[signal] void ManageSieveWidget::updateSieveSettingsDone()

Emitted when Sieve settings are updated.