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

Timestamp:

03/15/07 11:22:28 (17 years ago)

Author:

pinsard

Message:

improvements/corrections of some *.pro headers

File:

• trunk/SRC/Utilities/text_box.pro (modified) (8 diffs)

trunk/SRC/Utilities/text_box.pro

@@ -1 +1 @@
 ;+
 ;
-; @file_comments 
+; @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} 
+;
+; @param TEXT {in}{required}
 ; ASCII text string containing the message.
 ;
-; @keyword POS  
+; @keyword POS
 ; 4 element vector specifying the box position and size
 ; pos[0],pos[1] specify the lower left corner coordinate
@@ -19 +19 @@
 ; color of box and legend titles
 ;
-; @keyword 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
 ;               are zero then the background color is reset to 255 to
 ;               gaurantee a readability.
-;               
-; @keyword RIGHT 
+;
+; @keyword RIGHT
 ; if set, right justify text
 ;
-; @keyword CENTER 
+; @keyword CENTER
 ; if set, center the text
 ;
@@ -35 +35 @@
 ; vertical spacing of lines in units of character height
 ;
-; @keyword _EXTRA 
+; @keyword _EXTRA
 ; used to pass your keyword
 ;
-; @keyword BOX 
+; @keyword BOX
 ; activate to show the box on graphics window.
 ;
-; @history  Paul Ricchiazzi                            7Jul93
+; @history
+; Paul Ricchiazzi                            7Jul93
 ;           Institute for Computational Earth System Science
 ;           University of California, Santa Barbara
 ;
-; @version $Id$
+; @version
+; $Id$
 ;
 ;-
@@ -80 +82 @@
   print,strcompress(posstring,/remove_all)
 
-   
+
 endif else begin
-  
+
   xx1 = nnx[0]+pos[0]*(nnx[1]-nnx[0])
   xx2 = nnx[0]+pos[2]*(nnx[1]-nnx[0])
@@ -103 +105 @@
   blanklen=lenstr(' ')*!d.x_vsize
   maxcharsize=(xx2-xx1)/(4*blanklen+max(wordlen))
-  charsize=1  
+  charsize=1
   lpnt=intarr(nwords)
   nomore=0
@@ -123 +125 @@
         sum=wlen[i]+blen
       endif
-      lpnt[i]=ilines        
-      
+      lpnt[i]=ilines
+
 ;      print,f='(f8.2,4i8,3f8.2)',charsize,i,ilines,n_lines,lpnt[i],$
 ;                 wlen[i]+blen,sum+3*blen,xx2-xx1
-    endfor        
+    endfor
     case 1 of
       ilines+1 lt n_lines: if charsize*1.1 gt maxcharsize then $
@@ -135 +137 @@
       ilines+1 gt n_lines: charsize=charsize*.9
     endcase
-endrep until nomore 
+endrep until nomore
 
 lines=strarr(n_lines)
@@ -150 +152 @@
 ;
   align=.5*(1+justify)
-  
+
   case justify of
     -1:xx = xx1+.5*((xx2-xx1)-maxlen)