e89925bd5e55f93c29ab7ec30259cb0f31ab80f1
[scilab.git] / scilab / modules / graphics / help / fr_FR / interaction / xclick.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) ENPC - Jean-Philippe Chancelier
5  * Copyright (C) 2008 - INRIA - Vincent COUVERT
6  * 
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at    
11  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12  *
13  -->
14 <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="xclick" xml:lang="fr">
15     <refnamediv>
16         <refname>xclick</refname>
17         <refpurpose>Attend une action d'un bouton de la souris, du clavier dans une fenêtre graphique.</refpurpose>
18     </refnamediv>
19     <refsynopsisdiv>
20         <title>Séquence d'appel</title>
21         <synopsis>[ibutton,xcoord,yxcoord,iwin,cbmenu]=xclick([flag])</synopsis>
22     </refsynopsisdiv>
23     <refsection>
24         <title>Paramètres</title>
25         <variablelist>
26             <varlistentry>
27                 <term>ibutton</term>
28                 <listitem>
29                     <para>Scalaire réel (valeur entière): numéro de bouton, code de
30                         touche clavier...(Voir description ci-dessous).
31                     </para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>xccord</term>
36                 <listitem>
37                     <para>Scalaire réel: abscisse du pointeur de la souris au
38                         moment du clic, à l'échelle graphique courante (voir <link linkend="gca">gca()</link>).
39                     </para>
40                 </listitem>
41             </varlistentry>
42             <varlistentry>
43                 <term>ycoord</term>
44                 <listitem>
45                     <para>Scalaire réel: ordonnée du pointeur de la souris au
46                         moment du clic, à l'échelle graphique courante (voir <link linkend="gca">gca()</link>).
47                     </para>
48                 </listitem>
49             </varlistentry>
50             <varlistentry>
51                 <term>iwin</term>
52                 <listitem>
53                     <para>Scalaire réel (valeur entière): numéro de la fenêtre où
54                         l'action s'est produite.
55                     </para>
56                 </listitem>
57             </varlistentry>
58             <varlistentry>
59                 <term>cbmenu</term>
60                 <listitem>
61                     <para>Chaîne de caractères: callback associé à un menu dynamique si
62                         <literal>xclick</literal> se termine à cause d'un clic sur un menu.
63                         Dans ce cas, <literal>ibutton</literal>, <literal>xcoord</literal>,
64                         <literal>ycoord</literal>, et <literal>iwin</literal> prennent des
65                         valeurs arbitraires.
66                     </para>
67                 </listitem>
68             </varlistentry>
69             <varlistentry>
70                 <term>flag</term>
71                 <listitem>
72                     <para>Scalaire réel (valeur entière): S'il est présent, la queue
73                         d'évènements des clics de souris n'est pas vidée
74                         préalablement.
75                     </para>
76                 </listitem>
77             </varlistentry>
78         </variablelist>
79     </refsection>
80     <refsection>
81         <title>Description</title>
82         <para>
83             <literal>xclick</literal> attend l'appui sur un bouton de la
84             souris.
85         </para>
86         <para>Appelée avec 3 arguments en sortie, cette fonction attend qu'un
87             bouton de la souris soit pressé avec le pointeur dans la fenêtre graphique
88             courante.
89         </para>
90         <para>Avec 4 ou 5 arguments en sortie, l'appui sur un bouton de la souris
91             est attendu dans toutes les fenêtres graphiques.
92         </para>
93         <para>
94             Attention, les coordonnées <literal>xcoord</literal>,
95             <literal>ycoord</literal> renvoyées par la fonction sont relatives au système d'axes courant (voir <link linkend="gca">gca()</link>).
96         </para>
97         <para>
98             Les valeurs de <literal>ibutton</literal> sont décrites ci-dessous
99             :
100         </para>
101         <variablelist>
102             <varlistentry>
103                 <term>ibutton==0</term>
104                 <listitem>
105                     <para>Le bouton gauche a été pressé.</para>
106                 </listitem>
107             </varlistentry>
108             <varlistentry>
109                 <term>ibutton==1</term>
110                 <listitem>
111                     <para>Le bouton central a été pressé.</para>
112                 </listitem>
113             </varlistentry>
114             <varlistentry>
115                 <term>ibutton==2</term>
116                 <listitem>
117                     <para>Le bouton droit a été pressé.</para>
118                     <para/>
119                 </listitem>
120             </varlistentry>
121             <varlistentry>
122                 <term>ibutton==3</term>
123                 <listitem>
124                     <para>Le bouton gauche a été cliqué.</para>
125                 </listitem>
126             </varlistentry>
127             <varlistentry>
128                 <term>ibutton==4</term>
129                 <listitem>
130                     <para>Le bouton central a été cliqué.</para>
131                 </listitem>
132             </varlistentry>
133             <varlistentry>
134                 <term>ibutton==5</term>
135                 <listitem>
136                     <para>Le bouton droit a été cliqué.</para>
137                     <para/>
138                 </listitem>
139             </varlistentry>
140             <varlistentry>
141                 <term>ibutton==10</term>
142                 <listitem>
143                     <para>Le bouton gauche a été double-cliqué.</para>
144                 </listitem>
145             </varlistentry>
146             <varlistentry>
147                 <term>ibutton==11</term>
148                 <listitem>
149                     <para>Le bouton central a été double-cliqué.</para>
150                 </listitem>
151             </varlistentry>
152             <varlistentry>
153                 <term>ibutton==12</term>
154                 <listitem>
155                     <para>Le bouton droit a été double-cliqué.</para>
156                     <para/>
157                 </listitem>
158             </varlistentry>
159             <varlistentry>
160                 <term>ibutton &gt;=32</term>
161                 <listitem>
162                     <para>
163                         La touche de code ASCII <literal>ibutton</literal> a été
164                         pressée.
165                     </para>
166                 </listitem>
167             </varlistentry>
168             <varlistentry>
169                 <term>ibutton &lt;=32</term>
170                 <listitem>
171                     <para>
172                         La touche de code ASCII <literal>-ibutton</literal> a été
173                         relachée.
174                     </para>
175                 </listitem>
176             </varlistentry>
177             <varlistentry>
178                 <term>ibutton &gt;=1000+32</term>
179                 <listitem>
180                     <para>
181                         La touche de code ASCII <literal>ibutton-1000</literal> a été
182                         pressée avec la touche CTRL enfoncée.
183                     </para>
184                 </listitem>
185             </varlistentry>
186             <varlistentry>
187                 <term>ibutton==-1000</term>
188                 <listitem>
189                     <para>La fenêtre graphique a été fermée.</para>
190                     <para>ATTENTION : ibutton était égal à -100 pour la fermeture de la
191                         fenêtre graphique jusqu'à Scilab 4.1.2, mais ce code a été changé
192                         (dans Scilab 5.0) parce qu'il correspondait aussi au code retourné
193                         pour la touche <literal>d</literal> relachée.
194                     </para>
195                 </listitem>
196             </varlistentry>
197             <varlistentry>
198                 <term>ibutton==-2</term>
199                 <listitem>
200                     <para>Un menu dynamique a été selectionné et son callback est
201                         retourné par <literal>cbmenu</literal>.
202                     </para>
203                 </listitem>
204             </varlistentry>
205         </variablelist>
206     </refsection>
207     <refsection role="see also">
208         <title>Voir aussi</title>
209         <simplelist type="inline">
210             <member>
211                 <link linkend="gca">gca</link>
212             </member>
213             <member>
214                 <link linkend="locate">locate</link>
215             </member>
216             <member>
217                 <link linkend="xgetmouse">xgetmouse</link>
218             </member>
219             <member>
220                 <link linkend="seteventhandler">seteventhandler</link>
221             </member>
222         </simplelist>
223     </refsection>
224 </refentry>