PimCommon::ConfigurePluginDialog Class

The ConfigurePluginDialog class provides a dialog for configuring plugins Author: Laurent Montel <montel@kde.org>. More...

Header: #include <PimCommon/ConfigurePluginDialog>
CMake: find_package(KPim6PimCommon REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::PimCommon)

Public Functions

ConfigurePluginDialog(QWidget *parent = nullptr)
virtual ~ConfigurePluginDialog() override
void initLayout(bool addSpacer = false)

Protected Functions

QDialogButtonBox *buttonBox() const
virtual QWidget *createLayout() = 0
virtual void help()
virtual void load() = 0
virtual void reset()
virtual void save() = 0
void showHelp(const QString &name, const QString &anchor)

Detailed Description

Member Function Documentation

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

Constructs a ConfigurePluginDialog. @param parent The parent widget

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

Destructs the ConfigurePluginDialog.

[protected] QDialogButtonBox *ConfigurePluginDialog::buttonBox() const

Returns the dialog button box. @return The QDialogButtonBox for this dialog

[pure virtual protected] QWidget *ConfigurePluginDialog::createLayout()

Creates the main layout widget for the dialog. @return A QWidget containing the dialog layout

[virtual protected] void ConfigurePluginDialog::help()

Shows the help dialog.

void ConfigurePluginDialog::initLayout(bool addSpacer = false)

Initializes the dialog layout. @param addSpacer Whether to add a spacer to the layout

[pure virtual protected] void ConfigurePluginDialog::load()

Loads the configuration into the dialog.

[virtual protected] void ConfigurePluginDialog::reset()

Resets the configuration to default values.

[pure virtual protected] void ConfigurePluginDialog::save()

Saves the configuration from the dialog.

[protected] void ConfigurePluginDialog::showHelp(const QString &name, const QString &anchor)

Shows help for the dialog. @param name The help document name @param anchor The anchor within the help document