Qyoto  4.0.7
Qyoto is a C# language binding for Qt
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties
QtScript.QScriptContextInfo Class Reference

The QScriptContextInfo class provides additional information about a QScriptContext. More...

Inheritance diagram for QtScript.QScriptContextInfo:
Collaboration diagram for QtScript.QScriptContextInfo:

Public Types

enum  FunctionType { NativeFunction = 3, QtFunction = 1, QtPropertyFunction = 2, ScriptFunction = 0 }
  More...
 

Public Member Functions

override bool Equals (object o)
 
override int GetHashCode ()
 
 QScriptContextInfo ()
  More...
 
 QScriptContextInfo (QScriptContext context)
  More...
 
 QScriptContextInfo (QScriptContextInfo other)
  More...
 
virtual void CreateProxy ()
 
new void Dispose ()
 

Static Public Member Functions

static bool operator!= (QScriptContextInfo one, QScriptContextInfo other)
  More...
 
static bool operator== (QScriptContextInfo one, QScriptContextInfo other)
  More...
 

Protected Member Functions

 QScriptContextInfo (System.Type dummy)
 

Protected Attributes

SmokeInvocation interceptor
 

Properties

int ColumnNumber [get]
  More...
 
string FileName [get]
  More...
 
int FunctionEndLineNumber [get]
  More...
 
int FunctionMetaIndex [get]
  More...
 
string FunctionName [get]
  More...
 
System.Collections.Generic.List
< string > 
FunctionParameterNames [get]
  More...
 
int FunctionStartLineNumber [get]
  More...
 
QScriptContextInfo.FunctionType functionType [get]
  More...
 
bool IsNull [get]
  More...
 
int LineNumber [get]
  More...
 
long ScriptId [get]
  More...
 
virtual System.IntPtr SmokeObject [get, set]
 

Detailed Description

The QScriptContextInfo class provides additional information about a QScriptContext.

QScriptContextInfo is typically used for debugging purposes. It can provide information about the code being executed, such as the type of the called function, and the original source code location of the current statement.

If the called function is executing Qt Script code, you can obtain the script location with the functions fileName() and lineNumber().

You can obtain the starting line number and ending line number of a Qt Script function definition with functionStartLineNumber() and functionEndLineNumber(), respectively.

For Qt Script functions and Qt methods (e.g. slots), you can call functionParameterNames() to get the names of the formal parameters of the function.

For Qt methods and Qt property accessors, you can obtain the index of the underlying QMetaMethod or QMetaProperty by calling functionMetaIndex().

See also QScriptContext and QScriptEngineAgent.

Member Enumeration Documentation

This enum specifies the type of function being called.

Enumerator
NativeFunction 

The function is a built-in Qt Script function, or it was defined through a call to QScriptEngine::newFunction().

QtFunction 

The function is a Qt function (a signal, slot or method).

QtPropertyFunction 

The function is a Qt property getter or setter.

ScriptFunction 

The function is a Qt Script function, i.e. it was defined through a call to QScriptEngine::evaluate().

Constructor & Destructor Documentation

QtScript.QScriptContextInfo.QScriptContextInfo ( System.Type  dummy)
protected
QtScript.QScriptContextInfo.QScriptContextInfo ( )

Constructs a null QScriptContextInfo.

See also isNull().

Here is the call graph for this function:

Here is the caller graph for this function:

QtScript.QScriptContextInfo.QScriptContextInfo ( QScriptContext  context)

Constructs a new QScriptContextInfo from the given context.

The relevant information is extracted from the context at construction time; i.e. if you continue script execution in the context, the new state of the context will not be reflected in a previously created QScriptContextInfo.

Here is the call graph for this function:

QtScript.QScriptContextInfo.QScriptContextInfo ( QScriptContextInfo  other)

Constructs a new QScriptContextInfo from the other info.

Here is the call graph for this function:

Member Function Documentation

virtual void QtScript.QScriptContextInfo.CreateProxy ( )
virtual

Here is the caller graph for this function:

new void QtScript.QScriptContextInfo.Dispose ( )
override bool QtScript.QScriptContextInfo.Equals ( object  o)

Here is the call graph for this function:

override int QtScript.QScriptContextInfo.GetHashCode ( )
static bool QtScript.QScriptContextInfo.operator!= ( QScriptContextInfo  one,
QScriptContextInfo  other 
)
static

Returns true if this QScriptContextInfo is not equal to the other info, otherwise returns false.

static bool QtScript.QScriptContextInfo.operator== ( QScriptContextInfo  one,
QScriptContextInfo  other 
)
static

Returns true if this QScriptContextInfo is equal to the other info, otherwise returns false.

Member Data Documentation

SmokeInvocation QtScript.QScriptContextInfo.interceptor
protected

Property Documentation

int QtScript.QScriptContextInfo.ColumnNumber
get

2012 Digia Plc and/or its

subsidiaries. Documentation contributions included herein are the copyrights of

their respective owners.

string QtScript.QScriptContextInfo.FileName
get

Returns the name of the file where the code being executed was defined, if available; otherwise returns an empty string.

For Qt Script code, this function returns the fileName argument that was passed to QScriptEngine::evaluate().

See also lineNumber() and functionName().

int QtScript.QScriptContextInfo.FunctionEndLineNumber
get

Returns the line number where the definition of the called function ends, or -1 if the line number is not available.

The ending line number is only available if the functionType() is ScriptFunction.

See also functionStartLineNumber().

int QtScript.QScriptContextInfo.FunctionMetaIndex
get

Returns the meta index of the called function, or -1 if the meta index is not available.

The meta index is only available if the functionType() is QtFunction or QtPropertyFunction. For QtFunction, the meta index can be passed to QMetaObject::method() to obtain the corresponding method definition; for QtPropertyFunction, the meta index can be passed to QMetaObject::property() to obtain the corresponding property definition.

See also QScriptContext::thisObject().

string QtScript.QScriptContextInfo.FunctionName
get

Returns the name of the called function, or an empty string if the name is not available.

For script functions of type QtPropertyFunction, this function always returns the name of the property; you can use QScriptContext::argumentCount() to differentiate between reads and writes.

See also fileName() and functionType().

System.Collections.Generic.List<string> QtScript.QScriptContextInfo.FunctionParameterNames
get

Returns the names of the formal parameters of the called function, or an empty QStringList if the parameter names are not available.

See also QScriptContext::argument().

int QtScript.QScriptContextInfo.FunctionStartLineNumber
get

Returns the line number where the definition of the called function starts, or -1 if the line number is not available.

The starting line number is only available if the functionType() is ScriptFunction.

See also functionEndLineNumber() and fileName().

QScriptContextInfo.FunctionType QtScript.QScriptContextInfo.functionType
get

Returns the type of the called function.

See also functionName() and QScriptContext::callee().

bool QtScript.QScriptContextInfo.IsNull
get

Returns true if this QScriptContextInfo is null, i.e. does not contain any information.

int QtScript.QScriptContextInfo.LineNumber
get

Returns the line number corresponding to the statement being executed, or -1 if the line number is not available.

The line number is only available if Qt Script code is being executed.

See also columnNumber() and fileName().

long QtScript.QScriptContextInfo.ScriptId
get

Returns the ID of the script where the code being executed was defined, or -1 if the ID is not available (i.e. a native function is being executed).

See also QScriptEngineAgent::scriptLoad().

virtual System.IntPtr QtScript.QScriptContextInfo.SmokeObject
getset