MessageComposer::PluginEditorBase Class

Header: #include <MessageComposer/PluginEditorBase>
CMake: find_package(KPim6MessageComposer REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::MessageComposer)
Inherits: QObject
Inherited By:

MessageComposer::PluginEditorCheckBeforeSend, MessageComposer::PluginEditorConvertText, and MessageComposer::PluginEditorInit

Public Functions

PluginEditorBase(QObject *parent = nullptr)
virtual ~PluginEditorBase() override
virtual QString description() const
void emitConfigChanged()
virtual bool hasConfigureDialog() const
bool isEnabled() const
void setIsEnabled(bool enabled)
virtual void showConfigureDialog(QWidget *parent = nullptr)

Signals

void configChanged()

Detailed Description

Author: Laurent Montel <montel@kde.org>

The PluginEditorBase class.

Member Function Documentation

[explicit] PluginEditorBase::PluginEditorBase(QObject *parent = nullptr)

Constructs a PluginEditorBase. parent The parent object.

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

Destroys the PluginEditorBase.

[signal] void PluginEditorBase::configChanged()

Emitted when the plugin configuration has changed.

[virtual] QString PluginEditorBase::description() const

Returns a human-readable description of the plugin.

void PluginEditorBase::emitConfigChanged()

Emits the configChanged signal.

[virtual] bool PluginEditorBase::hasConfigureDialog() const

Returns whether this plugin has a configuration dialog.

bool PluginEditorBase::isEnabled() const

Returns whether the plugin is enabled.

See also setIsEnabled().

void PluginEditorBase::setIsEnabled(bool enabled)

Enables or disables the plugin. enabled True to enable, false to disable.

See also isEnabled().

[virtual] void PluginEditorBase::showConfigureDialog(QWidget *parent = nullptr)

Shows the configuration dialog for this plugin. parent The parent widget for the dialog.