PimCommon::CustomToolsWidgetNg Class

The CustomToolsWidgetNg class provides a widget for custom tools Author: Laurent Montel <montel@kde.org>. More...

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

Public Functions

CustomToolsWidgetNg(QWidget *parent = nullptr)
virtual ~CustomToolsWidgetNg() override
QList<KToggleAction *> actionList() const
void addCustomToolViewInterface(PimCommon::CustomToolsViewInterface *plugin)
void initializeView(KActionCollection *ac, const QList<PimCommon::CustomToolsPlugin *> &localPluginsList)
void setText(const QString &text)

Public Slots

void slotActivateView(QWidget *w)
void slotToolsWasClosed()

Signals

void insertText(const QString &url)
void toolActivated()

Detailed Description

Member Function Documentation

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

Constructs a CustomToolsWidgetNg. @param parent The parent widget

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

Destructs the CustomToolsWidgetNg.

QList<KToggleAction *> CustomToolsWidgetNg::actionList() const

Returns the list of actions for toggling custom tool views. @return A list of KToggleAction for custom tools

void CustomToolsWidgetNg::addCustomToolViewInterface(PimCommon::CustomToolsViewInterface *plugin)

Adds a custom tools view interface. @param plugin The CustomToolsViewInterface to add

void CustomToolsWidgetNg::initializeView(KActionCollection *ac, const QList<PimCommon::CustomToolsPlugin *> &localPluginsList)

Initializes the view with the given action collection and plugins. @param ac The KActionCollection to add actions to @param localPluginsList The list of CustomToolsPlugin instances

[signal] void CustomToolsWidgetNg::insertText(const QString &url)

Emitted when text should be inserted. @param url The text/URL to insert

void CustomToolsWidgetNg::setText(const QString &text)

Sets the text for the custom tools. @param text The text to display

[slot] void CustomToolsWidgetNg::slotActivateView(QWidget *w)

Called to activate a view. @param w The widget to activate

[slot] void CustomToolsWidgetNg::slotToolsWasClosed()

Called when a tool is closed.

[signal] void CustomToolsWidgetNg::toolActivated()

Emitted when a tool is activated.