KPIMTextEdit::RichTextExternalComposer Class

class KPIMTextEdit::RichTextExternalComposer

The RichTextExternalComposer class manages integration with external text editors. More...

Header: #include <KPIMTextEdit/RichTextExternalComposer>
CMake: find_package(KPim6TextEdit REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::TextEdit)
Inherits: QObject

Public Functions

RichTextExternalComposer(KPIMTextEdit::RichTextComposer *composer, QObject *parent = nullptr)
virtual ~RichTextExternalComposer() override
bool checkExternalEditorFinished()
QString externalEditorPath() const
bool isInProgress() const
void killExternalEditor()
void setExternalEditorPath(const QString &path)
void setUseExternalEditor(bool value)
void startExternalEditor()
bool useExternalEditor() const

Signals

Detailed Description

Author: Laurent Montel <montel@kde.org>

Member Function Documentation

[explicit] RichTextExternalComposer::RichTextExternalComposer(KPIMTextEdit::RichTextComposer *composer, QObject *parent = nullptr)

Constructs a RichTextExternalComposer with the given composer and parent.

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

Destroys the RichTextExternalComposer.

bool RichTextExternalComposer::checkExternalEditorFinished()

Checks if the external editor process has finished. Returns true if the editor has finished, false otherwise.

[signal] void RichTextExternalComposer::externalEditorClosed()

Emitted when the external editor is closed.

QString RichTextExternalComposer::externalEditorPath() const

Returns the path to the external editor executable.

See also setExternalEditorPath().

[signal] void RichTextExternalComposer::externalEditorStarted()

Emitted when the external editor is started.

bool RichTextExternalComposer::isInProgress() const

Returns true if the external editor is currently running.

void RichTextExternalComposer::killExternalEditor()

Terminates the external editor process.

void RichTextExternalComposer::setExternalEditorPath(const QString &path)

Sets the path to the external editor executable to path.

See also externalEditorPath().

void RichTextExternalComposer::setUseExternalEditor(bool value)

Enables or disables the use of an external editor based on the value parameter.

See also useExternalEditor().

void RichTextExternalComposer::startExternalEditor()

Starts the external editor process.

bool RichTextExternalComposer::useExternalEditor() const

Returns true if the external editor is enabled.

See also setUseExternalEditor().