bug 4852
[scilab.git] / scilab / modules / gui / help / en_US / x_message.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_message">
3   <info>
4     <pubdate>$LastChangedDate$</pubdate>
5   </info>
6   <refnamediv>
7     <refname>x_message</refname>
8     <refpurpose> X window message</refpurpose>
9   </refnamediv>
10   <refsynopsisdiv>
11     <title>Calling Sequence</title>
12     <synopsis>[num]=x_message(strings [,buttons])</synopsis>
13   </refsynopsisdiv>
14   <refsection>
15     <title>Parameters</title>
16     <variablelist>
17       <varlistentry>
18         <term>strings</term>
19         <listitem>
20           <para>vector of characters strings to be displayed</para>
21         </listitem>
22       </varlistentry>
23       <varlistentry>
24         <term>buttons</term>
25         <listitem>
26           <para>character string or 2 vector of character strings which specifies button(s) name(s). Default value is "Ok"</para>
27         </listitem>
28       </varlistentry>
29       <varlistentry>
30         <term>num</term>
31         <listitem>
32           <para>number  of button clicked (if 2 buttons are specified)</para>
33         </listitem>
34       </varlistentry>
35     </variablelist>
36   </refsection>
37   <refsection>
38     <title>Description</title>
39     <para>
40     for displaying a message (diagnostic,... ) and waiting for
41     an answer (button click). The function returns only after a click on a
42     button.</para>
43   </refsection>
44   <refsection>
45     <title>Examples</title>
46     <programlisting role="example"><![CDATA[ 
47 gain = 0.235;x_message('value of gain is :'+string(gain))
48 x_message(['singular matrix';'use least squares'])
49
50 r = x_message(['Your problem is ill conditioned';
51                'continue ?'],['Yes','No'])
52  ]]></programlisting>
53   </refsection>
54   <refsection>
55     <title>See Also</title>
56     <simplelist type="inline">
57       <member>
58         <link linkend="x_dialog">x_dialog</link>
59       </member>
60       <member>
61         <link linkend="x_mdialog">x_mdialog</link>
62       </member>
63       <member>
64         <link linkend="x_message_modeless">x_message_modeless</link>
65       </member>
66     </simplelist>
67   </refsection>
68 </refentry>