- Scilab Help
- GUI
- Borders
- Layouts
- uitree
- about
- addmenu
- clipboard
- close
- Console properties
- createWindow
- delmenu
- exportUI
- figure
- findobj
- gcbo
- getcallbackobject
- getinstalledlookandfeels
- getlookandfeel
- getvalue
- Interactive Editor
- loadGui
- messagebox
- printfigure
- printsetupbox
- progressionbar
- root_properties
- saveGui
- setlookandfeel
- setmenu
- toolbar
- toprint
- tree_show
- uicontextmenu
- uicontrol
- uicontrol properties
- uigetcolor
- uigetdir
- uigetfile
- uigetfont
- uimenu
- uimenu properties
- uiputfile
- unsetmenu
- usecanvas
- waitbar
- x_choices
- x_choose
- x_choose_modeless
- x_dialog
- x_matrix
- x_mdialog
Please note that the recommended version of Scilab is 2024.1.0. This page might be outdated.
See the recommended documentation of this function
uicontrol properties
Description of the uicontrol properties.
Description
These properties can be set using the set or uicontrol functions and their value can be obtained with the get.
Properties
- BackgroundColor
[1,3] real vector or string
Background color of the uicontrol. 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".
Setting this property to
[-1 -1 -1]
will let the look and feel set the default background color.- Border
A Border object.
Only used for
frame
style uicontrols, this object is created using createBorder.Setting this value to
[]
removes the border of the frame.- Callback
String
Instruction evaluated by the Scilab interpreter when an uicontrol is activated (for example when you click on a button).
This property is not used for
layer
,frame
andtext
style uicontrols.- Callback_Type
Integer
The type of callback transmitted to the uicontrol.
-1
none (callback desactivated)0
a Scilab instruction1
a C or a Fortran function2
a Scilab function
- Constraints
A Constraints object.
This object is created using createConstraints and describes the constraints on the position and size of the uicontrol regarding to its parent.
Setting this value to
[]
clears the constraints.- Enable
{on} | off
Enable or disable the uicontrol. If this property is set to
"on"
(default), the uicontrol is operational, but if this property is set to"off"
, the uicontrol will not respond to the mouse actions and will be grayed out.- FontAngle
{normal} | italic | oblique
For a control containing some text, this property sets the slant of the font.
- FontSize
Scalar
For a control containing some text, this property sets the size of the font in FontUnits.
- FontUnits
{points} | pixels | normalized
For a control containing some text, this property sets the units with which the FontSize is specified.
- FontWeight
light | {normal} | demi | bold
For a control containing some text, this property sets the weight of the used font.
- FontName
String
Used to choose the name of the font selected to display the text of the control.
- ForegroundColor
[1,3] real vector or string
Foreground color of the uicontrol. 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".
Setting this property to
[-1 -1 -1]
will let the look and feel set the default foreground color.- Groupname
String
Used for
radiobutton
andcheckbox
style uicontrols, this property allow to manage uicontrols of the same group as a whole. For example,checkbox
uicontrols of a group will manage selection unicity automatically.- HorizontalAlignment
left | {center} | right
Set text horizontal alignment in the uicontrol.
- Icon
String.
This property represents the relative (to Scilab working directory) or absolute path of the image file to be used as icon for a
pushbutton
ortext
uicontrol.For
frame
uicontrols intab
uicontrols, the icon property sets the icon of its sheet.- Layout:
This property sets the layout used to dispose
frame
uicontrols children. See layout page for more information about available layouts.- Layout_options:
This property sets the options of the layout used to dispose
frame
children. See layout page for more information about available options.- ListboxTop
Scalar
Only used for
listbox
uicontrols, this property tells which item of the list appears on the first line of the visible area of the list.- Margins
[1,4] real vector.
Sets an empty space around the uicontrol under the form
[top, left, bottom, right]
(in pixels).- Max
Scalar
Specifies the largest value the "Value" property can be set to. It has however different meaning on each uicontrol:
checkbox
andradiobutton
uicontrols: Max is the value the "Value" property take when control is checked.slider
andspinner
uicontrols: Maximum value of the component.listbox
uicontrols: if (Max-Min)>1 the list allows multiple selection.edit
uicontrols: if (Max-Min)>1 the edit allows multiple line edition.
- Min
Scalar
Specifies the lowest value the "Value" property can be set to. It has however different meaning on each uicontrol:
checkbox
andradiobutton
uicontrols: Min is the value the "Value" property take when control is unchecked.slider
andspinner
uicontrols: Minimum value of the component.listbox
uicontrols: if (Max-Min)>1 the list allows multiple selection.edit
uicontrols: if (Max-Min)>1 the edit allows multiple line edition.
- Parent
Handle
Handle of the uicontrol parent. Changing this property allows to move a control from a figure to another.
- Position
[1,4] real vector or string.
This property is used to set or get the geometrical configuration of a control. It is a vector [x y w h] where the letters stand for the x location of the left bottom corner, the y location of the left bottom corner, the width and the height of the uicontrol or a character string where each value is separated by a "|", ie "x|y|w|h". The units are determined by the "Units" property.
The width and height values determine the orientation of sliders. If width is greater than height, then the slider is oriented horizontally, otherwise the slider is oriented vertically.
- Relief
{default} | flat | groove | raised | ridge | solid | sunken
Appearance of the border of the uicontrol.
"default"
means that the application look and feel will be used to set the relief.When using the deprecated skin for uicontrols, default values are related to uicontrol style:
pushbutton
uicontrols: the default value for "Relief" property is "raised".edit
uicontrols: the default value for "Relief" property is "sunken".Other uicontrols: the default value for "Relief" property is "flat".
- Scrollable
Boolean.
Used for
frame
andedit
style uicontrols, this property indicates if the uicontrol must have scrolling capabilities (%T
) or not (default%F
).For
frame
this value must be set at creation.- SliderStep
[1,2] real vector
[small big], the small step represents the movement achieved when clicking on the slider trough or tapping on the keyboard arrows (when the slider has focus); the big step is the amount moved when using Ctrl-keyboard-arrows. If the big step is omitted, it is defaulted to 1/10 of the scale.
For
spinner
uicontrol, the first value of this property is used as fixed step.- String
String.
This property represents the text appearing in a uicontrol (Except for Frame and Slider styles). For tables, the value is a string matrix. For ListBoxes and PopupMenus, the value can be a vector of string or a string where the items are separated by a "|". For Text uicontrols, this string can contain HTML code to format the text.
For
pushbutton
ortext
uicontrols, 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.For
layer
andtab
uicontrols, the value specifies the tag of the selected child.For
image
uicontrols, the value specifies the path of the image file.For
table
uicontrols, the value specifies the whole table data:[IGNORED COL1-HEADER...COLN-HEADER;ROW1-HEADER, ROW1COL1-DATA, ROW1COLN-DATA;...;ROWM-HEADER, ROWMCOL1-DATA, ROWMCOLN-DATA]
.For
listbox
andpopupmenu
uicontrols which manage colors selection, icons, background and foreground colors, theString
property can be set to a matrix matching the format:["#color1", "Item1", "#background1", "#foreground1"; "#color2", "Item2", ..., ...]
["icon1", "Item1", "#background1", "#foreground1"; "icon2", "Item2", ..., ...]
with"#color1"
,"#background1"
and"#foreground1"
in HTML format#XXXXXX
. Then the component will display a colored box or icon on the left of the associated string, and different background/foreground colors for items.
- Tag
String
This property is generally used to identify the control. It allows to give it a "name". Mainly used in conjunction with
findobj()
.- Title_position
{top} | left | bottom | right
The position of the tabs of a
tab
style uicontrol.- Title_scroll
Boolean
Indicates whether the tabs of a
tab
style uicontrol must be wrapped (title_scroll=%F
) or scrolled (title_scroll=%T
).- TooltipString
String or String vector
This property represents the text of the uicontrol tooltip appearing when the mouse is over the uicontrol.
- Units
{points} | pixels | normalized
Set the units used to specify the "Position" property.
- Userdata
Scilab data
This can be used to associate some Scilab objects (string,string matrix, matrix mxn) to an uicontrol.
- Value
Scalar or vector
Value of the uicontrol. The exact meaning depends on the style of the uicontrol:
checkbox
andradiobutton
uicontrols: value is set to Max (see above) when on and Min when off.listbox
andpopupmenu
uicontrols: value is a vector of indexes corresponding to the indexes of the selected entries in the list. 1 is the first item of the list.slider
andspinner
uicontrols: value indicated by the component.layer
andtab
uicontrols: index of displayed component.image
uicontrols: value is used to set some image properties[X-Scale Y-Scale X-Shear Y-Shear RotationAngle]
- Verticalalignment
top | {middle} | bottom
Set text vertical alignment in the uicontrol. This property has only effect with Text and CheckBoxes styles.
- Visible
{on} | off
Set the visibility of the uicontrol. If this property is set to
"on"
(default), the uicontrol is visible, but if this property is set to"off"
, the uicontrol will not appear in its parent figure.
See Also
History
Version | Description |
5.5.0 | Properties added and updated:
|
Report an issue | ||
<< uicontrol | GUI | uigetcolor >> |