Typo fixes
[scilab.git] / scilab / modules / gui / help / en_US / layout / createConstraints.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="createConstraints">
3     <refnamediv>
4         <refname>createConstraints</refname>
5         <refpurpose>Creates the layout constraints structure for a uicontrol.</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>
10             constraints = createConstraints(constraintsType, varargin)
11         </synopsis>
12     </refsynopsisdiv>
13     <refsection>
14         <title>Arguments</title>
15         <variablelist>
16             <varlistentry>
17                 <term>constraintsType</term>
18                 <listitem>
19                     <para>String</para>
20                     <para>The type of the layout constraints to be created. Available types of constraints are listed below and their specific properties are detailled on dedicated help page:</para>
21                     <itemizedlist>
22                         <listitem>
23                             <para>
24                                 "none" or "nolayout": No constraints will be added to the uicontrol layout.
25                             </para>
26                         </listitem>
27                         <listitem>
28                             <para>
29                                 "grid": A <link linkend="grid_constraints_properties">grid layout constraint</link>.
30                             </para>
31                         </listitem>
32                         <listitem>
33                             <para>
34                                 "border": A <link linkend="border_constraints_properties">border layout constraint</link>.
35                             </para>
36                         </listitem>
37                         <listitem>
38                             <para>
39                                 "gridbag": A <link linkend="gridbag_constraints_properties">gridbag layout constraint</link>.
40                             </para>
41                         </listitem>
42                     </itemizedlist>
43                 </listitem>
44             </varlistentry>
45             <varlistentry>
46                 <term>varargin</term>
47                 <listitem>
48                     <para>
49                         All <literal>constraintsType</literal> specific properties.
50                     </para>
51                 </listitem>
52             </varlistentry>
53             <varlistentry>
54                 <term>constraints</term>
55                 <listitem>
56                     <para>The created constraints.</para>
57                 </listitem>
58             </varlistentry>
59         </variablelist>
60     </refsection>
61     <refsection>
62         <title>Description</title>
63         <para>
64             This function creates the constraints structure for uicontrols <literal>constraints</literal> attribute. See <link linkend="uicontrol_properties">uicontrol properties</link> for more details.
65         </para>
66     </refsection>
67     <refsection role="see also">
68         <title>See Also</title>
69         <simplelist type="inline">
70             <member>
71                 <link linkend="uicontrol">uicontrol</link>
72             </member>
73             <member>
74                 <link linkend="uicontrol_properties">uicontrol_properties</link>
75             </member>
76         </simplelist>
77     </refsection>
78     <refsection>
79         <title>History</title>
80         <revhistory>
81             <revision>
82                 <revnumber>5.5.0</revnumber>
83                 <revremark>
84                     Function <function>createBorder</function> introduced.
85                 </revremark>
86             </revision>
87         </revhistory>
88     </refsection>
89 </refentry>