Root properties

Description

The Root entity is a virtual graphical object which is the top level of the graphics entities hierarchy. It is used to modify some general properties for handles and uicontrols and to get the computer screen properties. Its properties may be addressed through its handle as returned by get(0).

Properties which can be modified are the following:

ShowHiddenHandles

A boolean or a string

Manages the display of all children handles in figures including default menus ones.

Default value is "off".

UseDeprecatedSkin

A boolean or a string

Manages the rendering of uicontrols.

Default value is "off" and uicontrols look and feel is managed by operating system.

Setting this value to "on" or %T will make the uicontrols have an old TK look and feel.

ShowHiddenProperties

A boolean or a string

Manages the display of uicontrols properties.

Default value is "off" and only the uicontrols properties used on the Java side are displayed.

Setting this value to "on" or %T will make all available properties displayed (for example a ListboxTop property will be displayed for pushbutton uicontrols.

Units

A string among "points", "normalized", "inches", "centimeters" or "pixels".

Default value is "pixels".

Userdata

Any data of any type, that you want to assign to the root entity.

Tag

Single string, that can be used as a root custom text id.

Read-only properties are:

pointer_location

The coordinates of mouse pointer in current units.

screensize

The screen size in current units.

screendepth

The number of bits used to encode colors.

Examples

f = gcf() // Do no display hidden handles
r = get(0);
r.ShowHiddenHandles = "on";
f = gcf() // Show menu handles as children

h = uicontrol(); // Button with OS look & feel
r.UseDeprecatedSkin = "on"
h = uicontrol(); // Button with old TK look & feel

h = uicontrol() // Minimal display of properties
r.ShowHiddenProperties = "on"
h = uicontrol() // Full display of properties

get(0, "screensize")
get(0, "screendepth")

get(0, "Units")
set(0, "Units", "centimeters")

See also

• console_properties — Description of console object properties.
• system_setproperty — set a system property for a given JVM key to a given value.
• getsystemmetrics — Retrieves the specified system metric or system configuration setting (Windows only)
• setlookandfeel — sets the current default look and feel.
• uicontrol — create a Graphic User Interface object
• usecanvas — Get/Set the main component used for Scilab graphics.
• preferences — Open the Scilab Preferences window
• printsetupbox — Display print dialog box.