* Bug 14897: xinfo() declared obsolete
[scilab.git] / scilab / modules / graphics / help / fr_FR / text / xinfo.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"
3           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
4           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
5           xml:lang="fr" xml:id="xinfo">
6     <refnamediv>
7         <refname>xinfo</refname>
8         <refpurpose>
9           Change le texte affiché dans la barre d'état de la fenêtre courante
10            <emphasis role="bold">(obsolète)</emphasis>
11         </refpurpose>
12     </refnamediv>
13     <refsynopsisdiv>
14         <title>Séquence d'appel</title>
15         <synopsis>xinfo(texte)</synopsis>
16     </refsynopsisdiv>
17     <refsection>
18         <title>Paramètres</title>
19         <variablelist>
20             <varlistentry>
21                 <term>texte</term>
22                 <listitem>
23                     <para>chaîne de caractères affichée dans la barre d'état
24                     </para>
25                 </listitem>
26             </varlistentry>
27         </variablelist>
28     </refsection>
29     <refsection>
30         <title>Description</title>
31       <warning>
32         <literal>xinfo()</literal> est obsolète et sera retirée de Scilab 6.1. SVP utiliser
33         <literal>gcf().info_message</literal> à la place.
34       </warning>
35         <para>
36             <literal>xinfo</literal> change le texte qui est affiché dans la barre d'état
37             (le panneau dans le bas des fenêtres) de la fenêtre courante. Cette fonction est
38             l'équivalent de modifier la propriété <link linkend="figure_properties">info_message</link>
39             de la fenêtre graphique courante (donné par <link linkend="gcf">gcf</link>).
40         </para>
41     </refsection>
42     <refsection>
43       <title>Exemples</title>
44         <programlisting role="example"><![CDATA[
45 f = scf(100001);
46 xinfo("ID figure : " + string(f.figure_id));
47      ]]></programlisting>
48     </refsection>
49     <refsection role="history">
50         <title>Historique</title>
51         <revhistory>
52             <revision>
53                 <revnumber>6.0.2</revnumber>
54                 <revdescription>
55                    xinfo() est déclarée obsolète pour être retirée de Scilab 6.1. SVP utiliser
56                    gcf().info_message à la place.
57                 </revdescription>
58             </revision>
59         </revhistory>
60     </refsection>
61 </refentry>