Changeset 133 for trunk/SRC/Picture/image_viewer.pro

Timestamp:

07/07/06 11:57:27 (18 years ago)

Author:

navarro

Message:

english and nicer header (1)

Location:

trunk/SRC/Picture

Files:

• . (added)
• image_viewer.pro (moved) (moved from trunk/SRC/ToBeReviewed/IMAGE/image_viewer.pro) (9 diffs)

trunk/SRC/Picture/image_viewer.pro

@@ -1 +1 @@
 ;+
-; 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.  Images are loaded into
-;       memory, so the initial file access may take a while, but once each picture has
-;       been opened they can all be viewed in a very rapid fashion.
-;
-; CATEGORY:
-;       Visualization, Widgets
-;
-; CALLING SEQUENCE:
-;       image_viewer
-;
-; INPUT PARAMETERS:
-;       None.
-;
-; KEYWORD PARAMETERS:
-;       None.
-;
-; OUTPUTS:
-;       None.
-;
-; COMMON BLOCKS:
-;       None.
-;
-; SIDE EFFECTS:
-;       While this program is running in an IDL session it will change the current
+;
+; @file_comments 
+; 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.  Images are loaded into
+; memory, so the initial file access may take a while, but once each picture has
+; been opened they can all be viewed in a very rapid fashion.
+;
+; @categories Visualization, Widgets
+;
+; @param event {in}{required}
+;
+; @restrictions While this program is running in an IDL session it will change the current
 ;       working directory, enables/disables color decomposition, and sets !QUIET=1,
 ;       !ORDER=0, & !P.BACKGROUND=0.  These settings are returned to their initial
 ;       settings before the program was initiated once it is terminated.
 ;
-; RESTRICTIONS:
-;       This program is supported in IDL version 5.5 and newer.  In order to open
+; @restrictions This program is supported in IDL version 5.5 and newer.  In order to open
 ;       GIF files or TIFF files with LZW compression the copy of IDL being used must
 ;       be licensed with these features.  IDL only supports BMP files in the standard
 ;       Windows format and does not support OS2 bitmaps.
 ;
-; MODIFICATION HISTORY:
-;       Written by: AEB, 1/02.
-;-
-
-
-;*********************************************************************************************
+; @history Written by: AEB, 1/02.
+;
+; @version $Id$
+;*********************************************************************************************
+;_
+
 PRO IMAGE_VIEWER_OPEN_FILES,event
 ;THIS PROCEDURE IS CALLED WHEN A USER SELECTS "File > Open Picture Files" FROM THE MAIN MENU
@@ -126 +108 @@
 
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_OPEN_FOLDER,event
 ;THIS PROCEDURE IS CALLED WHEN A USER SELECTS "File > Open All In Folder" FROM THE MAIN MENU
@@ -208 +193 @@
 
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_CANCEL,event
 ;obtain state structure for top-level-base from its UVALUE:
@@ -221 +209 @@
 
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_TIMER,event
 ;obtain state structure for top-level-base from its UVALUE:
@@ -893 +884 @@
 
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_EXIT,event
 ;THIS PROCEDURE IS CALLED WHEN A USER SELECTS "File > Exit" FROM THE MAIN MENU
@@ -905 +899 @@
 
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_HELP,event
 ;THIS PROCEDURE IS CALLED WHEN A USER SELECTS "Help > Help on IMAGE_VIEWER"
@@ -924 +921 @@
 
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_THUMBS,event
 ;THIS PROCEDURE IS CALLED WHEN A USER CLICKS ON ONE OF THE THUMBNAIL PICTURES
@@ -971 +971 @@
 
 ;*********************************************************************************************
+;+
+; @param widjetID {in}{required}
+;-
 PRO IMAGE_VIEWER_CLEANUP,widgetID
 ;THIS PROCEDURE IS CALLED WHEN THE PROGRAM IS TERMINATED AND XMANAGER REGISTERS A CLEANUP:
@@ -999 +1002 @@
 
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_EVENT,event
 ;THIS PROCEDURE IS CALLED WHEN A USER RESIZES THE TOP-LEVEL BASE