Storyboard Lua GREDOM API
The Storyboard gredom Lua module provides a limited access to the hierarchical model used by the Storyboard Engine. This functionality is provided in a separate plugin (plugins/libgre-plugin-luagredom.so) and should be available for any target platform that contains the Lua Storyboard plugin. Client can check for the existence of the DOM module by checking that the symbol gredom is not nil.
The DOM module provides two sets of function interfaces. The first set of functions are associated with the gredom namespace and are used to lookup or access an Lua object (table) that contains a special set of methods (metatable entries) that are used to extract additional information about the object. In this documentation the object returned from the gredom namespace functions will be referred to as a DOMOBJECT object.
Methods associated with the DOMOBJECT object must be invoked using the Lua colon (:) notation for example DOMOBJECT:get_name().
DOMOBJECT
11 items
CONTROL
16 items
GROUP
10 items
TABLE
3 items
LAYERINSTANCE
21 items
SCREEN
SCREEN is the class for Lua objects that represent Storyboard screen model objects. SCREEN extends DOMOBJECT so objects of this type can also invoke all the functions of DOMOBJECT.
gredom.get_application
Get an object handle for the application root
gredom.get_control
Get a CONTROL object for the model object matching the fully qualified name.
gredom.get_group
Get a GROUP object for the model object matching the fully qualified name.
gredom.get_layer
Get a LAYER object for the model object matching the fully qualified name.
gredom.get_layer_instance
Get a LAYERINSTANCE object for the model object matching the fully qualified name.
gredom.get_object
Get an object handle for the model object matching the specified fully qualified name.
gredom.get_screen
Get a SCREEN object for the model object matching the fully qualified name.
gredom.get_table
Get a TABLE object for the model object matching the fully qualified name.