PimCommon::CustomToolsPlugin Class
The CustomToolsPlugin class provides the base class for custom tools plugins Author: Laurent Montel <montel@kde.org>. More...
| Header: | #include <PimCommon/CustomToolsPlugin> |
| CMake: | find_package(KPim6PimCommon REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::PimCommon) |
| Inherits: | QObject |
Public Functions
| CustomToolsPlugin(QObject *parent = nullptr) | |
| virtual | ~CustomToolsPlugin() override |
| virtual PimCommon::CustomToolsViewInterface * | createView(KActionCollection *ac, PimCommon::CustomToolsWidgetNg *parent = nullptr) = 0 |
| virtual QString | customToolName() const = 0 |
| virtual QString | description() const |
| virtual bool | hasConfigureDialog() const |
| bool | isEnabled() const |
| void | setIsEnabled(bool enabled) |
| virtual void | showConfigureDialog(QWidget *parent) |
Detailed Description
Member Function Documentation
[explicit] CustomToolsPlugin::CustomToolsPlugin(QObject *parent = nullptr)
Constructs a CustomToolsPlugin. @param parent The parent QObject
[override virtual noexcept] CustomToolsPlugin::~CustomToolsPlugin()
Destructs the CustomToolsPlugin.
[pure virtual] PimCommon::CustomToolsViewInterface *CustomToolsPlugin::createView(KActionCollection *ac, PimCommon::CustomToolsWidgetNg *parent = nullptr)
Creates a view interface for this custom tool. @param ac The KActionCollection to add actions to @param parent The parent CustomToolsWidgetNg @return A new CustomToolsViewInterface instance
[pure virtual] QString CustomToolsPlugin::customToolName() const
Returns the name of the custom tool. @return The custom tool name
[virtual] QString CustomToolsPlugin::description() const
Returns the description of this custom tool. @return The tool description
[virtual] bool CustomToolsPlugin::hasConfigureDialog() const
Returns whether this plugin has a configuration dialog. @return true if configuration dialog is available, false otherwise
bool CustomToolsPlugin::isEnabled() const
Returns whether this plugin is enabled. @return true if enabled, false otherwise
See also setIsEnabled().
void CustomToolsPlugin::setIsEnabled(bool enabled)
Sets whether this plugin is enabled. @param enabled true to enable, false to disable
See also isEnabled().
[virtual] void CustomToolsPlugin::showConfigureDialog(QWidget *parent)
Shows the configuration dialog for this plugin. @param parent The parent widget