source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/UTILITAIRE/text_box.html @ 97

Last change on this file since 97 was 97, checked in by pinsard, 18 years ago

start to modify headers of Obsolete *.pro files for better idldoc output
File size: 6.9 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>text_box.pro (IDLdoc API documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="text_box.pro (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="testvar.html">&lt;&lt;prev file</a> | <a href="undefine.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="text_box.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/UTILITAIRE/</a></h1>
82      <h2 class="pro_file">text_box.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_text_box">
103
104          <h2><a class="top" href="#container">top</a>text_box </h2>
105       
106          <p class="header">
107            text_box<span class="result">, <a href="#_text_box_param_text">text</a></span>, <a href="#_text_box_keyword_pos">pos</a>=<span class="result">pos</span>, <a href="#_text_box_keyword_fg_color">fg_color</a>=<span class="result">fg_color</span>, <a href="#_text_box_keyword_bg_color">bg_color</a>=<span class="result">bg_color</span>, <a href="#_text_box_keyword_center">center</a>=<span class="result">center</span>, <a href="#_text_box_keyword_right">right</a>=<span class="result">right</span>, <a href="#_text_box_keyword_box">box</a>=<span class="result">box</span>, <a href="#_text_box_keyword_vert_space">vert_space</a>=<span class="result">vert_space</span>, <a href="#_text_box_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
108       
109          <div class="comments">
110 Name        : text_box
111
112 Purpose     : Writes a text message within a box in a graphics window.
113
114 Description:  This procedure writes a short text message within a box-shaped
115               area in a graphics window.  The message may be split at word
116               boundaries into several lines, and the character size and
117               orientation may be adjusted for the text to fit within the box.
118
119 Useage:       text_box,text,pos=pos,color=color,$
120                    justify=justify,vert_space=vert_space
121
122 Inputs     
123 TEXT          ASCII text string containing the message.
124
125 keywords
126  pos          4 element vector specifying the box position and size
127               pos(0),pos(1) specify the lower left corner coordinate
128               pos(2),pos(3) specify the upper right corner coordinate
129               data window normalized coordinates are use
130
131   fg_color    color of box and legend titles (default=0)
132
133   bg_color    background color. Setting BG_COLOR erases the area
134               covered by the text box (filling it with color BG_COLOR)
135               prior to writing the text.  If both BG_COLOR and !p.color
136               are zero then the background color is reset to 255 to
137               gaurantee a readability.
138               
139  right        if set, right justify text
140  center       if set, center the text
141
142  vert_space   vertical spacing of lines in units of character height
143               (default = 1.5)
144
145
146  author:  Paul Ricchiazzi                            7Jul93
147           Institute for Computational Earth System Science
148           University of California, Santa Barbara</div>
149
150         
151
152         
153            <h3>Parameters</h3>
154       
155           
156            <h4 id="_text_box_param_text">text&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
157             
158             
159             
160             
161             
162             
163             
164             
165            </h4>
166       
167          <div class="comments"></div>
168           
169
170         
171
172         
173
174            <h3>Keywords</h3>
175           
176            <h4 id="_text_box_keyword_pos">pos&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177             
178             
179             
180             
181             
182             
183             
184             
185            </h4>
186       
187            <div class="comments"></div>
188           
189            <h4 id="_text_box_keyword_fg_color">fg_color&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
190             
191             
192             
193             
194             
195             
196             
197             
198            </h4>
199       
200            <div class="comments"></div>
201           
202            <h4 id="_text_box_keyword_bg_color">bg_color&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
203             
204             
205             
206             
207             
208             
209             
210             
211            </h4>
212       
213            <div class="comments"></div>
214           
215            <h4 id="_text_box_keyword_center">center&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
216             
217             
218             
219             
220             
221             
222             
223             
224            </h4>
225       
226            <div class="comments"></div>
227           
228            <h4 id="_text_box_keyword_right">right&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
229             
230             
231             
232             
233             
234             
235             
236             
237            </h4>
238       
239            <div class="comments"></div>
240           
241            <h4 id="_text_box_keyword_box">box&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
242             
243             
244             
245             
246             
247             
248             
249             
250            </h4>
251       
252            <div class="comments"></div>
253           
254            <h4 id="_text_box_keyword_vert_space">vert_space&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
255             
256             
257             
258             
259             
260             
261             
262             
263            </h4>
264       
265            <div class="comments"></div>
266           
267            <h4 id="_text_box_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
268             
269             
270             
271             
272             
273             
274             
275             
276            </h4>
277       
278            <div class="comments"></div>
279           
280         
281
282         
283         
284         
285         
286         
287         
288         
289         
290         
291         
292         
293         
294       
295         
296         
297         
298         
299         
300         
301         
302       
303         
304       
305        </div>
306       
307      </div>
308
309     
310
311      <div id="tagline">Produced by IDLdoc 2.0.</div>
312
313    </div>
314
315  </body>
316</html>
Note: See TracBrowser for help on using the repository browser.