* Bug #13071 fixed - Xcos help: "obsolete" functions
[scilab.git] / scilab / modules / xcos / help / en_US / scilab_utilities_functions / standard_origin.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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:id="standard_origin">
3     <refnamediv>
4         <refname>standard_origin</refname>
5         <refpurpose>Get the position of a block in the Xcos editor.</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>[x,y] = standard_origin(block)
10         </synopsis>
11     </refsynopsisdiv>
12     <refsection>
13         <title>Arguments</title>
14         <variablelist>
15             <varlistentry>
16                 <term>block</term>
17                 <listitem>
18                     <para>xcos block.</para>
19                 </listitem>
20             </varlistentry>
21             <varlistentry>
22                 <term>x</term>
23                 <listitem>
24                     <para>x position of the block.</para>
25                 </listitem>
26             </varlistentry>
27             <varlistentry>
28                 <term>y</term>
29                 <listitem>
30                     <para>y position of the block.</para>
31                 </listitem>
32             </varlistentry>
33         </variablelist>
34     </refsection>
35     <refsection>
36         <title>Description</title>
37         <para>
38             This Scilab function was used by the Scicos blocks interfacing functions
39             to get the origin position (<varname>x</varname>, <varname>y</varname>) of a Xcos block.
40         </para>
41         <para>
42             <warning>
43                 This function is not useful for Xcos block interfacing functions anymore.
44                 The Xcos interfacing functions are not called with <literal>job="getinputs"</literal> anymore.
45             </warning>
46         </para>
47     </refsection>
48     <refsection>
49         <title>Example</title>
50         <programlisting role="example"><![CDATA[
51 loadXcosLibs();
52 o = CSCOPE("define");
53 [x,y] = standard_origin(o)
54     ]]></programlisting>
55     </refsection>
56     <refsection role="see also">
57         <title>See Also</title>
58         <simplelist type="inline">
59             <member>
60                 <link linkend="standard_inputs">standard_inputs</link>
61             </member>
62             <member>
63                 <link linkend="standard_outputs">standard_outputs</link>
64             </member>
65         </simplelist>
66     </refsection>
67 </refentry>