fix xset doc about wpos parameters
[scilab.git] / scilab / modules / graphics / help / fr_FR / xset.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:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xset" xml:lang="fr">
3     <refnamediv>
4         <refname>xset</refname>
5         <refpurpose>
6             change des valeurs du contexte graphique. <emphasis role="bold">Fonction obsolete</emphasis>
7         </refpurpose>
8     </refnamediv>
9     <refsynopsisdiv>
10         <title>Séquence d'appel</title>
11         <synopsis>xset(choice-name,x1,x2,x3,x4,x5)
12             xset()
13         </synopsis>
14     </refsynopsisdiv>
15     <refsection>
16         <title>Paramètres</title>
17         <variablelist>
18             <varlistentry>
19                 <term>choice-name</term>
20                 <listitem>
21                     <para>chaîne de caractères</para>
22                 </listitem>
23             </varlistentry>
24             <varlistentry>
25                 <term>x1,...,x5</term>
26                 <listitem>
27                     <para>
28                         dépend de <literal>choice-name</literal>
29                     </para>
30                 </listitem>
31             </varlistentry>
32         </variablelist>
33     </refsection>
34     <refsection>
35         <title>Description</title>
36         <para>
37             <emphasis role="bold">
38                 <literal>Remarque Importante : </literal>Cette
39                 fonction est obsolète
40             </emphasis>
41             .Utilisez de préférence la représentation
42             objet des graphiques Scilab.voir les fonctions <link linkend="set">set</link> et <link linkend="get">get</link> ainsi que la
43             page d'aide <link linkend="graphics_entities">graphics_entities</link>.
44         </para>
45         <para>
46             <literal>xset</literal> est utilisée pour changer des valeurs du
47             contexte graphique de la fenêtre graphique courante.
48         </para>
49         <para>Quand elle est appelée sans argument, une boîte de dialogue est
50             affichée avec les valeurs courantes et des changements peuvent être
51             effectués à   l'aide de boutons.
52         </para>
53         <para>
54             Utiliser <literal>xset()</literal> pour afficher ou changer la
55             couleur courante, le marqueur ou la police.
56         </para>
57         <variablelist>
58             <varlistentry>
59                 <term>xset("alufunction",number)</term>
60                 <listitem>
61                     <para>utilisé pour changer l'opérateur logique de dessin L'opérateur
62                         est choisi avec <literal>x1</literal>. Les valeurs habituelles sont
63                         : 3 pour la copie (par défaut), 6 pour le ou exclusif (pour faire
64                         des animations) et 0 pour effacer. Voir
65                         <literal>alufunctions</literal> pour plus de détails.
66                     </para>
67                 </listitem>
68             </varlistentry>
69             <varlistentry>
70                 <term>xset("auto clear","on"|"off")</term>
71                 <listitem>
72                     <para>Met "on" ou "off" le mode d'effacement automatique des
73                         graphiques. Quand le mode est "on", les dessins successifs ne sont
74                         pas superposés, i.e. la commande <literal>clf()</literal>
75                         (effacement de la fenêtre graphique et effacement des graphiques
76                         enregistrés) est exécutée avant chaque commande graphique de haut
77                         niveau (plot2d par exemple). La valeur par défaut est "off".
78                     </para>
79                 </listitem>
80             </varlistentry>
81             <varlistentry>
82                 <term>xset("background",color)</term>
83                 <listitem>
84                     <para>Change la couleur d'arrière plan du système d'axes courant.
85                         L'argument <literal>color</literal> correspond a un indice de la table de couleur.
86                     </para>
87                 </listitem>
88             </varlistentry>
89             <varlistentry>
90                 <term>xset("clipping",x,y,w,h)</term>
91                 <listitem>
92                     <para>Définit la zone de clipping (la zone de la fenêtre graphique
93                         où les dessins peuvent être dessinés) comme le rectangle (x,y,w,h)
94                         (point en haut à   gauche, largeur, hauteur). Cette fonction utilise
95                         l'échelle courante de la fenêtre graphique.
96                     </para>
97                 </listitem>
98             </varlistentry>
99             <varlistentry>
100                 <term>xset("color",value)</term>
101                 <listitem>
102                     <para>Définit la couleur par défaut de tracé de ligne, de
103                         remplissage, de texte, pour toutes les fonctions de dessin.
104                         <literal>value</literal> est un entier projeté sur l'intervalle
105                         [0,whiteid]. 0 est utilisé pour le noir et whiteid pour le blanc. La
106                         valeur de whiteid peut être obtenue avec
107                         <literal>xget("white")</literal>.
108                     </para>
109                 </listitem>
110             </varlistentry>
111             <varlistentry>
112                 <term>xset("colormap",cmap)</term>
113                 <listitem>
114                     <para>Définit la table des couleurs à   partir d'une matrice m x 3.
115                         m est le nombre de couleurs. La couleur numéro i est donnée comme le
116                         triplet cmap(i,1), cmap(i,2), cmap(i,3) correspondant respectivement
117                         aux intensités de rouge, vert et bleu, comprises entre 0 et
118                         1.
119                     </para>
120                 </listitem>
121             </varlistentry>
122             <varlistentry>
123                 <term>xset("dashes",i)</term>
124                 <listitem>
125                     <para>
126                         en mode noir et blanc (<literal>xset("use
127                             color",0)
128                         </literal>
129                         ), choisit le style de pointillé numéro i (0 pour
130                         une ligne continue). En mode couleur (<literal>xset("use
131                             color",1)
132                         </literal>
133                         )cette commande est utilisée pour choisir la
134                         couleur du marqueur, des lignes et du texte. Ce mot-clé est
135                         obsolète, utiliser <literal>xset('color',i)</literal> et
136                         <literal>xset('line style',i)</literal> à   la place.
137                     </para>
138                 </listitem>
139             </varlistentry>
140             <varlistentry>
141                 <term>xset("default")</term>
142                 <listitem>
143                     <para>Réinitialise le contexte graphiques aux valeurs par
144                         défaut.
145                     </para>
146                 </listitem>
147             </varlistentry>
148             <varlistentry>
149                 <term>xset("font",fontid,fontsize) : choisit la police courante et sa
150                     taille.
151                 </term>
152                 <listitem>
153                     <para>
154                         Noter que <literal>fontsize</literal> s'applique aussi à  
155                         toutes les polices autres que <literal>fontid</literal> .
156                     </para>
157                 </listitem>
158             </varlistentry>
159             <varlistentry>
160                 <term>xset("font size",fontsize)</term>
161                 <listitem>
162                     <para>Choisit la taille des polices.</para>
163                 </listitem>
164             </varlistentry>
165             <varlistentry>
166                 <term>xset("foreground",color)</term>
167                 <listitem>
168                     <para>Choisit la couleur de premier plan du système d'axes courant.
169                         L'argument <literal>color</literal> correspond a un indice de la table de couleur.
170                     </para>
171                 </listitem>
172             </varlistentry>
173             <varlistentry>
174                 <term>xset("fpf",string)</term>
175                 <listitem>
176                     <para>Change le format des nombres affichés sur les courbes de
177                         niveau, où <literal>string</literal> précise le format comme en
178                         langage C (par exemple <literal>string="%.3f"</literal>). Utiliser
179                         <literal>string=""</literal> pour revenir au format par
180                         défaut.
181                     </para>
182                 </listitem>
183             </varlistentry>
184             <varlistentry>
185                 <term>xset("hidden3d",colorid) : Choisit la couleur des parties
186                     arrières dans la fonction plot3d.
187                 </term>
188                 <listitem>
189                     <para>
190                         <literal>colorid=0</literal> supprime l'affichage des parties
191                         arrières des objets 3D. Il s'agit d'une technique dénommée 'culling'
192                         et permet d'accélérer le rendu des surfaces fermées.
193                     </para>
194                 </listitem>
195             </varlistentry>
196             <varlistentry>
197                 <term>xset("line mode",type)</term>
198                 <listitem>
199                     <para>Cette fonction est utilisée pour changer le mode de dessin des
200                         lignes. Mode absolu pour type=1 et relatif avec type=0. (attention :
201                         le mode type=0 est buggé)
202                     </para>
203                 </listitem>
204             </varlistentry>
205             <varlistentry>
206                 <term>xset("line style",value)</term>
207                 <listitem>
208                     <para>Choisit le style de ligne (1: continu, &gt;1 pour les
209                         pointillés).
210                     </para>
211                 </listitem>
212             </varlistentry>
213             <varlistentry>
214                 <term>xset("mark",markid,marksize)</term>
215                 <listitem>
216                     <para>Choisit le marqueur ainsi que sa taille. Utiliser
217                         <literal>xset()</literal> pour voir les marqueurs. Noter que
218                         <literal>marksize</literal> s'applique aussi à   tous les marqueurs
219                         autres que <literal>markid</literal>.
220                     </para>
221                 </listitem>
222             </varlistentry>
223             <varlistentry>
224                 <term>xset("mark size",marksize)</term>
225                 <listitem>
226                     <para>Choisit la taille de marqueur</para>
227                 </listitem>
228             </varlistentry>
229             <varlistentry>
230                 <term>xset("pattern",value)</term>
231                 <listitem>
232                     <para>Choisit le motif pour les fonctions de remplissage.
233                         <literal>value</literal> est un entier projeté sur l'intervalle
234                         [0,whiteid]. 0 est utilisé pour le noir et whiteid pour le blanc. La
235                         valeur de whiteid peut être obtenue avec
236                         <literal>xget("white")</literal>. "pattern" est équivalent à  
237                         "color".
238                     </para>
239                 </listitem>
240             </varlistentry>
241             <varlistentry>
242                 <term>xset("thickness",value)</term>
243                 <listitem>
244                     <para>Choisit l'épaisseur des lignes en pixels (0 et 1 = épaisseur
245                         de 1 pixel).
246                     </para>
247                 </listitem>
248             </varlistentry>
249             <varlistentry>
250                 <term>xset("use color",flag)</term>
251                 <listitem>
252                     <para>
253                         Si flag=1 alors <literal>xset("pattern",.)</literal> ou
254                         <literal>xset("dashes",.)</literal> changent la couleur de dessin ou
255                         de remplissage. Si flag=0 on passe en mode pointillés et noir et
256                         blanc.
257                     </para>
258                 </listitem>
259             </varlistentry>
260             <varlistentry>
261                 <term>xset("viewport",x,y)</term>
262                 <listitem>
263                     <para>Choisit la position de la fenêtre glissante.</para>
264                 </listitem>
265             </varlistentry>
266             <varlistentry>
267                 <term>xset("wdim",width,height)</term>
268                 <listitem>
269                     <para>Choisit la largeur et la hauteur de la fenêtre graphique
270                         courante. Cette option n'est pas prise en compte par le pilote
271                         PostScript.
272                     </para>
273                 </listitem>
274             </varlistentry>
275             <varlistentry>
276                 <term>xset("wpdim",width,height)</term>
277                 <listitem>
278                     <para>Choisit (en pixels) la largeur et la hauteur de la fenêtre
279                         graphique courante physique (qui peut être différente de la taille
280                         réelle en mode wresize=1). Cette option n'est pas prise en compte
281                         par le pilote PostScript.
282                     </para>
283                 </listitem>
284             </varlistentry>
285             <varlistentry>
286                 <term>xset("window",window-number)</term>
287                 <listitem>
288                     <para>
289                         Choisit la fenêtre <literal>window-number</literal> comme
290                         fenêtre graphique par défaut et crée cette fenêtre si elle n'existe
291                         pas.
292                     </para>
293                 </listitem>
294             </varlistentry>
295             <varlistentry>
296                 <term>xset("wpos",[x,y])</term>
297                 <listitem>
298                     <para>Choisit la position (en pixels) du point en haut à gauche de
299                         la fenêtre graphique.
300                     </para>
301                 </listitem>
302             </varlistentry>
303             <varlistentry>
304                 <term>xset("wresize",flag)</term>
305                 <listitem>
306                     <para>Si flag=1 alors les graphiques sont automatiquement
307                         redimensionnés de manière à   remplir la fenêtre graphique.
308                     </para>
309                     <programlisting role=""><![CDATA[
310 xdel();
311 xset("wresize",1);
312 plot2d();
313 xset("wdim",1000,500)
314  ]]></programlisting>
315                     <para>Si flag=0 l'échelle des graphiques est inchangée quand la
316                         fenêtre est redimensionnée. Le "panner" en haut à   gauche de la
317                         fenêtre ou les flèches du clavier peuvent être utilisées pour faire
318                         glisser le contenu de la fenêtre.
319                     </para>
320                     <programlisting role=""><![CDATA[
321 xdel();
322 plot2d();
323 xset("wresize",0);
324 xset("wdim",1000,500)
325  ]]></programlisting>
326                 </listitem>
327             </varlistentry>
328         </variablelist>
329     </refsection>
330     <refsection role="see also">
331         <title>Voir aussi</title>
332         <simplelist type="inline">
333             <member>
334                 <link linkend="xget">xget</link>
335             </member>
336             <member>
337                 <link linkend="getcolor">getcolor</link>
338             </member>
339             <member>
340                 <link linkend="ged">ged</link>
341             </member>
342             <member>
343                 <link linkend="set">set</link>
344             </member>
345             <member>
346                 <link linkend="graphics_entities">graphics_entities</link>
347             </member>
348         </simplelist>
349     </refsection>
350 </refentry>