PimCommon::CustomToolsViewInterface Class

The CustomToolsViewInterface class provides the interface for custom tools views Author: Laurent Montel <montel@kde.org>. More...

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

Public Functions

CustomToolsViewInterface(QWidget *parent = nullptr)
virtual ~CustomToolsViewInterface() override
virtual KToggleAction *action() const
virtual void setText(const QString &text)

Signals

void activateView(QWidget *)
void configure(QWidget *parent)
void insertText(const QString &text)
void toolsWasClosed()

Detailed Description

Member Function Documentation

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

Constructs a CustomToolsViewInterface. @param parent The parent widget

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

Destructs the CustomToolsViewInterface.

[virtual] KToggleAction *CustomToolsViewInterface::action() const

Returns the action associated with this view. @return A KToggleAction for toggling this view

[signal] void CustomToolsViewInterface::activateView(QWidget *)

Emitted to activate the view. @param widget The widget to activate

[signal] void CustomToolsViewInterface::configure(QWidget *parent)

Emitted to configure the tools. @param parent The parent widget for configuration dialog

[signal] void CustomToolsViewInterface::insertText(const QString &text)

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

[virtual] void CustomToolsViewInterface::setText(const QString &text)

Sets the text displayed in the view. @param text The text to display

[signal] void CustomToolsViewInterface::toolsWasClosed()

Emitted when the tools view is closed.