Unix/Linux Go Back    


CentOS 7.0 - man page for qaxscript (centos section 3qt)

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)


QAxScript(3qt)									   QAxScript(3qt)

NAME
       QAxScript - Wrapper around script code

SYNOPSIS
       This class is part of the Qt ActiveQt Extension.

       #include <qaxscript.h>

       Inherits QObject.

   Public Members
       enum FunctionFlags { FunctionNames = 0, FunctionSignatures }
       QAxScript ( const QString & name, QAxScriptManager * manager )
       ~QAxScript ()
       bool load ( const QString & code, const QString & language = QString::null )
       QStringList functions ( FunctionFlags flags = FunctionNames ) const
       QString scriptCode () const
       QString scriptName () const
       QAxScriptEngine * scriptEngine () const
       QVariant call ( const QString & function, const QVariant & var1 = QVariant ( ), const
	   QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant &
	   var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 =
	   QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant (
	   ) )
       QVariant call ( const QString & function, QValueList<QVariant> & arguments )

   Signals
       void entered ()
       void finished ()
       void finished ( const QVariant & result )
       void finished ( int code, const QString & source, const QString & description, const
	   QString & help )
       void stateChanged ( int state )
       void error ( int code, const QString & description, int sourcePosition, const QString &
	   sourceText )

DESCRIPTION
       This class is defined in the Qt ActiveQt Extension, which can be found in the
       qt/extensions directory. It is not included in the main Qt API.

       The QAxScript class provides a wrapper around script code.

       Every instance of the QAxScript class represents a piece of scripting code in a particular
       scripting language. The code is loaded into the script engine using load(). Functions
       declared in the code can be called using call().

       The script provides scriptEngine() provides feedback to the application through signals.
       The most important signal is the error() signal. Direct access to the QAxScriptEngine is
       provided through the scriptEngine() function.

       Warning: This class is not available with the bcc5.5 and MingW compilers.

   Member Type Documentation
QAxScript::FunctionFlags
       This FunctionFlags enum describes formatting for function introspection.

       QAxScript::FunctionNames - Only function names are returned.

       QAxScript::FunctionSignatures - Returns the functions with signatures.

MEMBER FUNCTION DOCUMENTATION
QAxScript::QAxScript ( const QString & name, QAxScriptManager * manager )
       Constructs a QAxScript object called name and registers it with the QAxScriptManager
       manager. This is usually done by the QAxScriptManager class when loading a script.

       A script should always have a name. A manager is necessary to allow the script code to
       reference objects in the application. The manager takes ownership of the object.

QAxScript::~QAxScript ()
       Destroys the object, releasing all allocated resources.

QVariant QAxScript::call ( const QString & function, const QVariant & var1 = QVariant ( ), const
       QVariant & var2 = QVariant ( ), const QVariant & var3 = QVariant ( ), const QVariant &
       var4 = QVariant ( ), const QVariant & var5 = QVariant ( ), const QVariant & var6 =
       QVariant ( ), const QVariant & var7 = QVariant ( ), const QVariant & var8 = QVariant ( ) )

       Calls function, passing the parameters var1, var1, var2, var3, var4, var5, var6, var7 and
       var8 as arguments and returns the value returned by the function, or an invalid QVariant
       if the function does not return a value or when the function call failed.

       See QAxScriptManager::call() for more information about how to call script functions.

QVariant QAxScript::call ( const QString & function, QValueList<QVariant> & arguments )
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       Calls function passing arguments as parameters, and returns the result. Returns when the
       script's execution has finished.

       See QAxScriptManager::call() for more information about how to call script functions.

void QAxScript::entered () [signal]
       This signal is emitted when a script engine has started executing code.

void QAxScript::error ( int code, const QString & description, int sourcePosition, const QString
       & sourceText ) [signal]
       This signal is emitted when an execution error occured while running a script.

       code, description, sourcePosition and sourceText contain information about the execution
       error.

void QAxScript::finished () [signal]
       This signal is emitted when a script engine has finished executing code.

void QAxScript::finished ( const QVariant & result ) [signal]
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       result contains the script's result. This will be an invalid QVariant if the script has no
       return value.

void QAxScript::finished ( int code, const QString & source, const QString & description, const
       QString & help ) [signal]
       This is an overloaded member function, provided for convenience. It behaves essentially
       like the above function.

       code, source, description and help contain exception information when the script
       terminated.

QStringList QAxScript::functions ( FunctionFlags flags = FunctionNames ) const
       Returns a list of all the functions in this script if the respective script engine
       supports introspection; otherwise returns an empty list. The functions are either provided
       with full prototypes or only as names, depending on the value of flags.

       See also QAxScriptEngine::hasIntrospection().

bool QAxScript::load ( const QString & code, const QString & language = QString::null )
       Loads the script source code written in language language into the script engine. Returns
       TRUE if code was successfully entered into the script engine; otherwise returns FALSE.

       If language is empty (the default) it will be determined heuristically. If code contains
       the string End Sub it will be interpreted as VBScript, otherwise as JScript. Additional
       scripting languages can be registered using QAxScript::registerEngine().

       This function can only be called once for each QAxScript object, which is done
       automatically when using QAxScriptManager::load().

QString QAxScript::scriptCode () const
       Returns the script's code, or the null-string if no code has been loaded yet.

       See also load().

QAxScriptEngine * QAxScript::scriptEngine () const
       Returns a pointer to the script engine.

       You can use the object returned to connect signals to the script functions, or to access
       the script engine directly.

QString QAxScript::scriptName () const
       Returns the name of the script.

void QAxScript::stateChanged ( int state ) [signal]
       This signal is emitted when a script engine changes state.  state can be any value in the
       QAxScriptEngineState enumeration.

SEE ALSO
       http://doc.trolltech.com/qaxscript.html http://www.trolltech.com/faq/tech.html

COPYRIGHT
       Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the license file
       included in the distribution for a complete license statement.

AUTHOR
       Generated automatically from the source code.

BUGS
       If you find a bug in Qt, please report it as described in
       http://doc.trolltech.com/bughowto.html.	Good bug reports help us to help you. Thank you.

       The definitive Qt documentation is provided in HTML format; it is located at
       $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is
       provided as a convenience for those users who prefer man pages, although this format is
       not officially supported by Trolltech.

       If you find errors in this manual page, please report them to qt-bugs@trolltech.com.
       Please include the name of the manual page (qaxscript.3qt) and the Qt version (3.3.8).

Trolltech AS				 2 February 2007			   QAxScript(3qt)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums


All times are GMT -4. The time now is 10:32 AM.