MessageComposer::PluginEditorInterface Class

Header: #include <MessageComposer/PluginEditorInterface>
CMake: find_package(KPim6MessageComposer REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::MessageComposer)

Public Functions

PluginEditorInterface(QObject *parent = nullptr)
virtual ~PluginEditorInterface() override
MessageComposer::PluginActionType actionType() const
PluginEditorInterface::ApplyOnFieldTypes applyOnFieldTypes() const
MessageComposer::PluginComposerInterface *composerInterface() const
bool needSelectedText() const
virtual bool processProcessKeyEvent(QKeyEvent *event)
TextCustomEditor::RichTextEditor *richTextEditor() const
void setActionType(MessageComposer::PluginActionType type)
void setApplyOnFieldTypes(PluginEditorInterface::ApplyOnFieldTypes types)
void setComposerInterface(MessageComposer::PluginComposerInterface *w)
void setNeedSelectedText(bool b)
void setRichTextEditor(TextCustomEditor::RichTextEditor *richTextEditor)
void setStatusBarWidget(QWidget *w)
QWidget *statusBarWidget() const

Signals

void emitPluginActivated(MessageComposer::PluginEditorInterface *interface)
void errorMessage(const QString &message)
void insertText(const QString &str)
void successMessage(const QString &message)

Detailed Description

Author: Laurent Montel <montel@kde.org>

The PluginEditorInterface class.

Member Function Documentation

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

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

MessageComposer::PluginActionType PluginEditorInterface::actionType() const

See also setActionType().

PluginEditorInterface::ApplyOnFieldTypes PluginEditorInterface::applyOnFieldTypes() const

See also setApplyOnFieldTypes().

MessageComposer::PluginComposerInterface *PluginEditorInterface::composerInterface() const

See also setComposerInterface().

[signal] void PluginEditorInterface::emitPluginActivated(MessageComposer::PluginEditorInterface *interface)

[signal] void PluginEditorInterface::errorMessage(const QString &message)

[signal] void PluginEditorInterface::insertText(const QString &str)

bool PluginEditorInterface::needSelectedText() const

See also setNeedSelectedText().

[virtual] bool PluginEditorInterface::processProcessKeyEvent(QKeyEvent *event)

TextCustomEditor::RichTextEditor *PluginEditorInterface::richTextEditor() const

See also setRichTextEditor().

void PluginEditorInterface::setActionType(MessageComposer::PluginActionType type)

See also actionType().

void PluginEditorInterface::setApplyOnFieldTypes(PluginEditorInterface::ApplyOnFieldTypes types)

See also applyOnFieldTypes().

void PluginEditorInterface::setComposerInterface(MessageComposer::PluginComposerInterface *w)

See also composerInterface().

void PluginEditorInterface::setNeedSelectedText(bool b)

See also needSelectedText().

void PluginEditorInterface::setRichTextEditor(TextCustomEditor::RichTextEditor *richTextEditor)

See also richTextEditor().

void PluginEditorInterface::setStatusBarWidget(QWidget *w)

See also statusBarWidget().

QWidget *PluginEditorInterface::statusBarWidget() const

See also setStatusBarWidget().

[signal] void PluginEditorInterface::successMessage(const QString &message)