| 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 graphic 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 |
|---|
| 90 | <font size="-1" color="#006633">in</font> |
|---|
| 91 | |
|---|
| 92 | |
|---|
| 93 | <font size="-1" color="#006633">required</font> |
|---|
| 94 | |
|---|
| 95 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | </h4> |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | message in ASCII. |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | |
|---|
| 105 | |
|---|
| 106 | |
|---|
| 107 | <h3>Keywords</h3> |
|---|
| 108 | |
|---|
| 109 | |
|---|
| 110 | <a name="#_text_box_keyword_POS"></a> |
|---|
| 111 | <h4>POS |
|---|
| 112 | |
|---|
| 113 | |
|---|
| 114 | |
|---|
| 115 | |
|---|
| 116 | |
|---|
| 117 | |
|---|
| 118 | |
|---|
| 119 | |
|---|
| 120 | </h4> |
|---|
| 121 | |
|---|
| 122 | |
|---|
| 123 | 4 elements 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 used. |
|---|
| 127 | |
|---|
| 128 | |
|---|
| 129 | <a name="#_text_box_keyword_FG_COLOR"></a> |
|---|
| 130 | <h4>FG_COLOR |
|---|
| 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 |
|---|
| 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 | guarantee a readability. |
|---|
| 163 | |
|---|
| 164 | |
|---|
| 165 | <a name="#_text_box_keyword_CENTER"></a> |
|---|
| 166 | <h4>CENTER |
|---|
| 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 |
|---|
| 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 |
|---|
| 199 | |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | </h4> |
|---|
| 208 | |
|---|
| 209 | |
|---|
| 210 | activate to show the box on graphic window. |
|---|
| 211 | |
|---|
| 212 | |
|---|
| 213 | <a name="#_text_box_keyword_VERT_SPACE"></a> |
|---|
| 214 | <h4>VERT_SPACE |
|---|
| 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 |
|---|
| 231 | |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | </h4> |
|---|
| 240 | |
|---|
| 241 | |
|---|
| 242 | Used to pass keywords |
|---|
| 243 | |
|---|
| 244 | |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | </pre><h3>Version history</h3> |
|---|
| 249 | |
|---|
| 250 | <h4>Version</h4> |
|---|
| 251 | $Id: text_box.pro 327 2007-12-13 16:22:35Z pinsard $ |
|---|
| 252 | |
|---|
| 253 | <h4>History</h4> |
|---|
| 254 | Paul Ricchiazzi 7Jul93 |
|---|
| 255 | Institute for Computational Earth System Science |
|---|
| 256 | University of California, Santa Barbara |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | |
|---|
| 265 | |
|---|
| 266 | |
|---|
| 267 | |
|---|
| 268 | |
|---|
| 269 | |
|---|
| 270 | |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | <font size="-3"><p> </p></font> |
|---|
| 275 | <hr size="1" color="#CCCCCC"/> |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
|---|
| 281 | |
|---|
| 282 | </body> |
|---|
| 283 | </html> |
|---|
