[doc] misc. patchs & small improvements
[scilab.git] / scilab / modules / gui / help / fr_FR / getvalue.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="getvalue">
6     <refnamediv>
7         <refname>getvalue</refname>
8         <refpurpose>boîte de dialogue de saisie de paramètres   </refpurpose>
9     </refnamediv>
10     <refsynopsisdiv>
11         <title>Séquence d'appel</title>
12         <synopsis>[ok,x1,..,x14]=getvalue(desc,labels,typ,ini)</synopsis>
13     </refsynopsisdiv>
14     <refsection>
15         <title>Paramètres</title>
16         <variablelist>
17             <varlistentry>
18                 <term>desc  </term>
19                 <listitem>
20                     <para>
21                       vecteur colonne de texte : présentation de la liste des paramètres.
22                       Tout caractère "&lt;" doit être remplacé par "&amp;lt;"
23                     </para>
24                 </listitem>
25             </varlistentry>
26             <varlistentry>
27                 <term>labels  </term>
28                 <listitem>
29                     <para>
30                         vecteur colonne de n textes : <literal>labels(i)</literal> l'intitulé
31                         du i-ème paramètre.
32                     </para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>typ  </term>
37                 <listitem>
38                     <para>
39                         : <literal>list(typ_1,dim_1,..,typ_n,dim_n)</literal>
40                     </para>
41                     <variablelist>
42                         <varlistentry>
43                             <term>typ_i  </term>
44                             <listitem>
45                                 <para>
46                                    définit le type de la ième valeur. Par défaut, les saisies
47                                    sont interprêtées comme des nombres décimaux. Les valeurs
48                                    groupées en colonne doivent être séparées par ";".
49                                    typ_i peut prendre l'une des valeurs suivantes :
50                                 </para>
51                                 <table>
52                                   <tr><th>"mat"</th><td>matrice</td></tr>
53                                   <tr><th>"col"</th><td>vecteur colonne (valeurs séparées par ";")</td></tr>
54                                   <tr><th>"row"</th><td>vecteur ligne</td></tr>
55                                   <tr><th>"vec"</th><td>vecteur (orientation libre)</td></tr>
56                                   <tr><th>"intvec"</th><td>scalaire, vecteur ou matrice de nombres entiers.</td></tr>
57                                   <tr><th>"str"</th><td>scalaire, vecteur ou matrice de textes, délimités par ".."</td></tr>
58                                   <tr><th>"lis"</th><td>liste (non implémenté)</td></tr>
59                                 </table>
60                             </listitem>
61                         </varlistentry>
62                         <varlistentry>
63                             <term>dim_i  </term>
64                             <listitem>
65                                 <para>
66                                     définit les dimensions de la i-ème valeur. Ce doit être un entier
67                                     ou un vecteur de deux entiers. -1 signifie que les dimensions
68                                     sont libres / non définies.
69                                 </para>
70                             </listitem>
71                         </varlistentry>
72                   </variablelist>
73               </listitem>
74           </varlistentry>
75           <varlistentry>
76             <term>ini  </term>
77             <listitem>
78               <para>
79                 vecteur colonne de n chaînes de caractères, <literal>ini(i)</literal>
80                 donne la valeur par défaut du i-ème paramètre
81               </para>
82             </listitem>
83           </varlistentry>
84           <varlistentry>
85             <term>ok  </term>
86             <listitem>
87               <para>booléen, %t (vrai) si le bouton "Ok" a été pressé, %f
88                 (faux) pour le bouton "Cancel"
89               </para>
90             </listitem>
91           </varlistentry>
92           <varlistentry>
93             <term>xi  </term>
94             <listitem>
95               <para>contient le i-ème paramètre si ok=%t. Si la liste des arguments de
96                 sortie contient un <literal>xi</literal> de plus que nécessaire, la valeur
97                 du dernier <literal>xi</literal> contient le vecteur des chaînes de
98                 caractères correspondant aux paramètres choisis.
99               </para>
100             </listitem>
101           </varlistentry>
102       </variablelist>
103     </refsection>
104     <refsection>
105         <title>Description</title>
106         <para>
107             Cette fonction est une interface vers la fonction <literal>x_mdialog</literal>,
108             avec contrôle d'erreur, vérification de taille et de type des
109             paramètres, évaluation des expressions Scilab, etc.
110         </para>
111         <note>
112           <para>
113               Toute expression Scilab valide peut être utilisée pour entrer un paramètre.
114               Pour les matrices et les vecteurs, <literal>getvalues()</literal>
115               ajoute [ ] autour de chaque groupe de valeurs saisies, avant leur évaluation.
116           </para>
117         </note>
118     </refsection>
119     <refsection>
120         <title>Exemples</title>
121         <programlisting role="example"><![CDATA[
122 labels=["module";"frequence";"phase    "];
123 [ok,mag,Freq,ph]=getvalue("signal sinusoidal",labels,...
124 list("vec",1,"vec",1,"vec",1),["0.85";"10^2";"%pi/3"])
125  ]]></programlisting>
126     </refsection>
127     <refsection role="see also">
128         <title>Voir aussi</title>
129         <simplelist type="inline">
130             <member>
131                 <link linkend="x_mdialog">x_mdialog</link>
132             </member>
133             <member>
134                 <link linkend="x_matrix">x_matrix</link>
135             </member>
136             <member>
137                 <link linkend="x_dialog">x_dialog</link>
138             </member>
139         </simplelist>
140     </refsection>
141 </refentry>