Revision of help pages for some obsolete functions from module "graphics" (en_US).
[scilab.git] / scilab / modules / graphics / help / en_US / xget.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) ENPC - Jean-Philippe Chancelier
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="xget" xml:lang="en">
14     <refnamediv>
15         <refname>xget</refname>
16         <refpurpose>
17             get current values of the graphics context. <emphasis role="bold">This function is obsolete.</emphasis>
18         </refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>
23             [x1] = xget(str,[flag])
24             xget()
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Arguments</title>
29         <variablelist>
30             <varlistentry>
31                 <term>str</term>
32                 <listitem>
33                     <para>string.</para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>flag</term>
38                 <listitem>
39                     <para>optional. Set to 1 gives a verbose mode.</para>
40                 </listitem>
41             </varlistentry>
42         </variablelist>
43     </refsection>
44     <refsection>
45         <title>Description</title>
46         <para>
47             <warning>
48                 This function is obsolete.
49             </warning>.
50             Use the Scilab graphic objects representation instead (see the <link
51             linkend="set">set</link> and <link linkend="get">get</link>
52             functions as well as the <link linkend="graphics_entities">graphics
53             entities</link> help page).
54         </para>
55         <para>
56             This function is used to get values from the graphics context on the
57             topic specified by the string <varname>str</varname>. When called
58             with no argument, a choice menu is created showing the current
59             values and changes can be performed through toggle buttons.
60         </para>
61         <variablelist>
62             <varlistentry>
63                 <term>str = xget("auto clear")</term>
64                 <listitem>
65                     <para>
66                         Get the auto clear status (<literal>"on"</literal> or
67                         <literal>"off"</literal>).
68                     </para>
69                 </listitem>
70             </varlistentry>
71             <varlistentry>
72                 <term>color = xget("background")</term>
73                 <listitem>
74                     <para>
75                         Get the background color of the current
76                         <literal>Axes</literal> object. The result is a colormap
77                         index corresponding to the color.
78                     </para>
79                 </listitem>
80             </varlistentry>
81             <varlistentry>
82                 <term>rect = xget("clipping")</term>
83                 <listitem>
84                     <para>
85                         Get the clipping zone as a rectangle <literal>rect =
86                         [x,y,w,h]</literal> (Upper-Left point, Width, Height).
87                     </para>
88                 </listitem>
89             </varlistentry>
90             <varlistentry>
91                 <term>c = xget("color")</term>
92                 <listitem>
93                     <para>
94                         Get the default color for filling, line or text drawing
95                         functions. <literal>c</literal> is an integer projected
96                         in the interval <literal>[0,whiteid]</literal>. 0 stands
97                         for black filling and <literal>whiteid</literal> for
98                         white. The value of <literal>whiteid</literal> can be
99                         obtained with <code>xget("white")</code>.
100                     </para>
101                 </listitem>
102             </varlistentry>
103             <varlistentry>
104                 <term>cmap = xget("colormap")</term>
105                 <listitem>
106                     <para>
107                         Get the colormap used for the current graphics window as
108                         a <literal>m x 3</literal> RGB matrix.
109                     </para>
110                 </listitem>
111             </varlistentry>
112             <varlistentry>
113                 <term>dash = xget("dashes")</term>
114                 <listitem>
115                     <para>
116                         Get the dash style <literal>dash = [dash_number]</literal>
117                         where <literal>dash_number</literal> is the id of the
118                         dash.
119                         <warning>
120                             This keyword is obsolete, please use
121                             <literal>xget("color")</literal> or
122                             <literal>xget("line style")</literal> instead.
123                         </warning>
124                     </para>
125                 </listitem>
126             </varlistentry>
127             <varlistentry>
128                 <term>font = xget("font")</term>
129                 <listitem>
130                     <para>
131                         Get <literal>font = [fontid, fontsize]</literal>, the
132                         default font and the default value of font size.
133                     </para>
134                 </listitem>
135             </varlistentry>
136             <varlistentry>
137                 <term>fontsize = xget("font size")</term>
138                 <listitem>
139                     <para>Get the default value of font size.</para>
140                 </listitem>
141             </varlistentry>
142             <varlistentry>
143                 <term>color = xget("foreground")</term>
144                 <listitem>
145                     <para>
146                         Get the foreground color of the current
147                         <literal>Axes</literal> object. The result is a colormap index corresponding to the color.
148                     </para>
149                 </listitem>
150             </varlistentry>
151             <varlistentry>
152                 <term>str = xget("fpf")</term>
153                 <listitem>
154                     <para>
155                         Get the floating point format for number display in
156                         contour functions. Note that <literal>str</literal> is <literal>""</literal> when default format is used.
157                     </para>
158                 </listitem>
159             </varlistentry>
160             <varlistentry>
161                 <term>color = xget("hidden3d")</term>
162                 <listitem>
163                     <para>
164                         Get the color number for hidden faces in <function>plot3d</function>.</para>
165                 </listitem>
166             </varlistentry>
167             <varlistentry>
168                 <term>pat = xget("lastpattern")</term>
169                 <listitem>
170                     <para>
171                         Get the id of the last available pattern or color, with
172                         the current colormap of the current window. In fact
173                         <literal>pat+1</literal> and <literal>pat+2</literal>
174                         are also available and stand respectively for black and
175                         white pattern.
176                     </para>
177                 </listitem>
178             </varlistentry>
179             <varlistentry>
180                 <term>type = xget("line mode")</term>
181                 <listitem>
182                     <para>
183                         Get the line drawing mode. <literal>type = 1</literal>
184                         is absolute mode and <literal>type = 0</literal> is
185                         relative mode.
186                         <warning>
187                             The mode <literal>type = 0</literal> has bugs.
188                         </warning>
189                     </para>
190                 </listitem>
191             </varlistentry>
192             <varlistentry>
193                 <term>xget("line style")</term>
194                 <listitem>
195                     <para>
196                         Get the default line style (1 for solid line, &gt;1 for
197                         dashed lines).
198                     </para>
199                 </listitem>
200             </varlistentry>
201             <varlistentry>
202                 <term>mark = xget("mark")</term>
203                 <listitem>
204                     <para>
205                         Get the default mark id and the default mark size.
206                         <literal>mark=[markid, marksize]</literal>.
207                     </para>
208                 </listitem>
209             </varlistentry>
210             <varlistentry>
211                 <term>marksize = xget("mark size")</term>
212                 <listitem>
213                     <para>Get the default mark size.</para>
214                 </listitem>
215             </varlistentry>
216             <varlistentry>
217                 <term>pat = xget("pattern")</term>
218                 <listitem>
219                     <para>
220                         Get the current pattern or the current color.
221                         <literal>pat</literal> is an integer in the range
222                         <literal>[1, last]</literal>. When one uses black and
223                         white, 0 is used for black filling and
224                         <literal>last</literal> for white. The value of
225                         <literal>last</literal> can be obtained with
226                         <code>xget("lastpattern")</code>.
227                     </para>
228                 </listitem>
229             </varlistentry>
230             <varlistentry>
231                 <term>value = xget("thickness")</term>
232                 <listitem>
233                     <para>
234                         Get the thickness of lines in pixel (0 and 1 have the same meaning: 1 pixel thick).
235                     </para>
236                 </listitem>
237             </varlistentry>
238             <varlistentry>
239                 <term>flag = xget("use color")</term>
240                 <listitem>
241                     <para>
242                         Get the flag 0 (use black and white) or 1 (use colors).
243                         See <function>xset</function>.
244                     </para>
245                 </listitem>
246             </varlistentry>
247             <varlistentry>
248                 <term>[x, y] = xget("viewport")</term>
249                 <listitem>
250                     <para>
251                         Get the current position of the visible part of graphics
252                         in the panner.
253                     </para>
254                 </listitem>
255             </varlistentry>
256             <varlistentry>
257                 <term>dim = xget("wdim")</term>
258                 <listitem>
259                     <para>
260                         Get the width and the height of the current graphics
261                         window <literal>dim = [width, height]</literal>.
262                     </para>
263                 </listitem>
264             </varlistentry>
265             <varlistentry>
266                 <term>win = xget("window")</term>
267                 <listitem>
268                     <para>
269                         Get the current window number <literal>win</literal>.
270                     </para>
271                 </listitem>
272             </varlistentry>
273             <varlistentry>
274                 <term>pos = xget("wpos")</term>
275                 <listitem>
276                     <para>
277                         Get the position of the upper left point of the graphics
278                         window <literal>pos = [x, y]</literal>.
279                     </para>
280                 </listitem>
281             </varlistentry>
282         </variablelist>
283     </refsection>
284     <refsection role="see also">
285         <title>See Also</title>
286         <simplelist type="inline">
287             <member>
288                 <link linkend="xset">xset</link>
289             </member>
290             <member>
291                 <link linkend="getcolor">getcolor</link>
292             </member>
293             <member>
294                 <link linkend="getsymbol">getsymbol</link>
295             </member>
296             <member>
297                 <link linkend="ged">ged</link>
298             </member>
299             <member>
300                 <link linkend="set">set</link>
301             </member>
302             <member>
303                 <link linkend="graphics_entities">graphics entities</link>
304             </member>
305         </simplelist>
306     </refsection>
307     <refsection>
308         <title>History</title>
309         <revhistory>
310             <revision>
311                 <revnumber>5.4.0</revnumber>
312                 <revremark>
313                     The "alufunction" property is no more supported, this property was no more used for rendering since Scilab 5.0.1.
314                 </revremark>
315             </revision>
316         </revhistory>
317     </refsection>
318 </refentry>