32162de0bb376ab439e9dcf7280b271b18f3a506
[scilab.git] / scilab / modules / graphics / help / en_US / text / getfont.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-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="getfont" xml:lang="en">
14     <refnamediv>
15         <refname>getfont</refname>
16         <refpurpose>
17             dialog to select font <emphasis role="bold">.Obsolete
18                 function.
19             </emphasis>
20         </refpurpose>
21     </refnamediv>
22     <refsynopsisdiv>
23         <title>Calling Sequence</title>
24         <synopsis>[fId,fSize]=getfont()
25             [fId,fSize]=getfont(str)
26             fnt=getfont()
27             fnt=getfont(str)
28             fnt=getfont(S=str,font=[fId,fSize])
29         </synopsis>
30     </refsynopsisdiv>
31     <refsection>
32         <title>Arguments</title>
33         <variablelist>
34             <varlistentry>
35                 <term>str</term>
36                 <listitem>
37                     <para>character (e.g. "a")</para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>fId</term>
42                 <listitem>
43                     <para>integer, the number of the selected font</para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>fSize</term>
48                 <listitem>
49                     <para>integer, the size of the selected font</para>
50                 </listitem>
51             </varlistentry>
52             <varlistentry>
53                 <term>fnt</term>
54                 <listitem>
55                     <para>vector [fId,fSize]</para>
56                 </listitem>
57             </varlistentry>
58         </variablelist>
59     </refsection>
60     <refsection>
61         <title>Description</title>
62         <para>
63             This function designed to work with the <link linkend="xset">xset</link> function <emphasis role="bold">is also
64                 obsolete
65             </emphasis>
66             .Use the property editor <link linkend="ged">ged</link> instead.
67         </para>
68         <para>
69             <literal>getfont</literal> opens a graphic window to select a font.
70             User has to select a font and a size clicking on the corresponding
71             displayed character. Killing a keyboard key changes the displayed
72             character.
73         </para>
74     </refsection>
75     <refsection>
76         <title>Examples</title>
77         <programlisting role="example"><![CDATA[ 
78 [fId,fSize]=getfont();
79 xset("font",fId,fSize)
80 plot2d(0,0,rect=[0 0 10 10],axesflag=0)
81 xstring(5,5,"string")
82  ]]></programlisting>
83         <!--  
84     <scilab:image>
85       [fId,fSize]=getfont();
86       xset("font",fId,fSize)
87     </scilab:image>
88 -->
89         
90     </refsection>
91     <refsection role="see also">
92         <title>See Also</title>
93         <simplelist type="inline">
94             <member>
95                 <link linkend="ged">ged</link>
96             </member>
97             <member>
98                 <link linkend="text_properties">text_properties</link>
99             </member>
100         </simplelist>
101     </refsection>
102 </refentry>