* Bugs 7948 15825 fixed: gsort() multilevel sorting
[scilab.git] / scilab / modules / graphics / help / en_US / text / xinfo.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
18           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19           xml:lang="en" xml:id="xinfo">
20     <refnamediv>
21         <refname>xinfo</refname>
22         <refpurpose>Sets the text displayed in the current window status bar <emphasis role="bold">(obsolete)</emphasis>
23         </refpurpose>
24     </refnamediv>
25     <refsynopsisdiv>
26         <title>Syntax</title>
27         <synopsis>xinfo(text)</synopsis>
28     </refsynopsisdiv>
29     <refsection>
30         <title>Arguments</title>
31         <variablelist>
32             <varlistentry>
33                 <term>text</term>
34                 <listitem>
35                     <para>string displayed in the status bar</para>
36                 </listitem>
37             </varlistentry>
38         </variablelist>
39     </refsection>
40     <refsection>
41         <title>Description</title>
42       <warning>
43         <literal>xinfo()</literal> is obsolete and will be removed from Scilab 6.1. Please use
44         <literal>gcf().info_message</literal> instead.
45       </warning>
46         <para>
47             <literal>xinfo</literal> sets the text displayed in the status bar (panel at the bottom
48             of windows) of the current window. It is a the equivalent of setting the
49           <link linkend="figure_properties">info_message</link> property for the current graphic
50           window (given by <link linkend="gcf">gcf</link>)
51         </para>
52     </refsection>
53     <refsection>
54         <title>Examples</title>
55         <programlisting role="example"><![CDATA[
56 f = scf(100001);
57 xinfo("Figure ID: " + string(f.figure_id));
58  ]]></programlisting>
59     </refsection>
60     <refsection role="history">
61         <title>History</title>
62         <revhistory>
63             <revision>
64                 <revnumber>6.0.2</revnumber>
65                 <revdescription>
66                    xinfo() is tagged obsolete to be removed from Scilab 6.1. Please use
67                    gcf().info_message instead.
68                 </revdescription>
69             </revision>
70         </revhistory>
71     </refsection>
72 </refentry>