Remove useless declaration in the image generation (but triggered
[scilab.git] / scilab / modules / graphics / help / en_US / datatips / datatipGetStruct.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Copyright (C) INRIA -  Serge Steer Serge.Steer@inria.fr
4  * 
5  * This file must be used under the terms of the CeCILL.
6  * This source file is licensed as described in the file COPYING, which
7  * you should have received as part of this distribution.  The terms
8  * are also available at    
9  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
10 -->
11 <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="en_US" xml:id="datatipGetStruct">
12     <refnamediv>
13         <refname>datatipGetStruct</refname>
14         <refpurpose>
15             Retreive the datatips data structure from the polyline entity. <emphasis role="bold">Obsolete function. </emphasis>
16         </refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>
21             datatips_struct=datatipGetStruct(curve_handle)
22         </synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>Arguments</title>
26         <variablelist>
27             <varlistentry>
28                 <term>curve_handle</term>
29                 <listitem>
30                     <para>
31                         A handle on a polyline. 
32                     </para>
33                 </listitem>
34             </varlistentry>
35         </variablelist>
36         <variablelist>
37             <varlistentry>
38                 <term>datatips_struct</term>
39                 <listitem>
40                     <para>
41                         A tlist of type  <literal>datatips</literal>.
42                     </para>
43                 </listitem>
44             </varlistentry>
45         </variablelist>
46     </refsection>
47     <refsection>
48         <title>Description</title>
49         <para>
50             <literal>datatipGetStruct</literal> extract the datatips data
51             structure out of the polyline  entity. It may be called
52             to retreive properties of the datatips data structure to
53             customize the tip display.
54         </para>
55     </refsection>
56     <refsection>
57         <title>Examples</title>
58         <programlisting role="example"><![CDATA[
59     x=linspace(0,1,100)';
60     y=x.^3;
61     clf()
62     plot(x,y);
63     e=gce();p=e.children(1);//get the handle on the polyline
64     datatipCreate(p,50);
65     datatipCreate(p,20);
66     datatips_struct=datatipGetStruct(p)
67     datatips_struct.formatfunction
68     ]]></programlisting>
69         <scilab:image>
70             x=linspace(0,1,100)';
71             y=x.^3;
72             plot(x,y);
73             e=gce();p=e.children(1);//get the handle on the polyline
74             datatipCreate(p,50);
75             datatipCreate(p,20);
76             datatips_struct=datatipGetStruct(p)
77         </scilab:image>
78     </refsection>
79     <refsection>
80         <title>History</title>
81         <revhistory>
82             <revision>
83                 <revnumber>5.4.1</revnumber>
84                 <revdescription>
85                     Function tagged obsolete. Will be removed in 5.5.0.
86                 </revdescription>
87             </revision>
88         </revhistory>
89     </refsection>
90     <refsection role="see also">
91         <title>See Also</title>
92         <simplelist type="inline">
93             <member>
94                 <link linkend="datatips">datatips</link>
95             </member>
96             <member>
97                 <link linkend="datatipSetDisplay">datatipSetDisplay</link>
98             </member>
99             <member>
100                 <link linkend="datatipInitStruct">datatipInitStruct</link>
101             </member>
102         </simplelist>
103     </refsection>
104 </refentry>