PimCommon::AbstractGenericPlugin Class

The AbstractGenericPlugin class provides the base class for generic plugins Author: Laurent Montel <montel@kde.org>. More...

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

PimCommon::GenericPlugin

Public Functions

AbstractGenericPlugin(QObject *parent = nullptr)
virtual ~AbstractGenericPlugin() override
virtual PimCommon::AbstractGenericPluginInterface *createInterface(QObject *parent = nullptr) = 0
virtual bool hasConfigureDialog() const
virtual bool hasPopupMenuSupport() const
virtual bool hasStatusBarSupport() const
virtual bool hasToolBarSupport() const
bool isEnabled() const
void setIsEnabled(bool enabled)
virtual void showConfigureDialog(QWidget *parent = nullptr)

Signals

void configChanged()

Detailed Description

Member Function Documentation

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

Constructs an AbstractGenericPlugin. @param parent The parent QObject

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

Destructs the AbstractGenericPlugin.

[signal] void AbstractGenericPlugin::configChanged()

Emitted when the plugin configuration changes.

[pure virtual] PimCommon::AbstractGenericPluginInterface *AbstractGenericPlugin::createInterface(QObject *parent = nullptr)

Creates an interface for this plugin. @param parent The parent QObject @return A new AbstractGenericPluginInterface instance

[virtual] bool AbstractGenericPlugin::hasConfigureDialog() const

Returns whether this plugin has a configuration dialog. @return true if configuration dialog is available, false otherwise

[virtual] bool AbstractGenericPlugin::hasPopupMenuSupport() const

Returns whether this plugin has popup menu support. @return true if popup menu is supported, false otherwise

[virtual] bool AbstractGenericPlugin::hasStatusBarSupport() const

Returns whether this plugin has status bar support. @return true if status bar is supported, false otherwise

[virtual] bool AbstractGenericPlugin::hasToolBarSupport() const

Returns whether this plugin has toolbar support. @return true if toolbar is supported, false otherwise

bool AbstractGenericPlugin::isEnabled() const

Returns whether this plugin is enabled. @return true if enabled, false otherwise

See also setIsEnabled().

void AbstractGenericPlugin::setIsEnabled(bool enabled)

Sets whether this plugin is enabled. @param enabled true to enable, false to disable

See also isEnabled().

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

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