24#ifndef KLFUSERSCRIPT_H
25#define KLFUSERSCRIPT_H
29#include <klffilterprocess.h>
49 static void clearCacheAll();
51 static QStringList usConfigToEnvList(
const QVariantMap& usconfig);
53 int scriptInfoError()
const;
54 QString scriptInfoErrorString()
const;
73 CanProvideDefaultSettings,
81 QString exeScriptFullPath()
const;
96 bool canProvideDefaultSettings()
const;
100 bool hasNotices()
const;
102 bool hasWarnings()
const;
104 bool hasErrors()
const;
124 virtual bool setProperty(
const QString&,
const QVariant&) {
return false; }
128 void internalSetProperty(
const QString& key,
const QVariant &val);
129 const KLFPropertizedObject * pobj();
136 QByteArray categorySpecificXmlConfig()
const;
138 void setScriptInfoError(
int code,
const QString & msg);
143 KLFRefPtr<Private> d;
144 inline Private * d_func() {
return d(); }
145 inline const Private * d_func()
const {
return d(); }
152struct KLFBackendEngineUserScriptInfoPrivate;
158 virtual ~KLFBackendEngineUserScriptInfo();
160 enum BackendEngineProperties {
188 KLF_DECLARE_PRIVATE(KLFBackendEngineUserScriptInfo) ;
197struct KLFUserScriptFilterProcessPrivate;
211 void addUserScriptConfig(
const QVariantMap& usconfig);
virtual QVariant property(const QString &propName) const=0
KLFAbstractPropertizedObject()
virtual QString objectKind() const=0
virtual bool setProperty(const QString &pname, const QVariant &value)=0
virtual QStringList propertyNameList() const=0
QStringList spitsOut() const
List of formats that this script will generate.
QString inputFormUI() const
A UI input form file (Qt designer file) for additional input.
QStringList skipFormats() const
List of formats that klfbackend should not attempt to generate.
QStringList disableInputs() const
List of user input fields that should be disabled.
static QString getUserScriptLogHtml(bool include_head=true)
Return the user script log, formatted in human-readable HTML.
virtual bool do_run(const QByteArray &indata, const QMap< QString, QByteArray * > outdatalist)
KLFUserScriptFilterProcess(const QString &scriptFileName, const KLFBackend::klfSettings *settings=NULL)
Summary of the info returned by a user script.
QString userScriptPath() const
e.g. "/path/to/klffeynmf.klfuserscript"
@ CategorySpecificXmlConfig
XML representation of the category-specific configuration (QByteArray)
QString userScriptName() const
e.g. "klffeynmf.klfuserscript"
QString userScriptBaseName() const
e.g. "klffeynmf"
KLFUserScriptInfo(const QString &userScriptPath)
Definition of class KLFBackend.
General settings for KLFBackend::getLatexFormula()