CopperSpice API  1.9.1
Public Methods | List of all members
QScriptProgram Class Reference
CsScript | Scriptable Applications

The QScriptProgram class encapsulates a CsScript program. More...

Public Methods

 QScriptProgram ()
 
 QScriptProgram (const QScriptProgram &other)
 
 QScriptProgram (const QString &sourceCode, const QString fileName=QString (), int firstLineNumber=1)
 
 ~QScriptProgram ()
 
QString fileName () const
 
int firstLineNumber () const
 
bool isNull () const
 
bool operator!= (const QScriptProgram &other) const
 
QScriptProgram & operator= (const QScriptProgram &other)
 
bool operator== (const QScriptProgram &other) const
 
QString sourceCode () const
 

Detailed Description

The QScriptProgram class encapsulates a CsScript program.

QScriptProgram retains the compiled representation of the script if possible. Thus, QScriptProgram can be used to evaluate the same script multiple times more efficiently.

QScriptEngine engine;
QScriptProgram program("1 + 2");
QScriptValue result = engine.evaluate(program);

Constructor & Destructor Documentation

QScriptProgram::QScriptProgram ( )

Constructs a null QScriptProgram.

QScriptProgram::QScriptProgram ( const QString &  sourceCode,
const QString  fileName = QString(),
int  firstLineNumber = 1 
)

Constructs a new QScriptProgram with the given sourceCode, fileName and firstLineNumber.

QScriptProgram::QScriptProgram ( const QScriptProgram &  other)

Constructs a new QScriptProgram that is a copy of other.

QScriptProgram::~QScriptProgram ( )

Destroys this QScriptProgram.

Method Documentation

QString QScriptProgram::fileName ( ) const

Returns the filename associated with this program.

int QScriptProgram::firstLineNumber ( ) const

Returns the line number associated with this program.

bool QScriptProgram::isNull ( ) const

Returns true if this QScriptProgram is null, otherwise returns false.

bool QScriptProgram::operator!= ( const QScriptProgram &  other) const

Returns true if this QScriptProgram is not equal to other, otherwise returns false.

QScriptProgram & QScriptProgram::operator= ( const QScriptProgram &  other)

Copy assigns from other and returns a reference to this object.

bool QScriptProgram::operator== ( const QScriptProgram &  other) const

Returns true if this QScriptProgram is equal to other, otherwise returns false.

QString QScriptProgram::sourceCode ( ) const

Returns the source code of this program.