Only xclick can catch callback execution.
[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 un évènement souris, clavier, la fermeture de la fenêtre ou
84             l'activation d'un menu. <literal>xclick</literal> empèche l'exécution du callback associé au menu.
85             La valeur du callback sera retournée dans l'argument de sortie <literal>cbmenu</literal>.
86         </para>
87         <para>Appelée avec 3 arguments en sortie, cette fonction attend qu'un
88             bouton de la souris soit pressé avec le pointeur dans la fenêtre graphique
89             courante.
90         </para>
91         <para>Avec 4 ou 5 arguments en sortie, l'appui sur un bouton de la souris
92             est attendu dans toutes les fenêtres graphiques.
93         </para>
94         <para>
95             Attention, les coordonnées <literal>xcoord</literal>,
96             <literal>ycoord</literal> renvoyées par la fonction sont relatives au système d'axes courant (voir <link linkend="gca">gca()</link>).
97         </para>
98         <para>
99             Les valeurs de <literal>ibutton</literal> sont décrites ci-dessous
100             :
101         </para>
102         <variablelist>
103             <varlistentry>
104                 <term>ibutton==0</term>
105                 <listitem>
106                     <para>Le bouton gauche a été pressé.</para>
107                 </listitem>
108             </varlistentry>
109             <varlistentry>
110                 <term>ibutton==1</term>
111                 <listitem>
112                     <para>Le bouton central a été pressé.</para>
113                 </listitem>
114             </varlistentry>
115             <varlistentry>
116                 <term>ibutton==2</term>
117                 <listitem>
118                     <para>Le bouton droit a été pressé.</para>
119                     <para/>
120                 </listitem>
121             </varlistentry>
122             <varlistentry>
123                 <term>ibutton==3</term>
124                 <listitem>
125                     <para>Le bouton gauche a été cliqué.</para>
126                 </listitem>
127             </varlistentry>
128             <varlistentry>
129                 <term>ibutton==4</term>
130                 <listitem>
131                     <para>Le bouton central a été cliqué.</para>
132                 </listitem>
133             </varlistentry>
134             <varlistentry>
135                 <term>ibutton==5</term>
136                 <listitem>
137                     <para>Le bouton droit a été cliqué.</para>
138                     <para/>
139                 </listitem>
140             </varlistentry>
141             <varlistentry>
142                 <term>ibutton==10</term>
143                 <listitem>
144                     <para>Le bouton gauche a été double-cliqué.</para>
145                 </listitem>
146             </varlistentry>
147             <varlistentry>
148                 <term>ibutton==11</term>
149                 <listitem>
150                     <para>Le bouton central a été double-cliqué.</para>
151                 </listitem>
152             </varlistentry>
153             <varlistentry>
154                 <term>ibutton==12</term>
155                 <listitem>
156                     <para>Le bouton droit a été double-cliqué.</para>
157                     <para/>
158                 </listitem>
159             </varlistentry>
160             <varlistentry>
161                 <term>ibutton &gt;=32</term>
162                 <listitem>
163                     <para>
164                         La touche de code ASCII <literal>ibutton</literal> a été
165                         pressée.
166                     </para>
167                 </listitem>
168             </varlistentry>
169             <varlistentry>
170                 <term>ibutton &lt;=32</term>
171                 <listitem>
172                     <para>
173                         La touche de code ASCII <literal>-ibutton</literal> a été
174                         relachée.
175                     </para>
176                 </listitem>
177             </varlistentry>
178             <varlistentry>
179                 <term>ibutton &gt;=1000+32</term>
180                 <listitem>
181                     <para>
182                         La touche de code ASCII <literal>ibutton-1000</literal> a été
183                         pressée avec la touche CTRL enfoncée.
184                     </para>
185                 </listitem>
186             </varlistentry>
187             <varlistentry>
188                 <term>ibutton==-1000</term>
189                 <listitem>
190                     <para>La fenêtre graphique a été fermée.</para>
191                     <para>ATTENTION : ibutton était égal à -100 pour la fermeture de la
192                         fenêtre graphique jusqu'à Scilab 4.1.2, mais ce code a été changé
193                         (dans Scilab 5.0) parce qu'il correspondait aussi au code retourné
194                         pour la touche <literal>d</literal> relachée.
195                     </para>
196                 </listitem>
197             </varlistentry>
198             <varlistentry>
199                 <term>ibutton==-2</term>
200                 <listitem>
201                     <para>Un menu dynamique a été selectionné et son callback est
202                         retourné par <literal>cbmenu</literal>.
203                     </para>
204                 </listitem>
205             </varlistentry>
206         </variablelist>
207     </refsection>
208     <refsection role="see also">
209         <title>Voir aussi</title>
210         <simplelist type="inline">
211             <member>
212                 <link linkend="gca">gca</link>
213             </member>
214             <member>
215                 <link linkend="locate">locate</link>
216             </member>
217             <member>
218                 <link linkend="xgetmouse">xgetmouse</link>
219             </member>
220             <member>
221                 <link linkend="seteventhandler">seteventhandler</link>
222             </member>
223         </simplelist>
224     </refsection>
225 </refentry>