xcosUpdateBlock.xml updated.
[scilab.git] / scilab / modules / xcos / help / en_US / scilab_utilities_functions / xcosUpdateBlock.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  * 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: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="xcosUpdateBlock">
17     <refnamediv>
18         <refname>xcosUpdateBlock</refname>
19         <refpurpose>Update a block instance</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>xcosUpdateBlock(blk)</synopsis>
24     </refsynopsisdiv>
25     <refsection id="Module_xcosUpdateBlock">
26         <title>Module</title>
27         <itemizedlist>
28             <listitem>
29                 <para>
30                     <link linkend="xcos">xcos</link>
31                 </para>
32             </listitem>
33         </itemizedlist>
34     </refsection>
35     <refsection id="Description_xcosUpdateBlock">
36         <title>Description</title>
37         <para>Update a block on a currently opened diagram.</para>
38         <itemizedlist>
39             <listitem>
40                 <para>
41                     <emphasis role="bold">blk :</emphasis> The block to update. The variable has a <link linkend="scicos_block">scicos_block</link> type.
42                 </para>
43             </listitem>
44         </itemizedlist>
45         <para>This function has been introduced in Scilab 5.4.0.</para>
46         <para>
47             <programlisting role="example"><![CDATA[
48 function myExternalFunction(blk, scs_m)
49     execstr('[ok, blk] = ' + blk.gui + '(''set'', blk)');
50     xcosUpdateBlock(blk);
51 endfunction
52 xcosAddToolsMenu("update block", "myExternalFunction(blk, scs_m)");
53 ]]></programlisting>
54         </para>
55     </refsection>
56     <refsection id="SeeAlso_xcosUpdateBlock">
57         <title>See also</title>
58         <itemizedlist>
59             <listitem>
60                 <para>
61                     <link linkend="xcos">xcos</link>
62                 </para>
63             </listitem>
64             <listitem>
65                 <para>
66                     <link linkend="xcosAddToolsMenu">xcosAddToolsMenu - Add a menu item into the Xcos "Tools" menu</link>
67                 </para>
68             </listitem>
69             <listitem>
70                 <para>
71                     <link linkend="scicos_block">scicos_block.</link>
72                 </para>
73             </listitem>
74             <listitem>
75                 <para>
76                     <link linkend="scicos_diagram">scicos_diagram</link>
77                 </para>
78             </listitem>
79         </itemizedlist>
80     </refsection>
81     <refsection id="Authors_xcosUpdateBlock">
82         <title>Authors</title>
83         <para>
84             <emphasis role="bold">Clément David</emphasis> - Scilab Enterprises
85         </para>
86     </refsection>
87 </refentry>