Kate
KateScript Class Reference
KateScript objects represent a script that can be executed and inspected. More...
#include <katescript.h>

Public Member Functions | |
void | clearExceptions () |
void | displayBacktrace (const QScriptValue &error, const QString &header=QString()) |
const QString & | errorMessage () |
QScriptValue | function (const QString &name) |
QScriptValue | global (const QString &name) |
const KateScriptInformation & | information () |
KateScript (const QString &url, const KateScriptInformation &information) | |
bool | load () |
bool | setView (KateView *view) |
const QString & | url () |
~KateScript () | |
Protected Attributes | |
QScriptEngine * | m_engine |
Detailed Description
KateScript objects represent a script that can be executed and inspected.Definition at line 112 of file katescript.h.
Constructor & Destructor Documentation
KateScript::KateScript | ( | const QString & | url, | |
const KateScriptInformation & | information | |||
) |
Create a new script representation, passing a file url
to it and a KateScriptInformation instance.
Loading of the script will happen lazily
Definition at line 74 of file katescript.cpp.
KateScript::~KateScript | ( | ) |
Definition at line 80 of file katescript.cpp.
Member Function Documentation
void KateScript::clearExceptions | ( | ) |
void KateScript::displayBacktrace | ( | const QScriptValue & | error, | |
const QString & | header = QString() | |||
) |
const QString& KateScript::errorMessage | ( | ) | [inline] |
QScriptValue KateScript::function | ( | const QString & | name | ) |
Return a function in the script of the given name, or an invalid QScriptValue if no such function exists.
Definition at line 118 of file katescript.cpp.
QScriptValue KateScript::global | ( | const QString & | name | ) |
Get a QScriptValue for a global item in the script given its name, or an invalid QScriptValue if no such global item exists.
Definition at line 110 of file katescript.cpp.
const KateScriptInformation& KateScript::information | ( | ) | [inline] |
bool KateScript::load | ( | ) |
Load the script.
If loading is successful, returns true. Otherwise, returns returns false and an error message will be set (see errorMessage()). Note that you don't have to call this -- it is called as necessary by the functions that require it. Subsequent calls to load will return the value it returned the first time.
Definition at line 126 of file katescript.cpp.
bool KateScript::setView | ( | KateView * | view | ) |
set view for this script for the execution will trigger load!
Definition at line 173 of file katescript.cpp.
const QString& KateScript::url | ( | ) | [inline] |
Member Data Documentation
QScriptEngine* KateScript::m_engine [protected] |
The documentation for this class was generated from the following files: