← Back to branch summary

~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/eng/graphics/xget.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
http://bugs.debian.org/255869
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/eng/graphics/xget.xml
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>xget</TITLE>
 
6
  <TYPE>Scilab Function</TYPE>
 
7
  <DATE>April 1993</DATE>
 
8
  <SHORT_DESCRIPTION name="xget"> get current values of the graphics context</SHORT_DESCRIPTION>
 
9
  <CALLING_SEQUENCE>
 
10
    <CALLING_SEQUENCE_ITEM>[x1]=xget(str,[flag])  </CALLING_SEQUENCE_ITEM>
 
11
    <CALLING_SEQUENCE_ITEM>xget()  </CALLING_SEQUENCE_ITEM>
 
12
  </CALLING_SEQUENCE>
 
13
  <PARAM>
 
14
    <PARAM_INDENT>
 
15
      <PARAM_ITEM>
 
16
        <PARAM_NAME>str</PARAM_NAME>
 
17
        <PARAM_DESCRIPTION>
 
18
          <SP>: string.</SP>
 
19
        </PARAM_DESCRIPTION>
 
20
      </PARAM_ITEM>
 
21
      <PARAM_ITEM>
 
22
        <PARAM_NAME>flag</PARAM_NAME>
 
23
        <PARAM_DESCRIPTION>
 
24
          <SP>: optional. Set to 1 gives a verbose mode.</SP>
 
25
        </PARAM_DESCRIPTION>
 
26
      </PARAM_ITEM>
 
27
    </PARAM_INDENT>
 
28
  </PARAM>
 
29
  <DESCRIPTION>
 
30
    <P>
 
31
    This function is used to get values from the graphics context
 
32
    on the topic specified by the string <VERB>str</VERB>. When called with
 
33
    no argument, a choice menu is created showing the current values and 
 
34
    changes can be performed through toggle buttons.
 
35
  </P>
 
36
    <DESCRIPTION_INDENT>
 
37
      <DESCRIPTION_ITEM label="number=xget(&quot;alufunction&quot;)">
 
38
        <SP>: Get the logical function number used for drawing. See <VERB>xset</VERB>.</SP>
 
39
      </DESCRIPTION_ITEM>
 
40
      <DESCRIPTION_ITEM label="str=xget(&quot;auto clear&quot;)">
 
41
        <SP>: Get the auto clear status (<VERB>&quot;on&quot;</VERB> or <VERB>&quot;off&quot;</VERB>).</SP>
 
42
      </DESCRIPTION_ITEM>
 
43
      <DESCRIPTION_ITEM label="color=xget(&quot;background&quot;)">
 
44
        <SP>: Get the background color of the current graphics window.</SP>
 
45
      </DESCRIPTION_ITEM>
 
46
      <DESCRIPTION_ITEM label="rect=xget(&quot;clipping&quot;)">
 
47
        <SP>:  Get the clipping zone as a rectangle rect=[x,y,w,h] (Upper-Left point Width Height).</SP>
 
48
      </DESCRIPTION_ITEM>
 
49
      <DESCRIPTION_ITEM label="c=xget(&quot;color&quot;)">
 
50
        <SP>: Get the default color for filling, line or text drawing functions.  <VERB>c</VERB> is an integer projected in the interval [0,whiteid]. 0 stands for black filling and whiteid for white. The value of whiteid can be obtained with <VERB>xget(&quot;white&quot;)</VERB>.</SP>
 
51
      </DESCRIPTION_ITEM>
 
52
      <DESCRIPTION_ITEM label="cmap=xget(&quot;colormap&quot;)">
 
53
        <SP>: Get the colormap used for the current graphics window as a m x 3 RGB matrix.</SP>
 
54
      </DESCRIPTION_ITEM>
 
55
      <DESCRIPTION_ITEM label="dash=xget(&quot;dashes&quot;)">
 
56
        <SP>: Get the dash style dash=[dash_number] where dash_number is the id of the dash. This keyword is obsolete, please use <VERB>xget(&quot;color&quot;)</VERB> or  <VERB>xget(&quot;line style&quot;)</VERB> instead.</SP>
 
57
      </DESCRIPTION_ITEM>
 
58
      <DESCRIPTION_ITEM label="font=xget(&quot;font&quot;)">
 
59
        <SP>: Get font=[fontid,fontsize], the default font and the default size for fonts. size.</SP>
 
60
      </DESCRIPTION_ITEM>
 
61
      <DESCRIPTION_ITEM label="fontsize=xget(&quot;font size&quot;)">
 
62
        <SP>: Get the default size for fonts size.</SP>
 
63
      </DESCRIPTION_ITEM>
 
64
      <DESCRIPTION_ITEM label="color=xget(&quot;foreground&quot;)">
 
65
        <SP>: Get the foreground color of the current graphics window.</SP>
 
66
      </DESCRIPTION_ITEM>
 
67
      <DESCRIPTION_ITEM label="str=xget(&quot;fpf&quot;)">
 
68
        <SP>: Get the floating point format for number display in contour functions. Note that <VERB>str</VERB> is <VERB>&quot;&quot;</VERB> when default format is used.</SP>
 
69
      </DESCRIPTION_ITEM>
 
70
      <DESCRIPTION_ITEM label="color=xget(&quot;hidden3d&quot;)">
 
71
        <SP>: Get the color number for hidden faces in plot3d.</SP>
 
72
      </DESCRIPTION_ITEM>
 
73
      <DESCRIPTION_ITEM label="pat=xget(&quot;lastpattern&quot;)">
 
74
        <SP>: Get the id of the last available pattern or color, with the current  colormap of  the current window. In fact <VERB>pat+1</VERB> and <VERB>pat+2</VERB> are also available and stand respectively for black and white pattern.</SP>
 
75
      </DESCRIPTION_ITEM>
 
76
      <DESCRIPTION_ITEM label="type=xget(&quot;line mode&quot;)">
 
77
        <SP>: Get the line drawing mode.  type=1 is absolute mode and type=0 is relative mode. (Warning: the mode type=0 is has bugs)</SP>
 
78
      </DESCRIPTION_ITEM>
 
79
      <DESCRIPTION_ITEM label="xget(&quot;line style&quot;)">
 
80
        <SP>: Get the default line style (1: solid, &gt;1 for dashed lines).</SP>
 
81
      </DESCRIPTION_ITEM>
 
82
      <DESCRIPTION_ITEM label="mark=xget(&quot;mark&quot;)">
 
83
        <SP>: Get the default mark id and the default marks size. <VERB>mark=[markid,marksize]</VERB>.</SP>
 
84
      </DESCRIPTION_ITEM>
 
85
      <DESCRIPTION_ITEM label="marksize=xget(&quot;mark size&quot;)">
 
86
        <SP>: Get the default marks size.</SP>
 
87
      </DESCRIPTION_ITEM>
 
88
      <DESCRIPTION_ITEM label="pat=xget(&quot;pattern&quot;)">
 
89
        <SP>: Get the current pattern or the current color. <VERB>pat</VERB> is an integer  in the range <VERB>[1,last]</VERB>. When one uses black and white,  0 is used for black filling and  <VERB>last</VERB> for white. The value of <VERB>last</VERB> can be obtained with  <VERB>xget(&quot;lastpattern&quot;)</VERB>.</SP>
 
90
      </DESCRIPTION_ITEM>
 
91
      <DESCRIPTION_ITEM label="value=xget(&quot;thickness&quot;)">
 
92
        <SP>: Get the thickness of lines in pixel (0 and 1 have the same meaning: 1 pixel thick).</SP>
 
93
      </DESCRIPTION_ITEM>
 
94
      <DESCRIPTION_ITEM label="flag=xget(&quot;use color&quot;)">
 
95
        <SP>: Get the flag 0 (use black and white) or 1 (use colors). See <VERB>xset</VERB>.</SP>
 
96
      </DESCRIPTION_ITEM>
 
97
      <DESCRIPTION_ITEM label="[x,y]=xget(&quot;viewport&quot;)">
 
98
        <SP>: Get the current postion of the visible part of graphics in the panner.</SP>
 
99
      </DESCRIPTION_ITEM>
 
100
      <DESCRIPTION_ITEM label="dim=xget(&quot;wdim&quot;)">
 
101
        <SP>: Get the width and the height of the current graphics window dim=[width,height].</SP>
 
102
      </DESCRIPTION_ITEM>
 
103
      <DESCRIPTION_ITEM label="win=xget(&quot;window&quot;)">
 
104
        <SP>: Get the current window number <VERB>win</VERB>.</SP>
 
105
      </DESCRIPTION_ITEM>
 
106
      <DESCRIPTION_ITEM label="pos=xget(&quot;wpos&quot;);">
 
107
        <SP>: Get the position of the upper left point of the graphics window pos=[x,y].</SP>
 
108
      </DESCRIPTION_ITEM>
 
109
    </DESCRIPTION_INDENT>
 
110
  </DESCRIPTION>
 
111
  <SEE_ALSO>
 
112
    <SEE_ALSO_ITEM>
 
113
      <LINK>xset</LINK>
 
114
    </SEE_ALSO_ITEM>
 
115
    <SEE_ALSO_ITEM>
 
116
      <LINK>colormap</LINK>
 
117
    </SEE_ALSO_ITEM>
 
118
  </SEE_ALSO>
 
119
  <AUTHOR>J.Ph.C.  </AUTHOR>
 
120
</MAN>