Changeset 137 for trunk/SRC/Colors/xlct.pro

Timestamp:

07/12/06 11:33:44 (18 years ago)

Author:

smasson

Message:

review of Colors and Calendar routines

File:

• trunk/SRC/Colors/xlct.pro (modified) (7 diffs)

trunk/SRC/Colors/xlct.pro

@@ -1 @@
-
+;+
+; @hidden
+;-
 PRO XLCT_PSAVE                  ;Save/Restore our plotting state.
 ;  Swaps our state with the current state each time its called.
@@ -23 +25 @@
 end
 
+;+
+; @hidden
+;-
 pro xlct_alert_caller
 ;
@@ -52 +57 @@
 
 ; Redraw the ramp image.
+;+
+; @hidden
+;-
 PRO xlct_show
 ;
@@ -72 +80 @@
 END
 
+;+
+; @hidden
+; @param i
+; ???
+; @param c
+; ???
+;-
 PRO xlct_draw_cps, i, c
 ;
@@ -93 +108 @@
 end
 
+;+
+; @hidden
+; @keyword UPDATE
+; ???
+;-
 PRO xlct_transfer, UPDATE=update
 ;
@@ -125 +145 @@
 end
 
+;+
+; @hidden
+; @param event
+; ???
+;-
 PRO xlct_event, event
 ;
@@ -375 +400 @@
 ; palette.tbl which can be in any directory
 ;
-; @categories Widgets
-;
-; @keyword FILE If this keyword is set, the file by the given name is used
-;               instead of the file colors1.tbl in the IDL directory.  This
-;               allows multiple IDL users to have their own color table file.
-; @keyword GROUP The widget ID of the widget that calls Xlct.  When 
-;               this ID is specified, a death of the caller results in a 
-;               death of Xlct
-; @keyword NCOLORS = number of colors to use.  Use color indexes from BOTTOM
-;               to the smaller of !D.TABLE_SIZE-1 and NCOLORS-1.
-;               Default = !D.TABLE_SIZE = all available colors.
-; @keyword BOTTOM = first color index to use. Use color indexes from BOTTOM to
-;               BOTTOM+NCOLORS-1.  Default = 0.
-; @keyword SILENT - Normally, no informational message is printed when
-;               a color map is loaded. If this keyword is present and
-;               zero, this message is printed.
-; @keyword USE_CURRENT: If set, use the current color tables, regardless of
-;               the contents of the COMMON block COLORS.
-; @keyword MODAL:  If set, then XLCT runs in "modal" mode, meaning that
-;               all other widgets are blocked until the user quits XLCT.
-;               A group leader must be specified (via the GROUP keyword)
-;               for the MODAL keyword to have any effect.   The default
-;               is to not run in modal mode.
-; @keyword BLOCK:  Set this keyword to have XMANAGER block when this
-;               application is registered.  By default the Xmanager
-;               keyword NO_BLOCK is set to 1 to provide access to the
-;               command line if active command  line processing is available.
-;               Note that setting BLOCK for this application will cause
-;               all widget applications to block, not only this
-;               application.  For more information see the NO_BLOCK keyword
-;               to XMANAGER.
-; @keyword UPDATECALLBACK: Set this keyword to a string containing the name of
-;               a user-supplied procedure that will be called when the color
-;               table is updated by XLCT.  The procedure may optionally
-;               accept a keyword called DATA, which will be automatically
-;               set to the value specified by the optional UPDATECBDATA
-;               keyword.
-; @keyword UPDATECBDATA: Set this keyword to a value of any type. It will be
-;               passed via the DATA keyword to the user-supplied procedure
-;               specified via the UPDATECALLBACK keyword, if any. If the
-;               UPDATECBDATA keyword is not set the value accepted by the
-;               DATA keyword to the procedure specified by UPDATECALLBACK
-;               will be undefined.
-;
-; @restrictions One of the predefined color maps may be loaded.
-;
-; @restrictions This routine uses the LOADCT user library procedure to
-;       do the actual work.
-;
-; @history 5/5/1999 copie de xloadct par Sebastien Masson (smlod@ipsl.jussieu.fr)
+; @categories Widgets, Color
+;
+; @keyword FILE {default='palette.tbl'}
+; If this keyword is set, the file by the given name is used
+; instead of the file colors1.tbl in the IDL directory.  This
+; allows multiple IDL users to have their own color table file.
+;
+; @keyword GROUP 
+; The widget ID of the widget that calls Xlct. When  this ID is
+; specified, a death of the caller results in a death of Xlct
+
+; @keyword NCOLORS {default=!D.TABLE_SIZE = all available colors}
+; number of colors to use. Use color indexes from BOTTOM to the
+; smaller of !D.TABLE_SIZE-1 and NCOLORS-1.
+;
+; @keyword BOTTOM {default=0.}
+; first color index to use. Use color indexes from BOTTOM to
+; BOTTOM+NCOLORS-1.
+;
+; @keyword SILENT 
+; Normally, no informational message is printed when a color map
+; is loaded. If this keyword is present and zero, this message is printed.
+;
+; @keyword USE_CURRENT
+; If set, use the current color tables, regardless of
+; the contents of the COMMON block COLORS.
+;
+; @keyword MODAL {default=not run in modal mode}
+; If set, then XLCT runs in "modal" mode, meaning that
+; all other widgets are blocked until the user quits XLCT.
+; A group leader must be specified (via the GROUP keyword)
+; for the MODAL keyword to have any effect.
+;
+; @keyword BLOCK
+; Set this keyword to have XMANAGER block when this
+; application is registered.  By default the Xmanager
+; keyword NO_BLOCK is set to 1 to provide access to the
+; command line if active command line processing is available.
+; Note that setting BLOCK for this application will cause
+; all widget applications to block, not only this
+; application.  For more information see the NO_BLOCK keyword
+; to XMANAGER.
+;
+; @keyword UPDATECALLBACK
+; Set this keyword to a string containing the name of
+; a user-supplied procedure that will be called when the color
+; table is updated by XLCT.  The procedure may optionally
+; accept a keyword called DATA, which will be automatically
+; set to the value specified by the optional UPDATECBDATA keyword.
+;
+; @keyword UPDATECBDATA
+; Set this keyword to a value of any type. It will be
+; passed via the DATA keyword to the user-supplied procedure
+; specified via the UPDATECALLBACK keyword, if any. If the
+; UPDATECBDATA keyword is not set the value accepted by the
+; DATA keyword to the procedure specified by UPDATECALLBACK
+; will be undefined.
+;
+; @history 5/5/1999 copie de xloadct par Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;
 ; @version $Id$