LGUI2:Event Handlers

From Lavish Software Wiki
Jump to: navigation, search

LavishGUI 2 has a system of event handlers tied to Elements. Each element has a table of event names, which map to event handlers.

Defining an Event Handler

Each Event Handler is defined by a JSON object enclosed by {}, or JSON array enclosed by []. An object may be preferable for explicitness, or an array may be preferable for compactness.

As a JSON Array

When defining an Event Handler with a JSON array, each item in the array is expected to be a string, and we will refer to them as parameters.

The first parameter is to be the type of event handler, one of "code" or "method". Following the type parameter will be any type-specific parameters.

Event Handler types defined by JSON Arrays
  • code: Code requires only one additional parameter, being LavishScript code to execute. Example: ["code","echo Hi mom!"]
  • method: Method requires two parameters in this order. First, the LavishScript object (globally accessible) with the method to execute. Second, the name of the method to execute. Example: ["method","MyBindingController","IDidIt"]. This case is also equivalent to ["code","MyBindingController:IDidIt"].

As a JSON Object

When defining an Event Handler with a JSON object, each item in the object is expected to be a string, and we will refer to them as properties.

Event Handler properties
type One of "method" "code" or "forward", with additional properties below depending on the type
"forward" type
elementName (optional) The Name of a related element to forward to
elementType (optional) The Type of a related element to forward to
flags (optional) The relationships to search for the intended element; by default, only ancestors are searched.
"method" type
object The LavishScript object (globally accessible) with the method to execute
method The method on the object to execute
"code" type
code LavishScript code to execute


Examples

See lgui2eventargs for a detailed example using LavishScript methods.

LavishGUI 2 Topics