271f8ceae780d68cccaf994451d7a70d9ea9e0f4
[scilab.git] / scilab / modules / gui / help / en_US / x_dialog.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" version="5.0-subset Scilab" xml:lang="en" xml:id="x_dialog">
3     <refnamediv>
4         <refname>x_dialog</refname>
5         <refpurpose>Dialog for interactive multi-lines input.</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>result=x_dialog(labels,valueini)</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Arguments</title>
13         <variablelist>
14             <varlistentry>
15                 <term>labels</term>
16                 <listitem>
17                     <para>column vector of strings, comment for dialog</para>
18                 </listitem>
19             </varlistentry>
20             <varlistentry>
21                 <term>valueini</term>
22                 <listitem>
23                     <para>n column vector of strings, initial value suggested</para>
24                 </listitem>
25             </varlistentry>
26             <varlistentry>
27                 <term>result</term>
28                 <listitem>
29                     <para>User answer: n column vector of strings if returned with "Ok" button or [] if returned with "Cancel" button</para>
30                 </listitem>
31             </varlistentry>
32         </variablelist>
33     </refsection>
34     <refsection>
35         <title>Description</title>
36         <para>Opens a dialog for interactive multi-lines input.</para>
37     </refsection>
38     <refsection>
39         <title>Examples</title>
40         <programlisting role="example"><![CDATA[ 
41 gain=evstr(x_dialog('value of gain ?','0.235'))
42 x_dialog(['Method';'enter sampling period'],'1')
43 m=evstr(x_dialog('enter a  3x3 matrix ',['[0 0 0';'0 0 0';'0 0 0]']))
44  ]]></programlisting>
45     </refsection>
46     <refsection role="see also">
47         <title>See Also</title>
48         <simplelist type="inline">
49             <member>
50                 <link linkend="x_mdialog">x_mdialog</link>
51             </member>
52             <member>
53                 <link linkend="x_matrix">x_matrix</link>
54             </member>
55             <member>
56                 <link linkend="evstr">evstr</link>
57             </member>
58             <member>
59                 <link linkend="execstr">execstr</link>
60             </member>
61         </simplelist>
62     </refsection>
63 </refentry>