* Bug 15359 fixed: twinkle(h) could not blink several objects together
[scilab.git] / scilab / modules / graphics / help / fr_FR / interaction / twinkle.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) INRIA
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  * Copyright (C) 2015, 2016, 2018 - Samuel GOUGEON
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17         xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
18         xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19         xml:lang="fr" xml:id="twinkle">
20     <refnamediv>
21         <refname>twinkle</refname>
22         <refpurpose>fait clignoter des éléments graphiques pour les repérer visuellement</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Syntaxe</title>
26         <synopsis>
27             twinkle
28             twinkle(n)
29             twinkle(h)
30             twinkle(h,n)
31         </synopsis>
32     </refsynopsisdiv>
33     <refsection role="arguments">
34         <title>Paramètres</title>
35         <variablelist>
36             <varlistentry>
37                 <term>h</term>
38                 <listitem>
39                     <para>
40                     identifiant unique ou vecteur d'identifiants graphiques des éléments à
41                     repérer. Par défaut, l'élément graphique actif d'identifiant
42                     <literal>gce()</literal> est considéré.
43                     </para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>n</term>
48                 <listitem>
49                     <para>nombre de clignotements. Par défaut, n=5</para>
50                 </listitem>
51             </varlistentry>
52         </variablelist>
53     </refsection>
54     <refsection role="description">
55         <title>Description</title>
56         <para>
57             <function>twinkle</function> fait clignoter <varname>n</varname> fois les objets
58             graphiques dont les identifiants sont spécifiés dans <varname>h</varname>.
59             Si certains des objets sont initialement invisibles, ils sont clignotés comme les
60             autres, puis redeviennent invisibles à l'issue du clignotement.
61         </para>
62         <para>
63             Si <function>twinkle()</function> est appelé sans paramètre alors qu'aucune fenêtre
64             graphique n'existe, l'instruction est ignorée. Si un des identifiants graphiques de
65             <varname>h</varname> est invalide (l'élément graphique correspondant a été supprimé
66             entretemps), <function>twinkle(h..)</function> produit une erreur.
67         </para>
68     </refsection>
69     <refsection role="examples">
70         <title>Exemples</title>
71         <programlisting role="example"><![CDATA[
72 clf
73 plot()
74 twinkle    // fait clignoter le dernier groupe de courbes dessinées dans l'exemple de plot()
75 twinkle(3) // le fait clignoter seulement 3 fois
76
77 clf
78 x = linspace(-2*%pi,2*%pi,100)';
79 plot2d(x,[sin(x),cos(x)]);
80 e = gce();
81 p1 = e.children(1);
82 p2 = e.children(2);
83 twinkle(p1)     // Courbe du cosinus
84 twinkle(p2,10)  // Courbe du sinus, 10 fois
85 twinkle(gca())  // Repère actif entier
86 ]]></programlisting>
87     <para/>
88         <programlisting role="example"><![CDATA[
89 // Repérage visuel d'un sous-ensemble de multiples courbes, certaines étant initialement masquées
90 clf
91 plot()
92 c = gca().children.children(1:10);
93 c(1:5).visible = "off";
94 sleep(5,'s')
95 twinkle(c)
96  ]]></programlisting>
97     </refsection>
98     <refsection role="see also">
99         <title>Voir aussi</title>
100         <simplelist type="inline">
101             <member>
102                 <link linkend="graphics_entities">Eléments graphiques</link>
103             </member>
104         </simplelist>
105     </refsection>
106     <refsection role="history">
107         <title>Historique</title>
108         <revhistory>
109             <revision>
110                 <revnumber>6.0</revnumber>
111                 <revdescription>
112                     <para>twinkle() et twinkle(n) ajoutés.</para>
113                 </revdescription>
114             </revision>
115             <revision>
116                 <revnumber>6.1</revnumber>
117                 <revdescription>
118                     <para>Plusieurs objets indépendants peuvent désormais être clignotés ensemble.</para>
119                 </revdescription>
120             </revision>
121         </revhistory>
122     </refsection>
123 </refentry>