ISO-8859-1 to UTF-8
[scilab.git] / scilab / modules / gui / help / en_US / messagebox.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="messagebox">
3   <info>
4     <pubdate>$LastChangedDate: 2007-12-07 11:59:53 +0100 (ven, 07 déc 2007) $</pubdate>
5   </info>
6   <refnamediv>
7     <refname>messagebox</refname>
8     <refpurpose>Open a message box.</refpurpose>
9   </refnamediv>
10   <refsynopsisdiv>
11     <title>Calling Sequence</title>
12     <synopsis>
13     [btn] = messagebox(msg)
14     [btn] = messagebox(msg, msgboxtitle)
15     [btn] = messagebox(msg, msgboxtitle, msgboxicon)
16     [btn] = messagebox(msg, msgboxtitle, msgboxicon)
17     [btn] = messagebox(msg, msgboxtitle, msgboxicon, buttons)
18     [btn] = messagebox(msg, msgboxtitle, msgboxicon, buttons, ismodal)
19     </synopsis>
20   </refsynopsisdiv>
21   <refsection>
22     <title>Parameters</title>
23     <variablelist>
24       <varlistentry>
25         <term>msg</term>
26         <listitem>
27           <para>Matrix of strings: the message box displays each entry of this matrix (one entry per line).</para>
28         </listitem>
29       </varlistentry>
30       <varlistentry>
31         <term>msgboxtitle</term>
32         <listitem>
33           <para>String: the title of the message box (default value is "Scilab Message").</para>
34         </listitem>
35       </varlistentry>
36       <varlistentry>
37         <term>msgboxicon</term>
38         <listitem>
39           <para>String: the name of the icon to be displayed in the message box, its possible values are:</para>
40           <itemizedlist>
41             <listitem>
42               <para>"error"</para>
43             </listitem>
44             <listitem>
45               <para>"hourglass"</para>
46             </listitem>
47             <listitem>
48               <para>"info"</para>
49             </listitem>
50             <listitem>
51               <para>"passwd"</para>
52             </listitem>
53             <listitem>
54               <para>"question"</para>
55             </listitem>
56             <listitem>
57               <para>"warning"</para>
58             </listitem>
59             <listitem>
60               <para>"scilab": default icon</para>
61             </listitem>
62           </itemizedlist>
63         </listitem>
64       </varlistentry>
65       <varlistentry>
66         <term>buttons</term>
67         <listitem>
68           <para>1xn vector of strings: the names of the buttons to be displayed in the message box. By default, only one button is displayed with label "OK".</para>
69         </listitem>
70       </varlistentry>
71       <varlistentry>
72         <term>modal</term>
73         <listitem>
74           <para>String: "modal" to create a modal dialog, any other string to create a non-modal dialog. Please note that "modal" can replace any of the other input arguments except msg (See examples).</para>
75         </listitem>
76       </varlistentry>
77       <varlistentry>
78         <term>btn</term>
79         <listitem>
80           <para>Scalar: number of the button that the user pressed (1 is the leftmost button) for a modal dialog, 0 else.</para>
81         </listitem>
82       </varlistentry>
83     </variablelist>
84   </refsection>
85   <refsection>
86     <title>Description</title>
87     <para>Creates a dialog window to display a message waiting or not for a user action. This function is used by <link linkend="x_message">x_message</link>.</para>
88   </refsection>
89   <refsection>
90     <title>Examples</title>
91     <programlisting role="example"><![CDATA[
92
93 // Simple example
94 messagebox("Single line message")
95
96 // Multi line message with title
97 messagebox(["Multi-line" "message"], "User defined title")
98
99 // Icon specified by th euser
100 messagebox("An error message", "Error", "error")
101
102 // Buttons labels + "modal" replaces title
103 messagebox("Have you seen this beautiful message", "modal", "info", ["Yes" "No"])
104
105 // "modal" given as fifth input argument
106 messagebox("An error message", "Error", "error", ["Continue" "Stop"], "modal")
107  
108   ]]></programlisting>
109   </refsection>
110   <refsection>
111     <title>See Also</title>
112     <simplelist type="inline">
113       <member>
114         <link linkend="x_message">x_message</link>
115       </member>
116     </simplelist>
117   </refsection>
118   <refsection>
119     <title>Authors</title>
120     <para>Vincent COUVERT</para>
121   </refsection>
122 </refentry>