cgwindow_getdefs.pro
13.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
; docformat = 'rst'
;
; NAME:
; cgWindow_GetDefs
;
; PURPOSE:
; Allows the user to get the global defaults for resizeable cgWindow programs.
;
;******************************************************************************************;
; ;
; Copyright (c) 2011, by Fanning Software Consulting, Inc. All rights reserved. ;
; ;
; Redistribution and use in source and binary forms, with or without ;
; modification, are permitted provided that the following conditions are met: ;
; ;
; * Redistributions of source code must retain the above copyright ;
; notice, this list of conditions and the following disclaimer. ;
; * Redistributions in binary form must reproduce the above copyright ;
; notice, this list of conditions and the following disclaimer in the ;
; documentation and/or other materials provided with the distribution. ;
; * Neither the name of Fanning Software Consulting, Inc. nor the names of its ;
; contributors may be used to endorse or promote products derived from this ;
; software without specific prior written permission. ;
; ;
; THIS SOFTWARE IS PROVIDED BY FANNING SOFTWARE CONSULTING, INC. ''AS IS'' AND ANY ;
; EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES ;
; OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT ;
; SHALL FANNING SOFTWARE CONSULTING, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, ;
; INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED ;
; TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; ;
; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ;
; ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT ;
; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS ;
; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ;
;******************************************************************************************;
;
;+
; Allows the user to get the global defaults for resizeable cgWindow programs.
;
; :Categories:
; Graphics
;
; :Keywords:
; adjustsize: out, optional, type=boolean
; If set, adjust the default text size to match the display window size.
; aspect: out, optional, type=float
; The aspect ratio of the window.
; background: out, optional, type=string
; The background color of the window.
; delay: out, optional, type=float
; The amount of delay between command execution.
; eraseit: out, optional, type=boolean
; The Erase status of the window.
; im_density: out, optional, type=integer
; The sampling density.
; im_png8: out, optional, type=boolean
; If set, ImageMagick will create 8-bit PNG files, rather than 24-bit.
; im_options: out, optional, type=string
; Current ImageMagick convert options.
; im_raster: out, optional, type=boolean
; The raster via ImageMagick setting.
; im_resize: out, optional, type=integer
; The amount PostScript output is resized.
; im_tiff_depth: out, optional, type=integer
; The number of bits per channel in TIFF files converted with ImageMagick.
; im_transparent: out, optional, type=boolean
; The transparent background setting.
; im_width: out, optional, type=integer
; The final width of ImageMagick raster file output.
; multi: out, optional, type=Intarr(5)
; The !P.MULTI setting for the window.
; palette: out, optional, type=byte
; The window color palette.
; pdf_path: out, optional, type=string
; The name of the path to the Ghostscript command for converting PS to PDF.
; pdf_unix_convert_cmd: out, optional, type=string
; The name of an alternative UNIX command to convert PostScript to PDF.
; ps_charsize: out, optional, type=float, default=0.0
; The PostScript character size.
; ps_decomposed: out, optional, type=boolean
; The PostScript decomposed status of the window.
; ps_delete: out, optional, type=boolean
; The delete PostScript file status of the window.
; ps_encapsulated: out, optional, type=boolean
; The PostScript encapsulated status of the window.
; ps_font: out, optional, type=integer
; The font being using for PostScript output.
; ps_metric: out, optional, type=boolean
; The metric status of the window.
; ps_quiet: out, optional, type=boolean
; Set to one of the QUIET keyword is set on cgPS_Config.
; ps_scale_factor: out, optional, type=float
; The PostScript scale factor.
; ps_tt_font: out, optional, type=string
; The name of the PostScript true-type font in current use.
; title: out, optional, type=boolean
; The window title.
; xomargin: out, optional, type=intarr(2)
; The !X.OMargin value for multiplots.
; xpos: out, optional, type=integer
; The X offset of the window from the upper-left corner of the display.
; xsize: out, optional, type=integer
; The starting X size of the window.
; yomargin: out, optional, type=intarr(2)
; The !Y.OMargin value for multiplots.
; ypos: out, optional, type=integer
; The Y offset of the window from the upper-left corner of the display.
; ysize: out, optional, type=integer
; The starting Y size of the window.
;
; :Examples:
; Used to get cgWindow global properties::
; IDL> cgWindow_GetDefs, PALETTE=palette, PS_ENCAPSULATED=encap, PS_METRIC=metric
;
; :Author:
; FANNING SOFTWARE CONSULTING::
; David W. Fanning
; 1645 Sheely Drive
; Fort Collins, CO 80526 USA
; Phone: 970-221-0438
; E-mail: david@idlcoyote.com
; Coyote's Guide to IDL Programming: http://www.idlcoyote.com
;
; :History:
; Change History::
; Written, 29 January 2011. DWF.
; Added PS_QUIET keyword. 17 Feb 2011. DWF.
; Added Raster_IM. 18 Feb 2011. Jeremy Bailin
; Added the ability to set and unset adjustable text size in
; cgWindow with ADJUSTSIZE keyword. 24 April 2011. DWF.
; Added PS_DECOMPOSED keyword to allow getting/setting of PostScript decomposed
; value. 30 Aug 2011. DWF.
; Added ASPECT keyword to allow getting/setting of window aspect ratio. 18 Nov 2011. DWF.
; Added PDF_UNIX_CONVERT_CMD and PDF_PATH keywords. 7 Dec 2011. DWF.
; Added IM_WIDTH keyword. 3 April 2012. DWF.
; Added IM_PNG8 keyword. 3 April 2012. DWF.
; Added IM_TIFF_DEPTH keyowrd. 14 May 2013. DWF.
;
; :Copyright:
; Copyright (c) 2011-2012, Fanning Software Consulting, Inc.
;-
PRO cgWindow_GetDefs, $
AdjustSize = adjustsize, $ ; Adjusts text size to fit display window size.
Aspect = aspect, $ ; The window aspect ratio.
Background = background, $ ; The background color.
Delay = delay, $ ; The amount of delay between command execution.
EraseIt = eraseit, $ ; Set this keyword to erase the display before executing the commands.
Multi = multi, $ ; Set this in the same way !P.Multi is used.
XOMargin = xomargin, $ ; Set the !X.OMargin. A two element array.
YOMargin = yomargin, $ ; Set the !Y.OMargin. A two element array
XSize = xsize, $ ; The X size of the cgWindow graphics window.
YSize = ysize, $ ; The Y size of the cgWindow graphics window.
Title = title, $ ; The window title.
XPos = xpos, $ ; The X offset of the window on the display.
YPos = ypos, $ ; The Y offset of the window on the display.
Palette = palette, $ ; The color table palette to use for the window.
; ImageMagick Properties.
IM_Density = im_density, $ ; Sets the density parameter on ImageMagick convert command.
IM_PNG8 = im_png8, $ ; Sets the flag for 8-bit PNG files to be created.
IM_Options = im_options, $ ; Sets extra ImageMagick options on the ImageMagick convert command.
IM_Raster = im_raster, $ ; Sets the raster via ImageMagick setting.
IM_Resize = im_resize, $ ; Sets the resize parameter on ImageMagick convert command.
IM_TIFF_Depth = im_tiff_depth, $ ; Set the channel depth of TIFF files on ImageMagick convert command.
IM_Transparent = im_transparent, $ ; Sets the "alpha" keyword on ImageMagick convert command.
IM_Width = im_width, $ ; Sets the final width of ImageMagick raster output.
; PDF properties.
PDF_Unix_Convert_Cmd = pdf_unix_convert_cmd, $ ; Command to convert PS to PDF.
PDF_Path = pdf_path, $ ; The path to the Ghostscript conversion command.
; PostScript properties.
PS_CHARSIZE=ps_charsize, $ ; Select the character size for PostScript output.
PS_Decomposed = ps_decomposed, $ ; If set, use decomposed color in PostScript.
PS_Delete = ps_delete, $ ; Delete the PostScript file when making IM files.
PS_Metric = ps_metric, $ ; Select metric measurements in PostScript output.
PS_Encapsulated = ps_encapsulated, $ ; Create Encapsulated PostScript output.
PS_FONT=ps_font, $ ; Select the font for PostScript output.
PS_QUIET=ps_quiet, $ ; The QUIET keyword to cgPS_Open.
PS_SCALE_FACTOR=ps_scale_factor, $ ; Select the scale factor for PostScript output.
PS_TT_FONT=ps_tt_font ; Select the true-type font to use for PostScript output.
Compile_Opt idl2
; Return to caller on error.
ON_Error, 2
; Does the defaults structure exist? If not, create the defaults.
DefSysV, '!FSC_WINDOW_DEFAULTS', EXISTS=exists
IF ~exists THEN cgWindow_SetDefs
; If the user asked for the default, give it to them.
IF Arg_Present(adjustsize) THEN adjustsize = !FSC_WINDOW_DEFAULTS.adjustsize
IF Arg_Present(aspect) THEN aspect = !FSC_WINDOW_DEFAULTS.aspect
IF Arg_Present(background) THEN background = !FSC_WINDOW_DEFAULTS.background
IF Arg_Present(delay) THEN delay = !FSC_WINDOW_DEFAULTS.delay
IF Arg_Present(eraseit) THEN eraseit = !FSC_WINDOW_DEFAULTS.eraseit
IF Arg_Present(multi) THEN multi = !FSC_WINDOW_DEFAULTS.multi
IF Arg_Present(xomargin) THEN xomargin = !FSC_WINDOW_DEFAULTS.xomargin
IF Arg_Present(yomargin) THEN yomargin = !FSC_WINDOW_DEFAULTS.yomargin
IF Arg_Present(xsize) THEN xsize = !FSC_WINDOW_DEFAULTS.xsize
IF Arg_Present(ysize) THEN ysize = !FSC_WINDOW_DEFAULTS.ysize
IF Arg_Present(title) THEN title = !FSC_WINDOW_DEFAULTS.title
IF Arg_Present(xpos) THEN xpos = !FSC_WINDOW_DEFAULTS.xpos
IF Arg_Present(ypos) THEN ypos = !FSC_WINDOW_DEFAULTS.ypos
IF Arg_Present(palette) THEN palette = !FSC_WINDOW_DEFAULTS.palette
IF Arg_Present(im_density) THEN im_density = !FSC_WINDOW_DEFAULTS.im_density
IF Arg_Present(im_png8) THEN im_png8 = !FSC_WINDOW_DEFAULTS.im_png8
IF Arg_Present(im_options) THEN im_options = !FSC_WINDOW_DEFAULTS.im_options
IF Arg_Present(im_raster) THEN im_raster = !FSC_WINDOW_DEFAULTS.im_raster
IF Arg_Present(im_resize) THEN im_resize = !FSC_WINDOW_DEFAULTS.im_resize
IF Arg_Present(im_tiff_depth) THEN im_tiff_depth = !FSC_WINDOW_DEFAULTS.im_tiff_depth
IF Arg_Present(im_transparent) THEN im_transparent = !FSC_WINDOW_DEFAULTS.im_transparent
IF Arg_Present(im_width) THEN im_width = !FSC_WINDOW_DEFAULTS.im_width
IF Arg_Present(pdf_unix_convert_cmd) THEN pdf_unix_convert_cmd = !FSC_WINDOW_DEFAULTS.pdf_unix_convert_cmd
IF Arg_Present(pdf_path) THEN pdf_path = !FSC_WINDOW_DEFAULTS.pdf_path
IF Arg_Present(ps_decomposed) THEN ps_decomposed = !FSC_WINDOW_DEFAULTS.ps_decomposed
IF Arg_Present(ps_delete) THEN ps_delete = !FSC_WINDOW_DEFAULTS.ps_delete
IF Arg_Present(ps_metric) THEN ps_metric = !FSC_WINDOW_DEFAULTS.ps_metric
IF Arg_Present(ps_encapsulated) THEN ps_encapsulated =!FSC_WINDOW_DEFAULTS.ps_encapsulated
IF Arg_Present(ps_charsize) THEN ps_charsize =!FSC_WINDOW_DEFAULTS.ps_charsize
IF Arg_Present(ps_font) THEN ps_font =!FSC_WINDOW_DEFAULTS.ps_font
IF Arg_Present(ps_quiet) THEN ps_quiet =!FSC_WINDOW_DEFAULTS.ps_quiet
IF Arg_Present(ps_scale_factor) THEN ps_scale_factor =!FSC_WINDOW_DEFAULTS.ps_scale_factor
IF Arg_Present(ps_tt_font) THEN ps_tt_font =!FSC_WINDOW_DEFAULTS.ps_tt_font
END