PimCommon::AbstractGenericPluginInterface Class

The AbstractGenericPluginInterface class provides an interface for generic plugin implementations Author: Laurent Montel <montel@kde.org>. More...

Header: #include <PimCommon/AbstractGenericPluginInterface>
CMake: find_package(KPim6PimCommon REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::PimCommon)
Inherits: QObject
Inherited By:

PimCommon::GenericPluginInterface

Public Functions

AbstractGenericPluginInterface(QObject *parent = nullptr)
virtual ~AbstractGenericPluginInterface() override
virtual void createAction(KActionCollection *ac) = 0
virtual void exec() = 0
QWidget *parentWidget() const
PimCommon::AbstractGenericPlugin *plugin() const
void setParentWidget(QWidget *parent)
void setPlugin(PimCommon::AbstractGenericPlugin *plugin)
virtual void showConfigureDialog(QWidget *parentWidget = nullptr)

Signals

void emitPluginActivated(PimCommon::AbstractGenericPluginInterface *interface)
void message(const QString &str)

Detailed Description

Member Function Documentation

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

Constructs an AbstractGenericPluginInterface. @param parent The parent QObject

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

Destructs the AbstractGenericPluginInterface.

[pure virtual] void AbstractGenericPluginInterface::createAction(KActionCollection *ac)

Creates actions for this plugin. @param ac The KActionCollection to add actions to

[signal] void AbstractGenericPluginInterface::emitPluginActivated(PimCommon::AbstractGenericPluginInterface *interface)

Emitted when the plugin is activated. @param interface Pointer to this interface

[pure virtual] void AbstractGenericPluginInterface::exec()

Executes the plugin action.

[signal] void AbstractGenericPluginInterface::message(const QString &str)

Emitted to display a message. @param str The message to display

QWidget *AbstractGenericPluginInterface::parentWidget() const

Returns the parent widget of this interface. @return The parent widget, or nullptr if not set

See also setParentWidget().

PimCommon::AbstractGenericPlugin *AbstractGenericPluginInterface::plugin() const

Returns the plugin associated with this interface. @return The AbstractGenericPlugin, or nullptr if not set

See also setPlugin().

void AbstractGenericPluginInterface::setParentWidget(QWidget *parent)

Sets the parent widget for this interface. @param parent The widget to set as parent

See also parentWidget().

void AbstractGenericPluginInterface::setPlugin(PimCommon::AbstractGenericPlugin *plugin)

Sets the plugin for this interface. @param plugin The AbstractGenericPlugin to set

See also plugin().

[virtual] void AbstractGenericPluginInterface::showConfigureDialog(QWidget *parentWidget = nullptr)

Shows the configuration dialog for this plugin. @param parentWidget The parent widget for the dialog