Split uicontrol/uicontrol_properties help pages 08/14008/2
Vincent COUVERT [Thu, 13 Mar 2014 11:59:56 +0000 (12:59 +0100)]
Change-Id: Ice47b043de58938d75e2c031e6cac8f0d59e1c68

scilab/modules/gui/help/en_US/uicontrol.xml
scilab/modules/gui/help/en_US/uicontrol_properties.xml [new file with mode: 0644]

index a89f6d7..483b928 100644 (file)
@@ -31,7 +31,7 @@
             fields.
         </para>
         <para>
-            <literal>h= uicontrol(PropertyName, PropertyValue,...)</literal>
+            <literal>h = uicontrol(PropertyName, PropertyValue,...)</literal>
             creates an uicontrol and assigns the specified properties and values to
             it. It assigns the default values to any properties you do not specify.
             The default uicontrol style is a "Pushbutton". The default parent is the
             other properties.
         </para>
         <para>
-            <literal>h= uicontrol(parent, PropertyName,
-                PropertyValue,...)
-            </literal>
+            <literal>h = uicontrol(parent, PropertyName, PropertyValue,...) </literal>
             creates a uicontrol in the object specified
             by the handle, parent. If you also specify a different value for the
             Parent property, the value of the Parent property takes precedence. parent
             is the handle of a figure.
         </para>
         <para>
-            <literal>h= uicontrol(uich)</literal> gives focus to the uicontrol
+            <literal>h = uicontrol(uich)</literal> gives focus to the uicontrol
             specified by uich.
         </para>
+        <para>
+            All available properties and their description are given in the <link linkend="uicontrol_properties">uicontrol properties</link> help page.
+        </para>
     </refsection>
     <refsection>
-        <title>Properties</title>
-        <variablelist>
-            <varlistentry>
-                <term>BackgroundColor</term>
-                <listitem>
-                    <para>[1,3] real vector or string</para>
-                    <para>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".
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Callback</term>
-                <listitem>
-                    <para>String</para>
-                    <para>Instruction evaluated by the Scilab interpreter when an
-                        uicontrol is activated. (for example when you click on a
-                        button).
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Callback_Type</term>
-                <listitem>
-                    <para>Integer</para>
-                    <para>The type of callback transmitted to the uicontrol.</para>
-                    <itemizedlist>
-                        <listitem>
-                            <para>
-                                <literal>-1</literal> none (callback desactivated)
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>
-                                <literal>0</literal> a Scilab instruction
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>
-                                <literal>1</literal> a C or a Fortran function
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>
-                                <literal>2</literal> a Scilab function
-                            </para>
-                        </listitem>
-                    </itemizedlist>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Enable</term>
-                <listitem>
-                    <para>{on} | off</para>
-                    <para>
-                        Enable or disable the uicontrol. If this property is set to <literal>"on"</literal> (default), the uicontrol is operational,
-                        but if this property is set to <literal>"off"</literal>, the uicontrol will not respond to the mouse actions and will be grayed out.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>FontAngle</term>
-                <listitem>
-                    <para>{normal} | italic | oblique</para>
-                    <para>For a control containing some text, this property sets the
-                        slant of the font.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>FontSize</term>
-                <listitem>
-                    <para>Scalar</para>
-                    <para>For a control containing some text, this property sets the
-                        size of the font in FontUnits.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>FontUnits</term>
-                <listitem>
-                    <para>{points} | pixels | normalized</para>
-                    <para>For a control containing some text, this property sets the
-                        units with which the FontSize is specified.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>FontWeight</term>
-                <listitem>
-                    <para>light | {normal} | demi | bold</para>
-                    <para>For a control containing some text, this property sets the
-                        weight of the used font.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>FontName</term>
-                <listitem>
-                    <para>String</para>
-                    <para>Used to choose the name of the font selected to display the
-                        text of the control.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>ForegroundColor</term>
-                <listitem>
-                    <para>[1,3] real vector or string</para>
-                    <para>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".
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>HorizontalAlignment</term>
-                <listitem>
-                    <para>left | {center} | right</para>
-                    <para>Set text horizontal alignment in the uicontrol. This property
-                        has only effect with Text, Edit and Check Boxes.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>ListboxTop</term>
-                <listitem>
-                    <para>Scalar</para>
-                    <para>For a ListBox, this property tells which item of the list
-                        appears on the first line of the visible area of the list.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Max</term>
-                <listitem>
-                    <para>Scalar</para>
-                    <para>Specifies the largest value the "Value" property can be set
-                        to. It has however different meaning on each uicontrol:
-                    </para>
-                    <itemizedlist>
-                        <listitem>
-                            <para>CheckBoxes: Max is the value the "Value" property take
-                                when control is checked.
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>Sliders: Maximum value of the slider.</para>
-                        </listitem>
-                        <listitem>
-                            <para>ListBoxes: if (Max-Min)&gt;1 the list allows multiple
-                                selection, Otherwise not.
-                            </para>
-                        </listitem>
-                    </itemizedlist>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Min</term>
-                <listitem>
-                    <para>Scalar</para>
-                    <para>Specifies the lowest value the "Value" property can be set to.
-                        It has however different meaning on each uicontrol:
-                    </para>
-                    <itemizedlist>
-                        <listitem>
-                            <para>CheckBoxes: Min is the value the "Value" property take
-                                when control is unchecked.
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>Sliders: Minimum value of the slider.</para>
-                        </listitem>
-                        <listitem>
-                            <para>ListBoxes: if (Max-Min)&gt;1 the list allows multiple
-                                selection, Otherwise not.
-                            </para>
-                        </listitem>
-                    </itemizedlist>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Parent</term>
-                <listitem>
-                    <para>Handle</para>
-                    <para>Handle of the uicontrol parent. Changing this property allows
-                        to move a control from a figure to another.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Path</term>
-                <listitem>
-                    <para>This property is no more supported.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Position</term>
-                <listitem>
-                    <para>[1,4] real vector or string.</para>
-                    <para>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.
-                    </para>
-                    <para>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.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Relief</term>
-                <listitem>
-                    <para>{default} | flat | groove | raised | ridge | solid | sunken</para>
-                    <para>
-                        Appearance of the border of the uicontrol. <literal>"default"</literal> means that the application look and feel will be used to set the relief.
-                    </para>
-                    <para>When using the deprecated skin for uicontrols, default values are related to uicontrol style:</para>
-                    <itemizedlist>
-                        <listitem>
-                            <para>PushButtons: the default value for "Relief" property is
-                                "raised".
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>Edits: the default value for "Relief" property is
-                                "sunken".
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>Other styles: the default value for "Relief" property is
-                                "flat".
-                            </para>
-                        </listitem>
-                    </itemizedlist>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>SliderStep</term>
-                <listitem>
-                    <para>[1,2] real vector</para>
-                    <para>[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.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>String</term>
-                <listitem>
-                    <para>String.</para>
-                    <para>
-                        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.
-                    </para>
-                    <para>
-                        For Pushbutton or Text 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 &lt; and &gt;, it will be considered
-                        as a MathML one.
-                    </para>
-                    <para>
-                        For Image, the value specifies the path of the image file.
-                    </para>
-                    <para>
-                        For Table, the value specifies the whole table data: <literal>[IGNORED COL1-HEADER...COLN-HEADER;ROW1-HEADER, ROW1COL1-DATA, ROW1COLN-DATA;...;ROWM-HEADER, ROWMCOL1-DATA, ROWMCOLN-DATA]</literal>.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>TooltipString</term>
-                <listitem>
-                    <para>String or String vector</para>
-                    <para>
-                        This property represents the text of the uicontrol tooltip appearing when the mouse is over the uicontrol.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Style</term>
-                <listitem>
-                    <para>{pushbutton} | radiobutton | checkbox | edit | text | slider |
-                        frame | listbox | popupmenu | image | table
-                    </para>
-                    <para>Style of the uicontrol. This property has to be set at creation time and can not be changed once the uicontrol is created. Here is a short description of each
-                        one:
-                    </para>
-                    <itemizedlist>
-                        <listitem>
-                            <para>Pushbutton: a rectangular button generally used to run a
-                                callback.
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>Radiobutton: a button with two states. RadioButtons are
-                                intended to be mutually exclusive (Your code must implement
-                                mutually exclusive behavior).
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>Checkbox: a button with two states (Used for multiple
-                                independent choices).
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>Edit: an editable string zone.</para>
-                        </listitem>
-                        <listitem>
-                            <para>Text: a text control (generally static).</para>
-                        </listitem>
-                        <listitem>
-                            <para>Slider: a scale control, that is a scrollbar use to set
-                                values between in range with the mouse.
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>Frame: a control representing a zone used to group related
-                                controls.
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>Listbox: a control representing a list of items that can
-                                be scrolled. The items can be selected with the mouse.
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>Popupmenu: a button which make a menu appear when
-                                clicked.
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>Image: a sub-window where the image specified is displayed.</para>
-                        </listitem>
-                        <listitem>
-                            <para>Table: an editable table.</para>
-                        </listitem>
-                    </itemizedlist>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Tag</term>
-                <listitem>
-                    <para>String</para>
-                    <para>This property is generally used to identify the control. It
-                        allows to give it a "name". Mainly used in conjunction with
-                        <literal>findobj()</literal>.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Units</term>
-                <listitem>
-                    <para>{points} | pixels | normalized</para>
-                    <para>Set the units used to specify the "Position" property.</para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Userdata</term>
-                <listitem>
-                    <para>Scilab data</para>
-                    <para>This can be used to associate some Scilab objects
-                        (string,string matrix, matrix mxn) to an uicontrol.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Value</term>
-                <listitem>
-                    <para>Scalar or vector</para>
-                    <para>Value of the uicontrol. The exact meaning depends on the style
-                        of the uicontrol:
-                    </para>
-                    <itemizedlist>
-                        <listitem>
-                            <para>CheckBoxes, Radio buttons: value is set to Max (see above)
-                                when on and Min when off.
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>ListBoxes, PopupMenus: 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.
-                            </para>
-                        </listitem>
-                        <listitem>
-                            <para>Sliders: value indicated by the slider bar.</para>
-                        </listitem>
-                        <listitem>
-                            <para>
-                                Images: value is used to set some image properties <literal>[X-Scale Y-Scale X-Shear Y-Shear RotationAngle]</literal>
-                            </para>
-                        </listitem>
-                    </itemizedlist>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Verticalalignment</term>
-                <listitem>
-                    <para>top | {middle} | bottom</para>
-                    <para>Set text vertical alignment in the uicontrol. This property
-                        has only effect with Text and CheckBoxes styles.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Visible</term>
-                <listitem>
-                    <para>{on} | off</para>
-                    <para>
-                        Set the visibility of the uicontrol. If this property is set to <literal>"on"</literal> (default), the uicontrol is visible,
-                        but if this property is set to <literal>"off"</literal>, the uicontrol will not appear in its parent figure.
-                    </para>
-                </listitem>
-            </varlistentry>
-        </variablelist>
+        <title>Available styles</title>
+        <para>
+            The available styles are listed below. The <literal>style</literal> of an <literal>uicontrol</literal> must be set at creation using the <literal>"Style"</literal> property and can not be changed once the <literal>uicontrol</literal> is created.
+        </para>
+        <itemizedlist>
+            <listitem>
+                <para>Pushbutton: (default style)a rectangular button generally used to run a callback.
+                </para>
+            </listitem>
+            <listitem>
+                <para>Radiobutton: a button with two states. RadioButtons are
+                    intended to be mutually exclusive (Your code must implement
+                    mutually exclusive behavior).
+                </para>
+            </listitem>
+            <listitem>
+                <para>Checkbox: a button with two states (Used for multiple
+                    independent choices).
+                </para>
+            </listitem>
+            <listitem>
+                <para>Edit: an editable string zone.</para>
+            </listitem>
+            <listitem>
+                <para>Text: a text control (generally static).</para>
+            </listitem>
+            <listitem>
+                <para>Slider: a scale control, that is a scrollbar use to set
+                    values between in range with the mouse.
+                </para>
+            </listitem>
+            <listitem>
+                <para>Frame: a control representing a zone used to group related
+                    controls.
+                </para>
+            </listitem>
+            <listitem>
+                <para>Listbox: a control representing a list of items that can
+                    be scrolled. The items can be selected with the mouse.
+                </para>
+            </listitem>
+            <listitem>
+                <para>Popupmenu: a button which make a menu appear when
+                    clicked.
+                </para>
+            </listitem>
+            <listitem>
+                <para>Image: a sub-window where the image specified is displayed.</para>
+            </listitem>
+            <listitem>
+                <para>Table: an editable table.</para>
+            </listitem>
+        </itemizedlist>
     </refsection>
     <refsection>
         <title>Examples</title>
@@ -547,6 +179,9 @@ matrix(ut.string,size(table))
         <title>See Also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="uicontrol_properties">uicontrol_properties</link>
+            </member>
+            <member>
                 <link linkend="figure">figure</link>
             </member>
             <member>
diff --git a/scilab/modules/gui/help/en_US/uicontrol_properties.xml b/scilab/modules/gui/help/en_US/uicontrol_properties.xml
new file mode 100644 (file)
index 0000000..f2223cb
--- /dev/null
@@ -0,0 +1,391 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="uicontrol_properties" xml:lang="en">
+    <refnamediv>
+        <refname>uicontrol properties</refname>
+        <refpurpose>Description of the uicontrol properties.</refpurpose>
+    </refnamediv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            These properties can be set using the <link linkend="set">set</link> or <link linkend="uicontrol">uicontrol</link>
+            functions and their value can be obtained with the <link linkend="get">get</link>.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Properties</title>
+        <variablelist>
+            <varlistentry>
+                <term>BackgroundColor</term>
+                <listitem>
+                    <para>[1,3] real vector or string</para>
+                    <para>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".
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Callback</term>
+                <listitem>
+                    <para>String</para>
+                    <para>Instruction evaluated by the Scilab interpreter when an
+                        uicontrol is activated. (for example when you click on a
+                        button).
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Callback_Type</term>
+                <listitem>
+                    <para>Integer</para>
+                    <para>The type of callback transmitted to the uicontrol.</para>
+                    <itemizedlist>
+                        <listitem>
+                            <para>
+                                <literal>-1</literal> none (callback desactivated)
+                            </para>
+                        </listitem>
+                        <listitem>
+                            <para>
+                                <literal>0</literal> a Scilab instruction
+                            </para>
+                        </listitem>
+                        <listitem>
+                            <para>
+                                <literal>1</literal> a C or a Fortran function
+                            </para>
+                        </listitem>
+                        <listitem>
+                            <para>
+                                <literal>2</literal> a Scilab function
+                            </para>
+                        </listitem>
+                    </itemizedlist>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Enable</term>
+                <listitem>
+                    <para>{on} | off</para>
+                    <para>
+                        Enable or disable the uicontrol. If this property is set to <literal>"on"</literal> (default), the uicontrol is operational,
+                        but if this property is set to <literal>"off"</literal>, the uicontrol will not respond to the mouse actions and will be grayed out.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>FontAngle</term>
+                <listitem>
+                    <para>{normal} | italic | oblique</para>
+                    <para>For a control containing some text, this property sets the
+                        slant of the font.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>FontSize</term>
+                <listitem>
+                    <para>Scalar</para>
+                    <para>For a control containing some text, this property sets the
+                        size of the font in FontUnits.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>FontUnits</term>
+                <listitem>
+                    <para>{points} | pixels | normalized</para>
+                    <para>For a control containing some text, this property sets the
+                        units with which the FontSize is specified.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>FontWeight</term>
+                <listitem>
+                    <para>light | {normal} | demi | bold</para>
+                    <para>For a control containing some text, this property sets the
+                        weight of the used font.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>FontName</term>
+                <listitem>
+                    <para>String</para>
+                    <para>Used to choose the name of the font selected to display the
+                        text of the control.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>ForegroundColor</term>
+                <listitem>
+                    <para>[1,3] real vector or string</para>
+                    <para>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".
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>HorizontalAlignment</term>
+                <listitem>
+                    <para>left | {center} | right</para>
+                    <para>Set text horizontal alignment in the uicontrol. This property
+                        has only effect with Text, Edit and Check Boxes.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>ListboxTop</term>
+                <listitem>
+                    <para>Scalar</para>
+                    <para>For a ListBox, this property tells which item of the list
+                        appears on the first line of the visible area of the list.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Max</term>
+                <listitem>
+                    <para>Scalar</para>
+                    <para>Specifies the largest value the "Value" property can be set
+                        to. It has however different meaning on each uicontrol:
+                    </para>
+                    <itemizedlist>
+                        <listitem>
+                            <para>CheckBoxes: Max is the value the "Value" property take
+                                when control is checked.
+                            </para>
+                        </listitem>
+                        <listitem>
+                            <para>Sliders: Maximum value of the slider.</para>
+                        </listitem>
+                        <listitem>
+                            <para>ListBoxes: if (Max-Min)&gt;1 the list allows multiple
+                                selection, Otherwise not.
+                            </para>
+                        </listitem>
+                    </itemizedlist>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Min</term>
+                <listitem>
+                    <para>Scalar</para>
+                    <para>Specifies the lowest value the "Value" property can be set to.
+                        It has however different meaning on each uicontrol:
+                    </para>
+                    <itemizedlist>
+                        <listitem>
+                            <para>CheckBoxes: Min is the value the "Value" property take
+                                when control is unchecked.
+                            </para>
+                        </listitem>
+                        <listitem>
+                            <para>Sliders: Minimum value of the slider.</para>
+                        </listitem>
+                        <listitem>
+                            <para>ListBoxes: if (Max-Min)&gt;1 the list allows multiple
+                                selection, Otherwise not.
+                            </para>
+                        </listitem>
+                    </itemizedlist>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Parent</term>
+                <listitem>
+                    <para>Handle</para>
+                    <para>Handle of the uicontrol parent. Changing this property allows
+                        to move a control from a figure to another.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Path</term>
+                <listitem>
+                    <para>This property is no more supported.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Position</term>
+                <listitem>
+                    <para>[1,4] real vector or string.</para>
+                    <para>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.
+                    </para>
+                    <para>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.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Relief</term>
+                <listitem>
+                    <para>{default} | flat | groove | raised | ridge | solid | sunken</para>
+                    <para>
+                        Appearance of the border of the uicontrol. <literal>"default"</literal> means that the application look and feel will be used to set the relief.
+                    </para>
+                    <para>When using the deprecated skin for uicontrols, default values are related to uicontrol style:</para>
+                    <itemizedlist>
+                        <listitem>
+                            <para>PushButtons: the default value for "Relief" property is
+                                "raised".
+                            </para>
+                        </listitem>
+                        <listitem>
+                            <para>Edits: the default value for "Relief" property is
+                                "sunken".
+                            </para>
+                        </listitem>
+                        <listitem>
+                            <para>Other styles: the default value for "Relief" property is
+                                "flat".
+                            </para>
+                        </listitem>
+                    </itemizedlist>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>SliderStep</term>
+                <listitem>
+                    <para>[1,2] real vector</para>
+                    <para>[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.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>String</term>
+                <listitem>
+                    <para>String.</para>
+                    <para>
+                        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.
+                    </para>
+                    <para>
+                        For Pushbutton or Text 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 &lt; and &gt;, it will be considered
+                        as a MathML one.
+                    </para>
+                    <para>
+                        For Image, the value specifies the path of the image file.
+                    </para>
+                    <para>
+                        For Table, the value specifies the whole table data: <literal>[IGNORED COL1-HEADER...COLN-HEADER;ROW1-HEADER, ROW1COL1-DATA, ROW1COLN-DATA;...;ROWM-HEADER, ROWMCOL1-DATA, ROWMCOLN-DATA]</literal>.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>TooltipString</term>
+                <listitem>
+                    <para>String or String vector</para>
+                    <para>
+                        This property represents the text of the uicontrol tooltip appearing when the mouse is over the uicontrol.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Tag</term>
+                <listitem>
+                    <para>String</para>
+                    <para>This property is generally used to identify the control. It
+                        allows to give it a "name". Mainly used in conjunction with
+                        <literal>findobj()</literal>.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Units</term>
+                <listitem>
+                    <para>{points} | pixels | normalized</para>
+                    <para>Set the units used to specify the "Position" property.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Userdata</term>
+                <listitem>
+                    <para>Scilab data</para>
+                    <para>This can be used to associate some Scilab objects
+                        (string,string matrix, matrix mxn) to an uicontrol.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Value</term>
+                <listitem>
+                    <para>Scalar or vector</para>
+                    <para>Value of the uicontrol. The exact meaning depends on the style
+                        of the uicontrol:
+                    </para>
+                    <itemizedlist>
+                        <listitem>
+                            <para>CheckBoxes, Radio buttons: value is set to Max (see above)
+                                when on and Min when off.
+                            </para>
+                        </listitem>
+                        <listitem>
+                            <para>ListBoxes, PopupMenus: 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.
+                            </para>
+                        </listitem>
+                        <listitem>
+                            <para>Sliders: value indicated by the slider bar.</para>
+                        </listitem>
+                        <listitem>
+                            <para>
+                                Images: value is used to set some image properties <literal>[X-Scale Y-Scale X-Shear Y-Shear RotationAngle]</literal>
+                            </para>
+                        </listitem>
+                    </itemizedlist>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Verticalalignment</term>
+                <listitem>
+                    <para>top | {middle} | bottom</para>
+                    <para>Set text vertical alignment in the uicontrol. This property
+                        has only effect with Text and CheckBoxes styles.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Visible</term>
+                <listitem>
+                    <para>{on} | off</para>
+                    <para>
+                        Set the visibility of the uicontrol. If this property is set to <literal>"on"</literal> (default), the uicontrol is visible,
+                        but if this property is set to <literal>"off"</literal>, the uicontrol will not appear in its parent figure.
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="set">set</link>
+            </member>
+            <member>
+                <link linkend="get">get</link>
+            </member>
+            <member>
+                <link linkend="uicontrol">uicontrol</link>
+            </member>
+        </simplelist>
+    </refsection>
+</refentry>