<<prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

Utilities/

text_box.pro

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.

toptext_box

text_box, text, pos=pos, fg_color=fg_color, bg_color=bg_color, center=center, right=right, box=box, vert_space=vert_space, _EXTRA=_EXTRA

Parameters

text        in required

ASCII text string containing the message.

Keywords

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        default: 0

color of box and legend titles

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.

center       

if set, center the text

right       

if set, right justify text

box       

activate to show the box on graphics window.

vert_space        default: 1.5

vertical spacing of lines in units of character height

_EXTRA       

used to pass your keyword

Version history

Version

$Id: text_box.pro 136 2006-07-10 15:20:19Z pinsard $

History

Paul Ricchiazzi 7Jul93 Institute for Computational Earth System Science University of California, Santa Barbara

Statistics

McCabe cyclic 22
McCabe essential 1
McCabe modular design 1
Produced by IDLdoc 2.0.