source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/IMAGE/image_viewer.html @ 89

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 11.4 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>image_viewer.pro (IDLdoc API documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="image_viewer.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="animgif.html">&lt;&lt;prev file</a> | <a href="imdisp.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="image_viewer.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/IMAGE/</a></h1>
82      <h2 class="pro_file">image_viewer.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98      <div id="routine_summary">               
99        <h2>Routine summary</h2>
100       
101        <dl>
102         
103          <dt><p><a href="#_IMAGE_VIEWER_OPEN_FILES">IMAGE_VIEWER_OPEN_FILES<span class="result">, event</span></a></p><dt>
104          <dd>  NAME:        IMAGE_VIEWER   PURPOSE:        The purpose of this program is to provide an interactive tool that can be used        to view JPEG, BMP, GIF, PNG, and TIFF picture files.</dd>     
105         
106          <dt><p><a href="#_IMAGE_VIEWER_OPEN_FOLDER">IMAGE_VIEWER_OPEN_FOLDER<span class="result">, event</span></a></p><dt>
107          <dd></dd>     
108         
109          <dt><p><a href="#_IMAGE_VIEWER_CANCEL">IMAGE_VIEWER_CANCEL<span class="result">, event</span></a></p><dt>
110          <dd></dd>     
111         
112          <dt><p><a href="#_IMAGE_VIEWER_TIMER">IMAGE_VIEWER_TIMER<span class="result">, event</span></a></p><dt>
113          <dd></dd>     
114         
115          <dt><p><a href="#_IMAGE_VIEWER_EXIT">IMAGE_VIEWER_EXIT<span class="result">, event</span></a></p><dt>
116          <dd></dd>     
117         
118          <dt><p><a href="#_IMAGE_VIEWER_HELP">IMAGE_VIEWER_HELP<span class="result">, event</span></a></p><dt>
119          <dd></dd>     
120         
121          <dt><p><a href="#_IMAGE_VIEWER_THUMBS">IMAGE_VIEWER_THUMBS<span class="result">, event</span></a></p><dt>
122          <dd></dd>     
123         
124          <dt><p><a href="#_IMAGE_VIEWER_CLEANUP">IMAGE_VIEWER_CLEANUP<span class="result">, widgetID</span></a></p><dt>
125          <dd></dd>     
126         
127          <dt><p><a href="#_IMAGE_VIEWER_EVENT">IMAGE_VIEWER_EVENT<span class="result">, event</span></a></p><dt>
128          <dd></dd>     
129         
130          <dt><p><a href="#_IMAGE_VIEWER">IMAGE_VIEWER</a></p><dt>
131          <dd></dd>     
132               
133        </dl>
134      </div>
135     
136
137      <div id="routine_details">
138       
139
140        <div class="routine_details" id="_IMAGE_VIEWER_OPEN_FILES">
141
142          <h2><a class="top" href="#container">top</a>IMAGE_VIEWER_OPEN_FILES </h2>
143       
144          <p class="header">
145            IMAGE_VIEWER_OPEN_FILES<span class="result">, <a href="#_IMAGE_VIEWER_OPEN_FILES_param_event">event</a></span></p>
146       
147          <div class="comments">
148 NAME:
149       IMAGE_VIEWER
150
151 PURPOSE:
152       The purpose of this program is to provide an interactive tool that can be used
153       to view JPEG, BMP, GIF, PNG, and TIFF picture files.  Images are loaded into
154       memory, so the initial file access may take a while, but once each picture has
155       been opened they can all be viewed in a very rapid fashion.
156
157 CATEGORY:
158       Visualization, Widgets
159
160 CALLING SEQUENCE:
161       image_viewer
162
163 INPUT PARAMETERS:
164       None.
165
166 KEYWORD PARAMETERS:
167       None.
168
169 OUTPUTS:
170       None.
171
172 COMMON BLOCKS:
173       None.
174
175 SIDE EFFECTS:
176       While this program is running in an IDL session it will change the current
177       working directory, enables/disables color decomposition, and sets !QUIET=1,
178       !ORDER=0, & !P.BACKGROUND=0.  These settings are returned to their initial
179       settings before the program was initiated once it is terminated.
180
181 RESTRICTIONS:
182       This program is supported in IDL version 5.5 and newer.  In order to open
183       GIF files or TIFF files with LZW compression the copy of IDL being used must
184       be licensed with these features.  IDL only supports BMP files in the standard
185       Windows format and does not support OS2 bitmaps.
186
187 MODIFICATION HISTORY:
188       Written by: AEB, 1/02.</div>
189
190         
191
192         
193            <h3>Parameters</h3>
194       
195           
196            <h4 id="_IMAGE_VIEWER_OPEN_FILES_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
197             
198             
199             
200             
201             
202             
203             
204             
205            </h4>
206       
207          <div class="comments"></div>
208           
209
210         
211
212         
213
214         
215         
216         
217         
218         
219         
220         
221         
222         
223         
224         
225         
226       
227         
228         
229         
230         
231         
232         
233         
234       
235         
236       
237        </div>
238       
239
240        <div class="routine_details" id="_IMAGE_VIEWER_OPEN_FOLDER">
241
242          <h2><a class="top" href="#container">top</a>IMAGE_VIEWER_OPEN_FOLDER </h2>
243       
244          <p class="header">
245            IMAGE_VIEWER_OPEN_FOLDER<span class="result">, <a href="#_IMAGE_VIEWER_OPEN_FOLDER_param_event">event</a></span></p>
246       
247          <div class="comments"></div>
248
249         
250
251         
252            <h3>Parameters</h3>
253       
254           
255            <h4 id="_IMAGE_VIEWER_OPEN_FOLDER_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
256             
257             
258             
259             
260             
261             
262             
263             
264            </h4>
265       
266          <div class="comments"></div>
267           
268
269         
270
271         
272
273         
274         
275         
276         
277         
278         
279         
280         
281         
282         
283         
284         
285       
286         
287         
288         
289         
290         
291         
292         
293       
294         
295       
296        </div>
297       
298
299        <div class="routine_details" id="_IMAGE_VIEWER_CANCEL">
300
301          <h2><a class="top" href="#container">top</a>IMAGE_VIEWER_CANCEL </h2>
302       
303          <p class="header">
304            IMAGE_VIEWER_CANCEL<span class="result">, <a href="#_IMAGE_VIEWER_CANCEL_param_event">event</a></span></p>
305       
306          <div class="comments"></div>
307
308         
309
310         
311            <h3>Parameters</h3>
312       
313           
314            <h4 id="_IMAGE_VIEWER_CANCEL_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
315             
316             
317             
318             
319             
320             
321             
322             
323            </h4>
324       
325          <div class="comments"></div>
326           
327
328         
329
330         
331
332         
333         
334         
335         
336         
337         
338         
339         
340         
341         
342         
343         
344       
345         
346         
347         
348         
349         
350         
351         
352       
353         
354       
355        </div>
356       
357
358        <div class="routine_details" id="_IMAGE_VIEWER_TIMER">
359
360          <h2><a class="top" href="#container">top</a>IMAGE_VIEWER_TIMER </h2>
361       
362          <p class="header">
363            IMAGE_VIEWER_TIMER<span class="result">, <a href="#_IMAGE_VIEWER_TIMER_param_event">event</a></span></p>
364       
365          <div class="comments"></div>
366
367         
368
369         
370            <h3>Parameters</h3>
371       
372           
373            <h4 id="_IMAGE_VIEWER_TIMER_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
374             
375             
376             
377             
378             
379             
380             
381             
382            </h4>
383       
384          <div class="comments"></div>
385           
386
387         
388
389         
390
391         
392         
393         
394         
395         
396         
397         
398         
399         
400         
401         
402         
403       
404         
405         
406         
407         
408         
409         
410         
411       
412         
413       
414        </div>
415       
416
417        <div class="routine_details" id="_IMAGE_VIEWER_EXIT">
418
419          <h2><a class="top" href="#container">top</a>IMAGE_VIEWER_EXIT </h2>
420       
421          <p class="header">
422            IMAGE_VIEWER_EXIT<span class="result">, <a href="#_IMAGE_VIEWER_EXIT_param_event">event</a></span></p>
423       
424          <div class="comments"></div>
425
426         
427
428         
429            <h3>Parameters</h3>
430       
431           
432            <h4 id="_IMAGE_VIEWER_EXIT_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
433             
434             
435             
436             
437             
438             
439             
440             
441            </h4>
442       
443          <div class="comments"></div>
444           
445
446         
447
448         
449
450         
451         
452         
453         
454         
455         
456         
457         
458         
459         
460         
461         
462       
463         
464         
465         
466         
467         
468         
469         
470       
471         
472       
473        </div>
474       
475
476        <div class="routine_details" id="_IMAGE_VIEWER_HELP">
477
478          <h2><a class="top" href="#container">top</a>IMAGE_VIEWER_HELP </h2>
479       
480          <p class="header">
481            IMAGE_VIEWER_HELP<span class="result">, <a href="#_IMAGE_VIEWER_HELP_param_event">event</a></span></p>
482       
483          <div class="comments"></div>
484
485         
486
487         
488            <h3>Parameters</h3>
489       
490           
491            <h4 id="_IMAGE_VIEWER_HELP_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
492             
493             
494             
495             
496             
497             
498             
499             
500            </h4>
501       
502          <div class="comments"></div>
503           
504
505         
506
507         
508
509         
510         
511         
512         
513         
514         
515         
516         
517         
518         
519         
520         
521       
522         
523         
524         
525         
526         
527         
528         
529       
530         
531       
532        </div>
533       
534
535        <div class="routine_details" id="_IMAGE_VIEWER_THUMBS">
536
537          <h2><a class="top" href="#container">top</a>IMAGE_VIEWER_THUMBS </h2>
538       
539          <p class="header">
540            IMAGE_VIEWER_THUMBS<span class="result">, <a href="#_IMAGE_VIEWER_THUMBS_param_event">event</a></span></p>
541       
542          <div class="comments"></div>
543
544         
545
546         
547            <h3>Parameters</h3>
548       
549           
550            <h4 id="_IMAGE_VIEWER_THUMBS_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
551             
552             
553             
554             
555             
556             
557             
558             
559            </h4>
560       
561          <div class="comments"></div>
562           
563
564         
565
566         
567
568         
569         
570         
571         
572         
573         
574         
575         
576         
577         
578         
579         
580       
581         
582         
583         
584         
585         
586         
587         
588       
589         
590       
591        </div>
592       
593
594        <div class="routine_details" id="_IMAGE_VIEWER_CLEANUP">
595
596          <h2><a class="top" href="#container">top</a>IMAGE_VIEWER_CLEANUP </h2>
597       
598          <p class="header">
599            IMAGE_VIEWER_CLEANUP<span class="result">, <a href="#_IMAGE_VIEWER_CLEANUP_param_widgetID">widgetID</a></span></p>
600       
601          <div class="comments"></div>
602
603         
604
605         
606            <h3>Parameters</h3>
607       
608           
609            <h4 id="_IMAGE_VIEWER_CLEANUP_param_widgetID">widgetID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
610             
611             
612             
613             
614             
615             
616             
617             
618            </h4>
619       
620          <div class="comments"></div>
621           
622
623         
624
625         
626
627         
628         
629         
630         
631         
632         
633         
634         
635         
636         
637         
638         
639       
640         
641         
642         
643         
644         
645         
646         
647       
648         
649       
650        </div>
651       
652
653        <div class="routine_details" id="_IMAGE_VIEWER_EVENT">
654
655          <h2><a class="top" href="#container">top</a>IMAGE_VIEWER_EVENT </h2>
656       
657          <p class="header">
658            IMAGE_VIEWER_EVENT<span class="result">, <a href="#_IMAGE_VIEWER_EVENT_param_event">event</a></span></p>
659       
660          <div class="comments"></div>
661
662         
663
664         
665            <h3>Parameters</h3>
666       
667           
668            <h4 id="_IMAGE_VIEWER_EVENT_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
669             
670             
671             
672             
673             
674             
675             
676             
677            </h4>
678       
679          <div class="comments"></div>
680           
681
682         
683
684         
685
686         
687         
688         
689         
690         
691         
692         
693         
694         
695         
696         
697         
698       
699         
700         
701         
702         
703         
704         
705         
706       
707         
708       
709        </div>
710       
711
712        <div class="routine_details" id="_IMAGE_VIEWER">
713
714          <h2><a class="top" href="#container">top</a>IMAGE_VIEWER </h2>
715       
716          <p class="header">
717            IMAGE_VIEWER</p>
718       
719          <div class="comments"></div>
720
721         
722
723         
724
725         
726
727         
728         
729         
730         
731         
732         
733         
734         
735         
736         
737         
738         
739       
740         
741         
742         
743         
744         
745         
746         
747       
748         
749       
750        </div>
751       
752      </div>
753
754     
755
756      <div id="tagline">Produced by IDLdoc 2.0.</div>
757
758    </div>
759
760  </body>
761</html>
Note: See TracBrowser for help on using the repository browser.