class Application

This native class represents the application and provides some basic functionality.

The application object is passed into the global script functions Create(), Destroy(), Open(), Close(), Idle() and ParameterChanged(). They are optional and only called if they exist in a script file.

Methods

View FindView (const string)Searches and returns a view by it's name property.
int GetCurrentSurface ()Returns the zero-based index of the currently active surface.
string[] GetListParameter (const string)Returns the specified 'stringlist' parameter's value as a list of strings.
int GetNumberOfSurfaces ()Returns the amount of surfaces defined in the jml file.
string GetParameter (const string)Returns the specified parameter's value as a string.
Parameter GetParameterByIndex (const int)Returns a parameter object by the given zero-based index.
Parameter GetParameterByName (const string)Returns a parameter object by the given parameter name.
View GetView (const string)Returns the view from the specified path in the view-tree.
Minimize ()Minimizes the application.
Quit ()Terminates the application.
SetListParameter (const string, const string[])Sets the specified 'stringlist' parameter to a list of strings.
SetParameter (const string, const string)Sets the specified parameter's value to a string.

Properties

int InitialUpdate ()Returns true if this is the first call to ParameterChanged(), false if it isn't.

Reference

method View FindView (const string name)

Searches and returns a view by it's name property.

This is a recursive action. If the view's name property is not unique, it may not be retrievable with this function.


method int GetCurrentSurface ()

Returns the zero-based index of the currently active surface.


method string[] GetListParameter (const string name)

Returns the specified 'stringlist' parameter's value as a list of strings.


method int GetNumberOfSurfaces ()

Returns the amount of surfaces defined in the jml file.


method string GetParameter (const string name)

Returns the specified parameter's value as a string.


method Parameter GetParameterByIndex (const int index)

Returns a parameter object by the given zero-based index.

Parameter objects are defined using the <parameter> tag in a jml file.


method Parameter GetParameterByName (const string name)

Returns a parameter object by the given parameter name.

Parameter objects are defined using the <parameter> tag in a jml file.


method View GetView (const string path)

Returns the view from the specified path in the view-tree.

The path is the combination of the view's name and all it's parent's names seperated by dot (.) characters. Any view may be retrieved, the returned object is generic for all views.


method Minimize ()

Minimizes the application.

Sends a message to the main window causing it to minimize itself.


method Quit ()

Terminates the application.

Sends a message to the main window causing it to close itself.


method SetListParameter (const string name, const string[] values)

Sets the specified 'stringlist' parameter to a list of strings.


method SetParameter (const string name, const string value)

Sets the specified parameter's value to a string.


accessor int InitialUpdate ()

Returns true if this is the first call to ParameterChanged(), false if it isn't.