* Bug 15067 fixed: adds D&D of XMI files
[scilab.git] / scilab / modules / graphics / help / en_US / datatips / datatipSetStruct.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="datatipSetStruct">
15     <refnamediv>
16         <refname>datatipSetStruct</refname>
17         <refpurpose>
18             Stores the datatips data structure in the polyline entity. <emphasis role="bold">Obsolete function. </emphasis>
19         </refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>
24             ok=datatipSetStruct(curve_handle,datatips_struct)
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             <varlistentry>
39                 <term>datatips_struct</term>
40                 <listitem>
41                     <para>
42                         A tlist of type  <literal>datatips</literal>.
43                     </para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>ok</term>
48                 <listitem>
49                     <para>
50                         A boolean flag set to %f if the operations fail.
51                     </para>
52                 </listitem>
53             </varlistentry>
54         </variablelist>
55     </refsection>
56     <refsection>
57         <title>Description</title>
58         <para>
59             <literal>datatipSetStruct</literal> stores the datatips data structure in the polyline
60             entity. This is a subsidiary functions which is not to be called directly.
61         </para>
62     </refsection>
63     <refsection>
64         <title>History</title>
65         <revhistory>
66             <revision>
67                 <revnumber>5.4.1</revnumber>
68                 <revdescription>
69                     Function tagged obsolete. Will be removed in 5.5.0.
70                 </revdescription>
71             </revision>
72         </revhistory>
73     </refsection>
74     <refsection role="see also">
75         <title>See also</title>
76         <simplelist type="inline">
77             <member>
78                 <link linkend="datatips">datatips</link>
79             </member>
80             <member>
81                 <link linkend="datatipGetStruct">datatipGetStruct</link>
82             </member>
83         </simplelist>
84     </refsection>
85 </refentry>