MessageComposer::ConvertSnippetVariablesJob Class

The ConvertSnippetVariablesJob class Author: Laurent Montel <montel@kde.org>. More...

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

Public Functions

ConvertSnippetVariablesJob(QObject *parent = nullptr)
virtual ~ConvertSnippetVariablesJob() override
bool canStart() const
MessageComposer::ComposerViewInterface *composerViewInterface() const
void setComposerViewInterface(MessageComposer::ComposerViewInterface *composerViewInterface)
void setText(const QString &str)
void start()
QString text() const

Signals

void textConverted(const QString &str)

Static Public Members

QString convertVariables(MessageComposer::ComposerViewInterface *composerView, const QString &text)

Detailed Description

Member Function Documentation

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

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

bool ConvertSnippetVariablesJob::canStart() const

Returns whether the job can be started.

MessageComposer::ComposerViewInterface *ConvertSnippetVariablesJob::composerViewInterface() const

Returns the composer view interface used for variable conversion.

See also setComposerViewInterface().

[static] QString ConvertSnippetVariablesJob::convertVariables(MessageComposer::ComposerViewInterface *composerView, const QString &text)

Converts snippet variables in the given text. composerView The composer view for variable context. text The text containing variables to convert. Returns The converted text.

void ConvertSnippetVariablesJob::setComposerViewInterface(MessageComposer::ComposerViewInterface *composerViewInterface)

Sets the composer view interface for variable conversion. composerViewInterface The interface to use. The job takes ownership of it and deletes the previously set interface, if any.

See also composerViewInterface().

void ConvertSnippetVariablesJob::setText(const QString &str)

Sets the text containing snippet variables to convert. str The text with variables to convert.

See also text().

void ConvertSnippetVariablesJob::start()

Starts the conversion of snippet variables.

QString ConvertSnippetVariablesJob::text() const

Returns the text that was converted.

See also setText().

[signal] void ConvertSnippetVariablesJob::textConverted(const QString &str)