KLFBackendEngineUserScriptInfo Class Reference

Inheritance diagram for KLFBackendEngineUserScriptInfo:

Collaboration diagram for KLFBackendEngineUserScriptInfo:

Public Types
enum	BackendEngineProperties { SpitsOut = 0 , SkipFormats , DisableInputs , InputFormUI }
Public Types inherited from KLFUserScriptInfo
enum	Properties {   ExeScript = 0 , Category , Name , Author ,   Version , License , KLFMinVersion , KLFMaxVersion ,   SettingsFormUI , CanProvideDefaultSettings , CategorySpecificXmlConfig }

Public Member Functions
	KLFBackendEngineUserScriptInfo (const QString &userScriptPath)
QStringList	spitsOut () const
	List of formats that this script will generate.
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.
QString	inputFormUI () const
	A UI input form file (Qt designer file) for additional input.
QVariant	klfBackendEngineInfo (int propId) const
QVariant	klfBackendEngineInfo (const QString &key) const
QStringList	klfBackendEngineInfosList () const
Public Member Functions inherited from KLFUserScriptInfo
	KLFUserScriptInfo (const QString &userScriptPath)
	KLFUserScriptInfo (const KLFUserScriptInfo &copy)
int	scriptInfoError () const
QString	scriptInfoErrorString () const
QString	userScriptPath () const
	e.g. "/path/to/klffeynmf.klfuserscript"
QString	userScriptName () const
	e.g. "klffeynmf.klfuserscript"
QString	userScriptBaseName () const
	e.g. "klffeynmf"
QString	relativeFile (const QString &fname) const
QString	exeScript () const
QString	exeScriptFullPath () const
QString	category () const
QString	name () const
QString	author () const
QStringList	authorList () const
QString	version () const
QString	license () const
QString	klfMinVersion () const
QString	klfMaxVersion () const
QString	settingsFormUI () const
	A UI widget form file (Qt designer file) to display for setting up the user script.
bool	canProvideDefaultSettings () const
QMap< QString, QVariant >	queryDefaultSettings (const KLFBackend::klfSettings *settings=NULL) const
bool	hasNotices () const
QStringList	notices () const
bool	hasWarnings () const
QStringList	warnings () const
bool	hasErrors () const
QStringList	errors () const
QString	htmlInfo (const QString &extra_css=QString()) const
	Formats most (all?) properties in HTML, suitable for human-readable text display.
QVariant	scriptInfo (int propId) const
QVariant	scriptInfo (const QString &key) const
QStringList	scriptInfosList () const
	A list of Keys (eg. "Name", "Author", ... including custom infos) found in the scriptinfo.
virtual QString	objectKind () const
virtual QVariant	property (const QString &propName) const
virtual QStringList	propertyNameList () const
virtual bool	setProperty (const QString &, const QVariant &)
Public Member Functions inherited from KLFAbstractPropertizedObject
virtual QMap< QString, QVariant >	allProperties () const
virtual bool	setAllProperties (const QMap< QString, QVariant > &data)
virtual bool	hasFixedTypes () const
virtual QByteArray	typeNameFor (const QString &property) const
virtual QByteArray	typeSpecificationFor (const QString &property) const

Additional Inherited Members
Static Public Member Functions inherited from KLFUserScriptInfo
static bool	hasScriptInfoInCache (const QString &userScriptPath)
static KLFUserScriptInfo	forceReloadScriptInfo (const QString &scriptFileName)
static void	clearCacheAll ()
static QMap< QString, QString >	usConfigToStrMap (const QVariantMap &usconfig)
static QStringList	usConfigToEnvList (const QVariantMap &usconfig)
Protected Member Functions inherited from KLFUserScriptInfo
void	internalSetProperty (const QString &key, const QVariant &val)
const KLFPropertizedObject *	pobj ()
QByteArray	categorySpecificXmlConfig () const
	The XML for the category-specific config.
void	setScriptInfoError (int code, const QString &msg)

Detailed Description

Definition at line 154 of file klfuserscript.h.

Member Enumeration Documentation

BackendEngineProperties

enum KLFBackendEngineUserScriptInfo::BackendEngineProperties

Definition at line 160 of file klfuserscript.h.

Constructor & Destructor Documentation

KLFBackendEngineUserScriptInfo()

KLFBackendEngineUserScriptInfo::KLFBackendEngineUserScriptInfo

(

const QString &

userScriptPath

)

Definition at line 764 of file klfuserscript.cpp.

~KLFBackendEngineUserScriptInfo()

KLFBackendEngineUserScriptInfo::~KLFBackendEngineUserScriptInfo ( )

virtual

Definition at line 777 of file klfuserscript.cpp.

Member Function Documentation

disableInputs()

QStringList KLFBackendEngineUserScriptInfo::disableInputs

(

)

const

List of user input fields that should be disabled.

Definition at line 792 of file klfuserscript.cpp.

References QVariant::toStringList().

inputFormUI()

QString KLFBackendEngineUserScriptInfo::inputFormUI

(

)

const

A UI input form file (Qt designer file) for additional input.

Definition at line 796 of file klfuserscript.cpp.

References QVariant::toString().

klfBackendEngineInfo() [1/2]

QVariant KLFBackendEngineUserScriptInfo::klfBackendEngineInfo

(

const QString &

key

)

const

Definition at line 807 of file klfuserscript.cpp.

klfBackendEngineInfo() [2/2]

QVariant KLFBackendEngineUserScriptInfo::klfBackendEngineInfo

(

int

propId

)

const

Definition at line 802 of file klfuserscript.cpp.

klfBackendEngineInfosList()

QStringList KLFBackendEngineUserScriptInfo::klfBackendEngineInfosList

(

)

const

Definition at line 822 of file klfuserscript.cpp.

skipFormats()

QStringList KLFBackendEngineUserScriptInfo::skipFormats

(

)

const

List of formats that klfbackend should not attempt to generate.

The corresponding field(s) in KLFBackend::klfOutput will be set to empty QByteArray's.

Same format list as 'spits-out'.

Definition at line 788 of file klfuserscript.cpp.

References QVariant::toStringList().

spitsOut()

QStringList KLFBackendEngineUserScriptInfo::spitsOut

(

)

const

List of formats that this script will generate.

Definition at line 784 of file klfuserscript.cpp.

References QVariant::toStringList().

---

The documentation for this class was generated from the following files:

• src/klfbackend/klfuserscript.h
• src/klfbackend/klfuserscript.cpp