* Bug 15067 fixed: adds D&D of XMI files
[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  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  *
7  * This file is hereby licensed under the terms of the GNU GPL v2.0,
8  * pursuant to article 5.3.4 of the CeCILL v.2.1.
9  * This file was originally licensed under the terms of the CeCILL v2.1,
10  * and continues to be available under such terms.
11  * For more information, see the COPYING file which you should have received
12  * along with this program.
13 -->
14 <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">
15     <refnamediv>
16         <refname>datatipGetStruct</refname>
17         <refpurpose>
18             Retrieve the datatips data structure from the polyline entity. <emphasis role="bold">This function is obsolete.</emphasis>
19         </refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>
24             datatips_struct=datatipGetStruct(curve_handle)
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Arguments</title>
29         <variablelist>
30             <varlistentry>
31                 <term>curve_handle</term>
32                 <listitem>
33                     <para>
34                         A handle on a polyline.
35                     </para>
36                 </listitem>
37             </varlistentry>
38         </variablelist>
39         <variablelist>
40             <varlistentry>
41                 <term>datatips_struct</term>
42                 <listitem>
43                     <para>
44                         A tlist of type  <literal>datatips</literal>.
45                     </para>
46                 </listitem>
47             </varlistentry>
48         </variablelist>
49     </refsection>
50     <refsection>
51         <title>Description</title>
52         <para>
53             <literal>datatipGetStruct</literal> extract the datatips data
54             structure out of the polyline  entity. It may be called
55             to retrieve properties of the datatips data structure to
56             customize the tip display.
57         </para>
58     </refsection>
59     <refsection>
60         <title>Examples</title>
61         <programlisting role="example"><![CDATA[
62     x=linspace(0,1,100)';
63     y=x.^3;
64     clf()
65     plot(x,y);
66     e=gce();p=e.children(1);//get the handle on the polyline
67     datatipCreate(p,50);
68     datatipCreate(p,20);
69     datatips_struct=datatipGetStruct(p)
70     datatips_struct.display_function
71     ]]></programlisting>
72         <scilab:image>
73             x=linspace(0,1,100)';
74             y=x.^3;
75             plot(x,y);
76             e=gce();p=e.children(1);//get the handle on the polyline
77             datatipCreate(p,50);
78             datatipCreate(p,20);
79         </scilab:image>
80     </refsection>
81     <refsection>
82         <title>History</title>
83         <revhistory>
84             <revision>
85                 <revnumber>5.5.0</revnumber>
86                 <revdescription>
87                     Function tagged obsolete. Will be removed in 5.5.1. Please use <link linkend="polyline_properties">"datatips" property</link> instead.
88                 </revdescription>
89             </revision>
90         </revhistory>
91     </refsection>
92     <refsection role="see also">
93         <title>See also</title>
94         <simplelist type="inline">
95             <member>
96                 <link linkend="datatips">datatips</link>
97             </member>
98             <member>
99                 <link linkend="datatipSetDisplay">datatipSetDisplay</link>
100             </member>
101         </simplelist>
102     </refsection>
103 </refentry>