File: cgcleanup.pro

package info (click to toggle)
coyote 2019.01.29-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster
  • size: 6,316 kB
  • sloc: python: 184; makefile: 14; sh: 13
file content (172 lines) | stat: -rw-r--r-- 7,120 bytes parent folder | download | duplicates (2)
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
; docformat = 'rst'
;
; NAME:
;   cgCLEANUP
;
; PURPOSE:
; 
; This procedure cleans-up and/or destroys any open graphics or widget windows on the display.
;******************************************************************************************;
;                                                                                          ;
;  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.                            ;
;******************************************************************************************;
;
;+
; This procedure cleans-up and/or destroys any open graphics or widget windows on the display.
;
; :Categories:
;    Utility
;       
; :Examples:
;    For example, to destroy all windows on the display::
;       IDL> cgCleanup
;
; :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:
;     Written, 6 October 2012.
;
; :Copyright:
;     Copyright (c) 2012, Fanning Software Consulting, Inc.
;-

;+
; This procedure cleans up any open graphics windows and widget windows for
; versions of IDL prior to IDL 8.
;
; :Keywords:
;     all: in, optional, type=boolean, default=1
;       Set this keyword if you wish to clean up windows of all types.
;     cg: in, optional, type=boolean, default=0
;       Set this keyword if you wish to clean up only Coyote Graphics windows.
;     dg: in, optional, type=boolean, default=0
;       Set this keyword if you wish to clean up only Direct Graphics windows.
;-
PRO cgCleanUp_v7, ALL=all, CG=cg, DG=dg

    Compile_Opt idl2
    
    Catch, theError
    IF theError NE 0 THEN BEGIN
        Catch, /CANCEL
        void = cgErrorMsg()
        RETURN
    ENDIF
    
    ; By default clear out all of the windows
    anySet = Keyword_Set(cg) + Keyword_Set(dg)
    doAll = ( N_Elements(all) EQ 0 && anySet EQ 0) ? 1 : Keyword_Set(all)
    
    IF (doAll || Keyword_Set(cg) ) THEN BEGIN
        ; Widget windows or Coyote Graphics windows.
        Widget_Control, /Reset
    ENDIF
    
    IF (doAll || Keyword_Set(dg) ) THEN BEGIN
        ; IDL direct graphics windows.
        WHILE !D.Window GT -1 DO WDelete, !D.Window
    ENDIF
    
END ;--------------------------------------------------------------------------------------

;+
; This procedure cleans up any open graphics windows and widget windows for
; versions of IDL from IDL 8 onward.
;
; :Keywords:
;     all: in, optional, type=boolean, default=1
;       Set this keyword if you wish to clean up windows of all types.
;     cg: in, optional, type=boolean, default=0
;       Set this keyword if you wish to clean up only Coyote Graphics windows.
;     dg: in, optional, type=boolean, default=0
;       Set this keyword if you wish to clean up only Direct Graphics windows.
;     fg: in, optional, type=boolean, default=0
;       Set this keyword if you wish to clean up only Function Graphics windows.
;-
PRO cgCleanUp_v8, ALL=all, CG=cg, DG=dg, FG=fg

    Compile_Opt idl2
    
    Catch, theError
    IF theError NE 0 THEN BEGIN
        Catch, /CANCEL
        void = cgErrorMsg()
        RETURN
    ENDIF
    
    ; By default clear out all of the windows
    anySet = Keyword_Set(cg) + Keyword_Set(dg) + Keyword_Set(fg)
    doAll = ( N_Elements(all) EQ 0 && anySet EQ 0) ? 1 : Keyword_Set(all)
    
    IF ((doAll || Keyword_Set(fg)) && (Float(!Version.Release)) GE 8.0 ) THEN BEGIN
        ; Function graphics windows.
        windowObjs = GetWindows()
        Obj_Destroy, windowObjs
    ENDIF
    
    IF (doAll || Keyword_Set(cg) ) THEN BEGIN
        ; Widget windows or Coyote Graphics windows.
        Widget_Control, /Reset
    ENDIF
    
    IF (doAll || Keyword_Set(dg) ) THEN BEGIN
        ; IDL direct graphics windows.
        WHILE !D.Window GT -1 DO WDelete, !D.Window
    ENDIF
    
END ;--------------------------------------------------------------------------------------


;+
; This procedure chooses between cleanup for version 7 and earlier of IDL, or version 8 and later.
;
; :Keywords:
;     all: in, optional, type=boolean, default=1
;       Set this keyword if you wish to clean up windows of all types.
;     cg: in, optional, type=boolean, default=0
;       Set this keyword if you wish to clean up only Coyote Graphics windows.
;     dg: in, optional, type=boolean, default=0
;       Set this keyword if you wish to clean up only Direct Graphics windows.
;     fg: in, optional, type=boolean, default=0
;       Set this keyword if you wish to clean up only Function Graphics windows.
;
;-
PRO cgCleanUp, ALL=all, CG=cg, DG=dg, FG=fg

   IF (Float(!Version.Release) GE 8.0) THEN BEGIN
      cgCleanUp_v8, ALL=all, CG=cg, DG=dg, FG=fg
   ENDIF ELSE BEGIN
      cgCleanUp_v7, ALL=all, CG=cg, DG=dg
   ENDELSE

END ;--------------------------------------------------------------------------------------