-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathdoc_template.pro
80 lines (80 loc) · 4.21 KB
/
doc_template.pro
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
; docformat = 'rst'
;
; NAME:
; MaxWindowSize
;
; PURPOSE:
; Returns the resolution of the largest unobstructed graphics window that can be
; created on this particular graphics device. Works properly for Windows and UNIX
; computers, excluding Macintosh computers. There is no known way to find the resolution
; of the largest unobstructed graphics window on a Macintosh computer, so a fudge factor
; of 22 pixels is used to account for the Macintosh "dock".
;
;******************************************************************************************;
; ;
; Copyright (c) 2012, 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. ;
;******************************************************************************************;
;
;+
; :Description:
; Returns the resolution of the largest unobstructed graphics window that can be
; created on this particular graphics device. Works properly for Windows and UNIX
; computers, excluding Macintosh computers. There is no known way to find the resolution
; of the largest unobstructed graphics window on a Macintosh computer, so a fudge factor
; of 22 pixels is used to account for the Macintosh "dock".
;
; :Categories:
; Utility
;
; :Params:
; none:
;
; :Keywords:
; monitor_resolution: out, optional, type=long
; Set this keyword to a named variable to return the resolution of the
; primary display monitor.
;
; :Examples:
; To create a window of maximum size::
; maxsize = MaxWindowSize()
; Window, XSize=maxsize[0], YSize=maxsize[1], /Free
;
; :Author:
; FANNING SOFTWARE CONSULTING::
; David W. Fanning
; 1645 Sheely Drive
; Fort Collins, CO 80526 USA
; Phone: 970-221-0438
; E-mail: [email protected]
; Coyote's Guide to IDL Programming: http://www.dfanning.com
;
; :History:
; Change History::
; Written, 26 October 2010. DWF.
;
; :Copyright:
; Copyright (c) 2012, Fanning Software Consulting, Inc.
;-