uimenu properties

Description

This page lists all available properties for menus in Scilab GUI.

These properties can be set at creation through uimenu function.

Their value can also be changed using the set function and read using the get function.

Properties

Callback

String

Instruction evaluated by the Scilab interpreter when the menu is activated. Under MacOSX, the callback will not be executed for a "button menu" (a menu without children), you must specify at least a child.

Enable

{on} | off

Enable or disable the menu. If this property is set to "on" (default), the menu is operational, but if this property is set to "off", the menu will not respond to the mouse actions and will be grayed out.

Checked

on | {off}

Item check indicator. Setting this property to "on" the first time displays a checkbox in head of the item's label, and then checks it. Setting "off" keeps the checkbox and unchecks it. This property can be used to display items indicating the state of particular options.

Remarks:

• There is no way to remove the checkbox after its creation, but deleting the item.
• By default, no interactive checking or unchecking is possible. Such interactions can be implemented through the Callback property.
• This property is ignored for parent menus.

ForegroundColor

[1,3] real vector or string

Foreground color of the uimenu (font color). A color is specified as Red, Green and Blue values. Those values are real in [0,1]. The color can be given as a real vector, ie [R,G,B] or a string where each value is separated by a "|", ie "R|G|B".

Icon

String.

This property represents the relative (to Scilab working directory) or absolute path of the image file to be used as icon for the menu.

Label

String.

This property represents the text appearing in the menu. If the text is enclosed between two $ (dollar sign), then it will be considered as a LaTeX expression, and if it is enclosed between < and >, it will be considered as a MathML one.

Tag

String

This property is generally used to identify the menu. It allows to give it a "name". Mainly used in conjunction with findobj().

Visible

{on} | off

Set the visibility of the uimenu. If this property is set to "on" (default), the uimenu is visible, but if this property is set to "off", the uimenu will not appear in its parent figure.

See also

• uicontextmenu — Create a menu or a submenu in a figure
• set — set a property value of a graphic entity object or of a User Interface object.
• get — Retrieve a property value from a graphics entity or an User Interface object.
• LaTeX and MathML — Display mathematical equations in Scilab graphics through the LaTeX or MathML languages.

History