TextAutoGenerateText::TextAutoGenerateTextToolPlugin Class

class TextAutoGenerateText::TextAutoGenerateTextToolPlugin

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

Header: #include <TextAutoGenerateText/TextAutoGenerateTextToolPlugin>
Inherits: QObject

Public Functions

TextAutoGenerateTextToolPlugin(QObject *parent = nullptr)
virtual ~TextAutoGenerateTextToolPlugin() override
virtual TextAutoGenerateText::TextAutoGenerateTextToolPluginJob *callTool() = 0
virtual QString description() const = 0
virtual QString displayName() const = 0
bool enabled() const
virtual QString iconName() const
bool isValid() const
QJsonObject metadata()
virtual int order() const = 0
QList<TextAutoGenerateText::TextAutoGenerateTextToolPluginProperty> properties() const
QStringList required() const
void setEnabled(bool newEnabled)
void setProperties(const QList<TextAutoGenerateText::TextAutoGenerateTextToolPluginProperty> &newProperties)
void setRequired(const QStringList &newRequired)
void setToolNameId(const QByteArray &newToolName)
virtual void showConfigureDialog(QWidget *parent = nullptr)
QByteArray toolNameId() const

Protected Functions

QJsonObject generateMetadata() const

Detailed Description

Member Function Documentation

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

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

[pure virtual] TextAutoGenerateText::TextAutoGenerateTextToolPluginJob *TextAutoGenerateTextToolPlugin::callTool()

[pure virtual] QString TextAutoGenerateTextToolPlugin::description() const

[pure virtual] QString TextAutoGenerateTextToolPlugin::displayName() const

bool TextAutoGenerateTextToolPlugin::enabled() const

See also setEnabled().

[protected] QJsonObject TextAutoGenerateTextToolPlugin::generateMetadata() const

[virtual] QString TextAutoGenerateTextToolPlugin::iconName() const

bool TextAutoGenerateTextToolPlugin::isValid() const

QJsonObject TextAutoGenerateTextToolPlugin::metadata()

[pure virtual] int TextAutoGenerateTextToolPlugin::order() const

QList<TextAutoGenerateText::TextAutoGenerateTextToolPluginProperty> TextAutoGenerateTextToolPlugin::properties() const

See also setProperties().

QStringList TextAutoGenerateTextToolPlugin::required() const

See also setRequired().

void TextAutoGenerateTextToolPlugin::setEnabled(bool newEnabled)

See also enabled().

void TextAutoGenerateTextToolPlugin::setProperties(const QList<TextAutoGenerateText::TextAutoGenerateTextToolPluginProperty> &newProperties)

See also properties().

void TextAutoGenerateTextToolPlugin::setRequired(const QStringList &newRequired)

See also required().

void TextAutoGenerateTextToolPlugin::setToolNameId(const QByteArray &newToolName)

See also toolNameId().

[virtual] void TextAutoGenerateTextToolPlugin::showConfigureDialog(QWidget *parent = nullptr)

QByteArray TextAutoGenerateTextToolPlugin::toolNameId() const

See also setToolNameId().