CopperSpice API  1.9.1
Public Types | Public Methods | Friends | List of all members
QScriptSyntaxCheckResult Class Reference
CsScript | Scriptable Applications

The QScriptSyntaxCheckResult class provides the result of a script syntax check. More...

Public Types

enum  State
 

Public Methods

 QScriptSyntaxCheckResult (const QScriptSyntaxCheckResult &other)
 
 ~QScriptSyntaxCheckResult ()
 
int errorColumnNumber () const
 
int errorLineNumber () const
 
QString errorMessage () const
 
QScriptSyntaxCheckResult & operator= (const QScriptSyntaxCheckResult &other)
 
State state () const
 

Friends

class QScriptEngine
 

Detailed Description

The QScriptSyntaxCheckResult class provides the result of a script syntax check.

QScriptSyntaxCheckResult is returned by QScriptEngine::checkSyntax() to provide information about the syntactical (in)correctness of a script.

See also
state(), errorLineNumber()

Member Enumeration Documentation

enum QScriptSyntaxCheckResult::State

This enum specifies the state of a syntax check.

ConstantValueDescription
QScriptSyntaxCheckResult::Error0The program contains a syntax error.
QScriptSyntaxCheckResult::Intermediate1The program is incomplete.
QScriptSyntaxCheckResult::Valid2The program is a syntactically correct CsScript program.

Constructor & Destructor Documentation

QScriptSyntaxCheckResult::QScriptSyntaxCheckResult ( const QScriptSyntaxCheckResult &  other)

Constructs a new QScriptSyntaxCheckResult from the other result.

QScriptSyntaxCheckResult::~QScriptSyntaxCheckResult ( )

Destroys this QScriptSyntaxCheckResult.

Method Documentation

int QScriptSyntaxCheckResult::errorColumnNumber ( ) const

Returns the error column number of this QScriptSyntaxCheckResult, or -1 if there is no error.

See also
state(), errorLineNumber()
int QScriptSyntaxCheckResult::errorLineNumber ( ) const

Returns the error line number of this QScriptSyntaxCheckResult, or -1 if there is no error.

See also
state(), errorMessage()
QString QScriptSyntaxCheckResult::errorMessage ( ) const

Returns the error message of this QScriptSyntaxCheckResult, or an empty string if there is no error.

See also
state(), errorLineNumber()
QScriptSyntaxCheckResult & QScriptSyntaxCheckResult::operator= ( const QScriptSyntaxCheckResult &  other)

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

State QScriptSyntaxCheckResult::state ( ) const

Returns the state of this QScriptSyntaxCheckResult.