f246cf21941df10bd3adf5dba5356e2f89044ee4
[scilab.git] / scilab / modules / graphics / help / en_US / style / getsymbol.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="getsymbol" xml:lang="en">
14     <refnamediv>
15         <refname>getsymbol</refname>
16         <refpurpose>
17             dialog to select a symbol and its size. <emphasis role="bold">This function is obsolete.</emphasis>
18         </refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>c=getsymbol([title])</synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>Arguments</title>
26         <variablelist>
27             <varlistentry>
28                 <term>title</term>
29                 <listitem>
30                     <para>string, dialog title.</para>
31                 </listitem>
32             </varlistentry>
33             <varlistentry>
34                 <term>c</term>
35                 <listitem>
36                     <para>
37                         vector of size 2 <literal>[n,sz]</literal>.
38                     </para>
39                 </listitem>
40             </varlistentry>
41         </variablelist>
42     </refsection>
43     <refsection>
44         <title>Description</title>
45         <para>
46             This function designed to work with the <link linkend="xset">xset</link> function <emphasis role="bold">is also obsolete</emphasis>.
47             Use the property editor <link linkend="ged">ged</link> instead.
48         </para>
49         <para>
50             <literal>getsymbol</literal> opens a dialog choice box with title
51             <literal>title</literal> if given where the user can select a symbol and
52             its size. <literal>getsymbol</literal> returns the id of the mark
53             <literal>n</literal> and the id of its size <literal>sz</literal>.
54         </para>
55     </refsection>
56     
57     <refsection>
58         <title>History</title>
59         <revhistory>
60             <revision>
61                 <revnumber>5.4.1</revnumber>
62                 <revdescription>
63                     Function tagged obsolete. Will be removed in 5.5.0. Please use <link linkend="ged">ged</link> instead.
64                 </revdescription>
65             </revision>
66         </revhistory>
67     </refsection>
68     
69     <refsection role="see also">
70         <title>See Also</title>
71         <simplelist type="inline">
72             <member>
73                 <link linkend="ged">ged</link>
74             </member>
75             <member>
76                 <link linkend="set">set</link>
77             </member>
78             <member>
79                 <link linkend="polyline_properties">segs_properties</link>
80             </member>
81             <member>
82                 <link linkend="segs_properties">segs_properties</link>
83             </member>
84         </simplelist>
85     </refsection>
86 </refentry>