c9ad2bd8daad1f394f31d3474ddac46f12bf5a1c
[scilab.git] / scilab / modules / gui / help / en_US / x_mdialog.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_mdialog">
3   <info>
4     <pubdate>$LastChangedDate$</pubdate>
5   </info>
6   <refnamediv>
7     <refname>x_mdialog</refname>
8     <refpurpose>Xwindow dialog</refpurpose>
9   </refnamediv>
10   <refsynopsisdiv>
11     <title>Calling Sequence</title>
12     <synopsis>result=x_mdialog(title,labels,default_inputs_vector)
13 result=x_mdialog(title,labelsv,labelsh,default_input_matrix)</synopsis>
14   </refsynopsisdiv>
15   <refsection>
16     <title>Parameters</title>
17     <variablelist>
18       <varlistentry>
19         <term>title</term>
20         <listitem>
21           <para>column vector of strings, dialog general comment</para>
22         </listitem>
23       </varlistentry>
24       <varlistentry>
25         <term>labels</term>
26         <listitem>
27           <para>n column vector of strings, <literal>labels(i)</literal> is the
28           label of the ith required value</para>
29         </listitem>
30       </varlistentry>
31       <varlistentry>
32         <term>default_input_vector</term>
33         <listitem>
34           <para>n column vector of strings,
35           <literal>default_input_vector(i)</literal> is the initial value of the ith
36           required value</para>
37         </listitem>
38       </varlistentry>
39       <varlistentry>
40         <term>labelsv</term>
41         <listitem>
42           <para>n vector of strings, <literal>labelsv(i)</literal> is the label of
43           the ith line of the required matrix</para>
44         </listitem>
45       </varlistentry>
46       <varlistentry>
47         <term>labelsh</term>
48         <listitem>
49           <para>m vector of strings, <literal>labelsh(j)</literal> is the label of
50           the jth column of the required matrix</para>
51         </listitem>
52       </varlistentry>
53       <varlistentry>
54         <term>default_input_matrix</term>
55         <listitem>
56           <para>n x m matrix of strings,
57           <literal>default_input_matrix(i,j)</literal> is the initial value of the
58           (i,j) element of then required matrix</para>
59         </listitem>
60       </varlistentry>
61       <varlistentry>
62         <term>result</term>
63         <listitem>
64           <para>n x m matrix of string if returned with "Ok" button or [] if
65           returned with "Cancel" button</para>
66         </listitem>
67       </varlistentry>
68     </variablelist>
69   </refsection>
70   <refsection>
71     <title>Description</title>
72     <para>X-window vector/matrix interactive input function</para>
73   </refsection>
74   <refsection>
75     <title>Examples</title>
76     <programlisting role="example"><![CDATA[ 
77 txt = ['magnitude';'frequency';'phase    '];
78 sig = x_mdialog('enter sine signal',txt,['1';'10';'0'])
79 mag = evstr(sig(1))
80 frq = evstr(sig(2))
81 ph  = evstr(sig(3))
82
83 rep = x_mdialog(['System Simulation';'with PI regulator'],...
84                  ['P gain';'I gain '],[' ';' '])
85  ]]></programlisting>
86   </refsection>
87   <refsection>
88     <title>See Also</title>
89     <simplelist type="inline">
90       <member>
91         <link linkend="editvar">editvar</link>
92       </member>
93       <member>
94         <link linkend="x_dialog">x_dialog</link>
95       </member>
96       <member>
97         <link linkend="x_choose">x_choose</link>
98       </member>
99       <member>
100         <link linkend="x_message">x_message</link>
101       </member>
102       <member>
103         <link linkend="getvalue">getvalue</link>
104       </member>
105       <member>
106         <link linkend="evstr">evstr</link>
107       </member>
108       <member>
109         <link linkend="execstr">execstr</link>
110       </member>
111       <member>
112         <link linkend="editvar">editvar</link>
113       </member>
114     </simplelist>
115   </refsection>
116 </refentry>