<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) ENPC - Jean-Philippe Chancelier
 * Copyright (C) 2008 - INRIA - Vincent COUVERT
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<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">
    <refnamediv>
        <refname>xclick</refname>
        <refpurpose>Attend une action d'un bouton de la souris, du clavier dans une fenêtre graphique.</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Séquence d'appel</title>
        <synopsis>[ibutton,xcoord,yxcoord,iwin,cbmenu]=xclick([flag])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Paramètres</title>
        <variablelist>
            <varlistentry>
                <term>ibutton</term>
                <listitem>
                    <para>Scalaire réel (valeur entière): numéro de bouton, code de
                        touche clavier...(Voir description ci-dessous).
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>xccord</term>
                <listitem>
                    <para>Scalaire réel: abscisse du pointeur de la souris au
                        moment du clic, à l'échelle graphique courante (voir <link linkend="gca">gca()</link>).
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ycoord</term>
                <listitem>
                    <para>Scalaire réel: ordonnée du pointeur de la souris au
                        moment du clic, à l'échelle graphique courante (voir <link linkend="gca">gca()</link>).
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>iwin</term>
                <listitem>
                    <para>Scalaire réel (valeur entière): numéro de la fenêtre où
                        l'action s'est produite.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>cbmenu</term>
                <listitem>
                    <para>Chaîne de caractères: callback associé à un menu dynamique si
                        <literal>xclick</literal> se termine à cause d'un clic sur un menu.
                        Dans ce cas, <literal>ibutton</literal>, <literal>xcoord</literal>,
                        <literal>ycoord</literal>, et <literal>iwin</literal> prennent des
                        valeurs arbitraires.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>flag</term>
                <listitem>
                    <para>Scalaire réel (valeur entière): S'il est présent, la queue
                        d'évènements des clics de souris n'est pas vidée
                        préalablement.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <literal>xclick</literal> attend un évènement souris, clavier, la fermeture de la fenêtre ou
            l'activation d'un menu. <literal>xclick</literal> empèche l'exécution du callback associé au menu.
            La valeur du callback sera retournée dans l'argument de sortie <literal>cbmenu</literal>.
        </para>
        <para>Appelée avec 3 arguments en sortie, cette fonction attend qu'un
            bouton de la souris soit pressé avec le pointeur dans la fenêtre graphique
            courante.
        </para>
        <para>Avec 4 ou 5 arguments en sortie, l'appui sur un bouton de la souris
            est attendu dans toutes les fenêtres graphiques.
        </para>
        <para>
            <warning>
                Attention, les coordonnées <literal>xcoord</literal>,
                <literal>ycoord</literal> renvoyées par la fonction sont relatives au système d'axes courant (voir <link linkend="gca">gca()</link>).
            </warning>
        </para>
        <para>
            Les valeurs de <literal>ibutton</literal> sont décrites ci-dessous
            :
        </para>
        <variablelist>
            <varlistentry>
                <term>ibutton==0</term>
                <listitem>
                    <para>Le bouton gauche a été pressé.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ibutton==1</term>
                <listitem>
                    <para>Le bouton central a été pressé.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ibutton==2</term>
                <listitem>
                    <para>Le bouton droit a été pressé.</para>
                    <para/>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ibutton==3</term>
                <listitem>
                    <para>Le bouton gauche a été cliqué.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ibutton==4</term>
                <listitem>
                    <para>Le bouton central a été cliqué.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ibutton==5</term>
                <listitem>
                    <para>Le bouton droit a été cliqué.</para>
                    <para/>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ibutton==10</term>
                <listitem>
                    <para>Le bouton gauche a été double-cliqué.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ibutton==11</term>
                <listitem>
                    <para>Le bouton central a été double-cliqué.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ibutton==12</term>
                <listitem>
                    <para>Le bouton droit a été double-cliqué.</para>
                    <para/>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ibutton &gt;=32</term>
                <listitem>
                    <para>
                        La touche de code ASCII <literal>ibutton</literal> a été
                        pressée.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ibutton &lt;= -32</term>
                <listitem>
                    <para>
                        La touche de code ASCII <literal>-ibutton</literal> a été
                        relachée.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ibutton &gt;=1000+32</term>
                <listitem>
                    <para>
                        La touche de code ASCII <literal>ibutton-1000</literal> a été
                        pressée avec la touche CTRL enfoncée.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ibutton==-1000</term>
                <listitem>
                    <para>La fenêtre graphique a été fermée.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>ibutton==-2</term>
                <listitem>
                    <para>Un menu dynamique a été selectionné et son callback est
                        retourné par <literal>cbmenu</literal>.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection role="see also">
        <title>Voir aussi</title>
        <simplelist type="inline">
            <member>
                <link linkend="gca">gca</link>
            </member>
            <member>
                <link linkend="locate">locate</link>
            </member>
            <member>
                <link linkend="xgetmouse">xgetmouse</link>
            </member>
            <member>
                <link linkend="seteventhandler">seteventhandler</link>
            </member>
        </simplelist>
    </refsection>
    <refsection role="history">
        <title>Historique</title>
        <revhistory>
            <revision>
                <revnumber>5.0</revnumber>
                <revdescription>
                    La fermeture d'une figure retourne désormais le code -1000 au lieu de -100.
                </revdescription>
            </revision>
        </revhistory>
    </refsection>
</refentry>
