Xcos help: fix duplicated id errors
[scilab.git] / scilab / modules / xcos / help / fr_FR / scilab_utilities_functions / xcosAddToolsMenu.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) 2012 - Scilab Enterprises - Clément DAVID
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <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" version="5.0-subset Scilab" xml:id="xcosAddToolsMenu">
14     <refnamediv>
15         <refname>xcosAddToolsMenu</refname>
16         <refpurpose>Ajoute un menu au menu "Outils" d'Xcos.</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Séquence d'appel</title>
20         <synopsis>xcosAddToolsMenu(label, command)</synopsis>
21     </refsynopsisdiv>
22     <refsection id="Module_xcosAddToolsMenu">
23         <title>Module</title>
24         <itemizedlist>
25             <listitem>
26                 <para>
27                     <link linkend="xcos">xcos</link>
28                 </para>
29             </listitem>
30         </itemizedlist>
31     </refsection>
32     <refsection id="Description_xcosAddToolsMenu">
33         <title>Description</title>
34         <para>Ajoute un menu à Xcos qui exécute une commande scilab. La commande scilab peut utiliser deux variables définies dans le contexte scilab :</para>
35         <itemizedlist>
36             <listitem>
37                 <para>
38                     <emphasis role="bold">blk :</emphasis> Le bloc sélectionné. La variable n'existe pas si rien n'est sélectionné. La variable à le type <link linkend="scicos_block">scicos_block</link>.
39                 </para>
40             </listitem>
41             <listitem>
42                 <para>
43                     <emphasis role="bold">scs_m :</emphasis> Le diagramme complet. La variable à le type <link linkend="scicos_diagram">scicos_diagram</link>.
44                 </para>
45             </listitem>
46         </itemizedlist>
47         <para>Cette fonction a été introduite en Scilab 5.4.0.</para>
48         <para>
49             <programlisting role="example"><![CDATA[
50 xcosAddToolsMenu("affiche plop", "disp(''plop'')");
51 xcosAddToolsMenu("affiche le bloc sélectionné", "disp(blk)");
52 xcosAddToolsMenu("affiche le diagramme", "disp(scs_m)");
53
54 // définition d'un fonction de mise à jour
55 function myUpdateFunction(blk, scs_m)
56     execstr(''[ok, blk] = '' + blk.gui + ''(''''set'''', blk)'') ;
57     xcosUpdateBlock(blk) ;
58 endfunction
59 xcosAddToolsMenu("met à jour le block", "myUpdateFunction(blk, scs_m)");
60 ]]></programlisting>
61         </para>
62     </refsection>
63     <refsection id="SeeAlso_xcosAddToolsMenu">
64         <title>Voir aussi</title>
65         <itemizedlist>
66             <listitem>
67                 <para>
68                     <link linkend="xcos">xcos - Editeur de schéma-bloc et IHM pour le simulateur hybride</link>
69                 </para>
70             </listitem>
71             <listitem>
72                 <para>
73                     <link linkend="scicos_block">scicos_block - Block type.</link>
74                 </para>
75             </listitem>
76             <listitem>
77                 <para>
78                     <link linkend="scicos_diagram">scicos_diagram - Diagram type.</link>
79                 </para>
80             </listitem>
81         </itemizedlist>
82     </refsection>
83     <refsection id="Authors_xcosAddToolsMenu">
84         <title>Authors</title>
85         <para>
86             <emphasis role="bold">Clément David</emphasis> - Scilab Enterprises
87         </para>
88     </refsection>
89 </refentry>