Changeset 133 for trunk/SRC/Utilities/text_box.pro

Timestamp:

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

Author:

navarro

Message:

english and nicer header (1)

File:

• trunk/SRC/Utilities/text_box.pro (moved) (moved from trunk/SRC/ToBeReviewed/UTILITAIRE/text_box.pro) (2 diffs)

trunk/SRC/Utilities/text_box.pro

@@ -1 +1 @@
 ;+
-; Name        : text_box
 ;
-; Purpose     : Writes a text message within a box in a graphics window.
+; @file_comments 
+; This procedure writes a short text message within a box-shaped
+; area in a graphics window.  The message may be split at word
+; boundaries into several lines, and the character size and
+ ;orientation may be adjusted for the text to fit within the box.
+;   
+; @param TEXT {in}{required} ASCII text string containing the message.
 ;
-; Description:  This procedure writes a short text message within a box-shaped
-;               area in a graphics window.  The message may be split at word
-;               boundaries into several lines, and the character size and
-;               orientation may be adjusted for the text to fit within the box.
-;
-; Useage:       text_box,text,pos=pos,color=color,$
-;                    justify=justify,vert_space=vert_space
-;
-; Inputs      
-; TEXT          ASCII text string containing the message.
-;
-; keywords
-;  pos          4 element vector specifying the box position and size
+; @keyword pos  4 element vector specifying the box position and size
 ;               pos[0],pos[1] specify the lower left corner coordinate
 ;               pos[2],pos[3] specify the upper right corner coordinate
 ;               data window normalized coordinates are use
 ;
-;   fg_color    color of box and legend titles (default=0)
+; @keyword fg_color color of box and legend titles (default=0)
 ;
-;   bg_color    background color. Setting BG_COLOR erases the area 
+; @keyword bg_color background color. Setting BG_COLOR erases the area 
 ;               covered by the text box (filling it with color BG_COLOR)
 ;               prior to writing the text.  If both BG_COLOR and !p.color
@@ -29 +22 @@
 ;               gaurantee a readability.
 ;               
-;  right        if set, right justify text
-;  center       if set, center the text
+; @keyword right if set, right justify text
 ;
-;  vert_space   vertical spacing of lines in units of character height 
-;               (default = 1.5)
+; @keyword center if set, center the text
 ;
+; @keyword vert_space {default=1.5}vertical spacing of lines in units of character height
 ;
-;  author:  Paul Ricchiazzi                            7Jul93
+; @keyword _EXTRA used to pass your keyword
+;
+; @keyword box activate to show the box on graphics window.
+;
+; @history  Paul Ricchiazzi                            7Jul93
 ;           Institute for Computational Earth System Science
 ;           University of California, Santa Barbara
+;
+; @version $Id$
+;
 ;-
 PRO text_box,text,pos=pos,fg_color=fg_color,bg_color=bg_color,$