321dcc592989def107f55e0f51c4fb070a46c3e5
[scilab.git] / scilab / modules / graphics / help / en_US / style / getlinestyle.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) INRIA
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <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" xmlns:scilab="http://www.scilab.org"  xml:id="getlinestyle" xml:lang="en">
14     <refnamediv>
15         <refname>getlinestyle</refname>
16         <refpurpose>
17             dialog to select linestyle. <emphasis role="bold">Obsolete
18                 function.
19             </emphasis>
20         </refpurpose>
21     </refnamediv>
22     <refsynopsisdiv>
23         <title>Calling Sequence</title>
24         <synopsis>k=getlinestyle()</synopsis>
25     </refsynopsisdiv>
26     <refsection>
27         <title>Arguments</title>
28         <variablelist>
29             <varlistentry>
30                 <term>k</term>
31                 <listitem>
32                     <para>integer, selected linestyle or [] if the "Cancel" button has
33                         been clicked.
34                     </para>
35                 </listitem>
36             </varlistentry>
37         </variablelist>
38     </refsection>
39     <refsection>
40         <title>Description</title>
41         <para>
42             This function designed to work with the <link linkend="xset">xset</link> function <emphasis role="bold">is also obsolete</emphasis>.
43             Use the property editor <link linkend="ged">ged</link> instead.
44         </para>
45         <para>
46             <literal>getlinestyle</literal> opens a graphic window to select a
47             line style.
48         </para>
49     </refsection>
50     <refsection>
51         <title>Examples</title>
52         <programlisting role="example"><![CDATA[ 
53 x=0:0.1:10;
54 plot2d(x,sin(x))
55 e=gce(); // store the Compound containing the plot
56 e.children(1).line_style = getlinestyle();
57  ]]></programlisting>
58     </refsection>
59     <refsection>
60         <title>History</title>
61         <revhistory>
62             <revision>
63                 <revnumber>5.4.1</revnumber>
64                 <revdescription>
65                     Function tagged obsolete. Will be removed in 5.5.0. Please use <link linkend="ged">ged</link> instead.
66                 </revdescription>
67             </revision>
68         </revhistory>
69     </refsection>
70     <refsection role="see also">
71         <title>See Also</title>
72         <simplelist type="inline">
73             <member>
74                 <link linkend="ged">ged</link>
75             </member>
76             <member>
77                 <link linkend="set">set</link>
78             </member>
79             <member>
80                 <link linkend="polyline_properties">segs_properties</link>
81             </member>
82             <member>
83                 <link linkend="segs_properties">segs_properties</link>
84             </member>
85         </simplelist>
86     </refsection>
87 </refentry>