source: trunk/SRC/Documentation/idldoc_assistant_output/Utilities/text_box.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 5.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>text_box.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="testvar.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="undefine.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Utilities/</font></h1>
58    <h2>text_box.pro</h2>
59
60    <dl>
61    </dl>
62
63     
64 This procedure writes a short text message within a box-shaped
65 area in a graphics window.  The message may be split at word
66 boundaries into several lines, and the character size and
67 orientation may be adjusted for the text to fit within the box.
68   
69
70   
71
72     
73      <a name="#_text_box"></a>
74
75      <h2>text_box  </h2>
76
77      <p><font face="Courier">text_box<i>, <a href="#_text_box_keyword_text">text</a></i>, <a href="#_text_box_keyword_pos">pos</a>=<i>pos</i>, <a href="#_text_box_keyword_fg_color">fg_color</a>=<i>fg_color</i>, <a href="#_text_box_keyword_bg_color">bg_color</a>=<i>bg_color</i>, <a href="#_text_box_keyword_center">center</a>=<i>center</i>, <a href="#_text_box_keyword_right">right</a>=<i>right</i>, <a href="#_text_box_keyword_box">box</a>=<i>box</i>, <a href="#_text_box_keyword_vert_space">vert_space</a>=<i>vert_space</i>, <a href="#_text_box_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
78
79   
80
81
82   
83
84   
85    <h3>Parameters</h3>
86   
87
88    <a name="#_text_box_keyword_text"></a>
89    <h4>text&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
90      <font size="-1" color="#006633">in</font>
91     
92     
93      <font size="-1" color="#006633">required</font>
94     
95     
96     
97     
98    </h4>
99
100     
101 ASCII text string containing the message.
102
103   
104   
105
106   
107    <h3>Keywords</h3>
108
109   
110    <a name="#_text_box_keyword_pos"></a>
111    <h4>pos&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
112     
113     
114     
115     
116     
117     
118     
119     
120    </h4>
121
122     
123 4 element vector specifying the box position and size
124 pos[0],pos[1] specify the lower left corner coordinate
125 pos[2],pos[3] specify the upper right corner coordinate
126 data window normalized coordinates are use
127
128   
129    <a name="#_text_box_keyword_fg_color"></a>
130    <h4>fg_color&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131     
132     
133     
134     
135     
136     
137      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
138     
139    </h4>
140
141   
142 color of box and legend titles
143
144   
145    <a name="#_text_box_keyword_bg_color"></a>
146    <h4>bg_color&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147     
148     
149     
150     
151     
152     
153     
154     
155    </h4>
156
157     
158 background color. Setting BG_COLOR erases the area
159               covered by the text box (filling it with color BG_COLOR)
160               prior to writing the text.  If both BG_COLOR and !p.color
161               are zero then the background color is reset to 255 to
162               gaurantee a readability.
163               
164   
165    <a name="#_text_box_keyword_center"></a>
166    <h4>center&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
167     
168     
169     
170     
171     
172     
173     
174     
175    </h4>
176
177     
178 if set, center the text
179
180   
181    <a name="#_text_box_keyword_right"></a>
182    <h4>right&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183     
184     
185     
186     
187     
188     
189     
190     
191    </h4>
192
193     
194 if set, right justify text
195
196   
197    <a name="#_text_box_keyword_box"></a>
198    <h4>box&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199     
200     
201     
202     
203     
204     
205     
206     
207    </h4>
208
209     
210 activate to show the box on graphics window.
211
212   
213    <a name="#_text_box_keyword_vert_space"></a>
214    <h4>vert_space&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
215     
216     
217     
218     
219     
220     
221      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1.5</i></font>
222     
223    </h4>
224
225   
226 vertical spacing of lines in units of character height
227
228   
229    <a name="#_text_box_keyword__EXTRA"></a>
230    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
231     
232     
233     
234     
235     
236     
237     
238     
239    </h4>
240
241     
242 used to pass your keyword
243
244   
245   
246
247   
248    <h3>Version history</h3>
249   
250    <h4>Version</h4> $Id: text_box.pro 136 2006-07-10 15:20:19Z pinsard $
251
252    <h4>History</h4>  Paul Ricchiazzi                            7Jul93
253           Institute for Computational Earth System Science
254           University of California, Santa Barbara
255
256   
257
258   
259   
260   
261   
262   
263
264   
265   
266   
267   
268   
269   
270   
271
272    <font size="-3"><p>&nbsp;</p></font>
273    <hr size="1" color="#CCCCCC"/>
274     
275
276   
277
278    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:50:58 2006.</font></p>
279
280  </body>
281</html>
Note: See TracBrowser for help on using the repository browser.