Bug Fix #13966 - twinkle, twinkle(n) now supported
[scilab.git] / scilab / modules / graphics / help / fr_FR / 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) 2015 - 2016 - Samuel GOUGEON
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
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" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"  xml:lang="fr" xml:id="twinkle">
17     <refnamediv>
18         <refname>twinkle</refname>
19         <refpurpose>fait clignoter un élément graphique pour le repérer visuellement</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntaxe</title>
23         <synopsis>twinkle
24 twinkle(n)
25 twinkle(h)
26 twinkle(h,n)
27         </synopsis>
28     </refsynopsisdiv>
29     <refsection role="arguments">
30         <title>Paramètres</title>
31         <variablelist>
32             <varlistentry>
33                 <term>h</term>
34                 <listitem>
35                     <para>identifiant de l'élément graphique à repérer. Par défaut, l'élément
36                       graphique actif d'identifiant <literal>gce()</literal> est considéré.
37                     </para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>n</term>
42                 <listitem>
43                     <para>nombre de clignotements. Par défaut, n=5</para>
44                 </listitem>
45             </varlistentry>
46         </variablelist>
47     </refsection>
48     <refsection role="description">
49         <title>Description</title>
50         <para>
51             <function>twinkle</function> fait clignoter <varname>n</varname> fois l'élément graphique
52             dont l'identifiant graphique <varname>h</varname> est spécifié.
53             Si <function>twinkle()</function> est appelé sans paramètre alors qu'aucune fenêtre
54             graphique n'existe, l'instruction est ignorée. Si l'identifiant graphique
55             <varname>h</varname> est invalide (l'élément graphique correspondant a été supprimé
56             entretemps), <function>twinkle(h..)</function> produit une erreur.
57         </para>
58     </refsection>
59     <refsection role="examples">
60         <title>Exemples</title>
61         <programlisting role="example"><![CDATA[
62 clf
63 plot()
64 twinkle    // fait clignoter le dernier groupe de courbes dessinées dans l'exemple de plot()
65 twinkle(3) // le fait clignoter seulement 3 fois
66
67 clf
68 x = linspace(-2*%pi,2*%pi,100)';
69 plot2d(x,[sin(x),cos(x)]);
70 e = gce();
71 p1 = e.children(1);
72 p2 = e.children(2);
73 twinkle(p1)     // Courbe du cosinus
74 twinkle(p2,10)  // Courbe du sinus, 10 fois
75 twinkle(gca())  // Repère actif entier
76 ]]></programlisting>
77     </refsection>
78     <refsection role="see also">
79         <title>Voir aussi</title>
80         <simplelist type="inline">
81             <member>
82                 <link linkend="graphics_entities">Eléments graphiques</link>
83             </member>
84         </simplelist>
85     </refsection>
86     <refsection role="history">
87         <title>Historique</title>
88         <revhistory>
89             <revision>
90                 <revnumber>6.0</revnumber>
91                 <revdescription>
92                     <para>twinkle() et twinkle(n) ajoutés.</para>
93                 </revdescription>
94             </revision>
95         </revhistory>
96     </refsection>
97 </refentry>