Changeset 133 for trunk/SRC/Colors/xpal.pro

Timestamp:

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

Author:

navarro

Message:

english and nicer header (1)

Location:

trunk/SRC/Colors

Files:

• . (added)
• xpal.pro (moved) (moved from trunk/SRC/ToBeReviewed/COULEURS/xpal.pro) (13 diffs)

trunk/SRC/Colors/xpal.pro

@@ -1 @@
-; $Id$
-;
-; Copyright (c) 1992-1998, Research Systems, Inc.  All rights reserved.
-;       Unauthorized reproduction prohibited.
 ;+
-; NAME:
-;       XPAL
-;
-; PURPOSE:
-;       comme xpalette mais plus court a ecrire et possede en plus
-;       une touche save qui (grace a la routine newpalette) permet de
-;       sauver la routine que l''on vient de faire. Rq qd on appuie
-;       sur la touche predefined appelle xlct plutot que xloadct 
-;
-; CATEGORY:
-;       Color tables, widgets.
-;
-; CALLING SEQUENCE:
-;       XPAL
-;
-; INPUTS:
-;       No explicit inputs.  The current color table is used as a starting
-;       point.
-;
-; KEYWORD PARAMETERS:
-;       BLOCK:  Set this keyword to have XMANAGER block when this
+;
+; @file_comments 
+; like xpalette but shorter to write and ,moreover,
+; possess a hotkey save which (thanks to the newpalette routine)
+; allows to save the routine that we have just done. Comment: when we
+; press the predefined hotkey, it calls xlct instead of xloadct 
+; No explicit inputs.  The current color table is used as a starting point.
+;
+; @categories Color tables, widgets.
+;
+; @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
@@ -32 +18 @@
 ;               application.  For more information see the NO_BLOCK keyword
 ;               to XMANAGER.
-;       UPDATECALLBACK: Set this keyword to a string containing the name of
+; @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 XLOADCT.  The procedure may optionally
@@ -38 +24 @@
 ;               set to the value specified by the optional UPDATECBDATA
 ;               keyword.
-;       UPDATECBDATA: Set this keyword to a value of any type. It will be
+; @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
@@ -45 +31 @@
 ;               will be undefined.
 ;
-; OUTPUTS:
-;       None.
-;
-; COMMON BLOCKS:
-;       COLORS: Contains the current RGB color tables.
-;       XP_COM: Private to this module.
-;
-; SIDE EFFECTS:
-;       XPAL uses two colors from the current color table as
+; @uses COLORS: Contains the current RGB color tables.
+; @uses XP_COM: Private to this module.
+;
+; @restrictions XPAL uses two colors from the current color table as
 ;       drawing foreground and background colors. These are used
 ;       for the RGB plots on the left, and the current index marker on
@@ -72 +53 @@
 ;       to the display.
 ;
-; PROCEDURE:
-;       The XPAL widget has the following controls:
+; @examples The XPAL widget has the following controls:
 ;
 ;       Left:   Three plots showing the current Red, Green, and Blue vectors.
@@ -95 +75 @@
 ;               pressed:
 ;
-;               Done:   Exits XPAL.
-;
-;         Predefined:   Starts XLOADCT to allow selection of one of the
+;                 Done: Exits XPAL.
+;
+;           Predefined: Starts XLOADCT to allow selection of one of the
 ;                       predefined color tables.
 ;
-;               Help:   Supplies help information similar to this header.
+;                 Help: Supplies help information similar to this header.
 ;
 ;               Redraw: Completely redraws the display using the current
@@ -117 +97 @@
 ;                       index and the mark index are interpolated linearly
 ;                       to lie between the colors of two endpoints.
-;                 save: permet de sauver la palette qui est
-;                       actuellement a l''ecran. Qd on appuie sur ce
-;                       bouton, un widget apparait qui demande:
-;                        1) le nom a donner a la palette que l''on veut sauver
-;                        2) le numero de la palette que l''on veut
-;                        eventuellement ecrase par la nouvelle
-;                        palette.Si aucun numero n''est specifie la
-;                        nouvelle palette estajoutee aux anciennes.
-;                        3) le nom du fichier qui contient les
-;                        palettes. Rq: suivre eventuellement les
-;                        indications fournis au prompteur.
+;                 save: Allows to save  the palette which is currently
+;                       on the screen. When we press this hotkey, there is a
+;                       widget who appear and ask:
+;                        1) the name of the palette we want to save.
+;                        2) The number of the palette we may want to erase
+;                        by the new palette. If there is not any number
+;                        specified, the new palette is add to elders.
+;                        3) The name of the file containing palettes.
+;                        Comment: May follow instructions gave by the prompter.
 ;                
 ;
@@ -147 +125 @@
 ;                          horizontally.
 ;
-; MODIFICATION HISTORY:
-;          addaptation de xpalette pour ajouter un bouton save par
+; @history addaptation de xpalette pour ajouter un bouton save par
 ;          Gima Nicolas (nglod@ipsl.jussieu.fr) et par Masson
 ;          Sebastien (smlod@ipsl.jussieu.fr)
+;
+; $Id$
+;
 ;-
-
+;
+;+
+; @file_comments XP_NEW_COLORS: Choose the best foreground and background colors for the current
+;                color maps and set !P appropriately. Returns 1 if the colors changed,
+;                0 otherwise.
+;
+; @returns 1 or 0
+;- 
 function XP_NEW_COLORS
-; Choose the best foreground and background colors for the current
-; color maps and set !P appropriately. Returns 1 if the colors changed,
-; 0 otherwise.
 ;
   compile_opt idl2, strictarrsubs
@@ -202 +186 @@
   endif
 end
-
+;+
+; @file_comments XP_XLCTCALLBACK:  For visuals with static colormaps, update the graphics
+;                after a change by XLOADCT.
+;-
 pro XP_XLCTCALLBACK
-  ; For visuals with static colormaps, update the graphics
-  ; after a change by XLOADCT.
 ;
   compile_opt idl2, strictarrsubs
@@ -230 +215 @@
 end
 
-
-
-pro XP_REPLOT, color_index, type
-; Re-draw the RGB plots. Type has the following possible values.
-;;      - 'D': Draw the data part of all three plots
+;+
+; @file_comments XP_REPLOT: Re-draw the RGB plots. Type has the following possible values.
+;       - 'D': Draw the data part of all three plots
 ;       - 'F': draw all three plots
 ;       - 'R': Draw the data part of the Red plot
 ;       - 'G': Draw the data part of the Green plot
 ;       - 'B': Draw the data part of the Blue plot
+;- 
+pro XP_REPLOT, color_index, type
 ;
   compile_opt idl2, strictarrsubs
@@ -312 +297 @@
 
 
-
-pro XP_CHANGE_COLOR, type, value
-; Change current color. Type has the following possible values.
+;+
+; @file_comments XP_CHANGE_COLOR:  Change current color. Type has the following possible values.
 ;       - 'R': Change the R part of the current color
 ;       - 'G': ...
 ;       - 'B': ...
+;-
+pro XP_CHANGE_COLOR, type, value
 ;
   compile_opt idl2, strictarrsubs
@@ -553 +539 @@
 
 
-
+;+
+;
+; @keyword group 
+;
+; @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 XLOADCT.  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.
+;
+;-
 
 
@@ -597 +608 @@
   !p.color = nc -1              ;Foreground color
   !p.font = 0                   ;Hdw font
-  save_win = !d.window  ;Previous window
+  save_win = !d.window          ;Previous window
 
   IF N_ELEMENTS(r_orig) LE 0 THEN BEGIN ;If no common, use current colors