KUIML
Blue Cat's User Interface Programming Language
KUIML_WIDGET

Description

Widget that can dynamically load KUIML code (sub-skin") via a file or string. It can be used to load different content depending on the context, or load parts of a skin dynamically, only when required.

Warning: because all objects in KUIML may be stripped when not used by the skin, you need to make sure that the data accessed by the content of a sub-skin that is loaded at runtime will not be stripped, using for example the REQUIRED_OBJECTS element.

Inherited Attributes

See Attributes Common to Widgets.

Specific Attributes

None.

Name Value Type Default Value Description Comment V. Exp.

src

File path

empty

path to the kuiml file to load (relative to current skin path, root_path attribute or absolute)


2.4

2.4

innerKUIML

string

empty

KUIML code to be loaded by the widget

Overrides the src attribute when set (loads KUIML code from a string instead of file).

2.4

2.4

root_path

string

empty

List of root directories that can be used as root paths, separated by ';'.

Root paths used to find skin files defined by relative paths. This is useful when the root location of the skin files may change (Mac vs Windows, or username dependent paths etc.).

2.5

No

persistent

boolean

false

Sets the persistency of the widget.

When this property is set to 'true', the content of the KUIML widget is persistent: this includes the source (file or string) as well as the content of all persistent objects created inside the sub-skin.

2.4

No

load_enabled

boolean

true

When set to false, KUIML content is not loaded even when explicitly set by a script or link.

This attribute can be used for lazy loading KUIML widgets (loading on demand). Set to false by default and set to true when skin loading required.

2.6

2.6