| 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 (SAXO 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 (SAXO Documentation)"; |
|---|
| 19 | } |
|---|
| 20 | </script> |
|---|
| 21 | </head> |
|---|
| 22 | |
|---|
| 23 | <body onload="setTitle();"> |
|---|
| 24 | |
|---|
| 25 | <div id="navbar_title"> |
|---|
| 26 | <h1>SAXO 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" title="Overview of library">Overview</a></td> |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | |
|---|
| 39 | <td >Directory</td> |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td> |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | |
|---|
| 47 | <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td> |
|---|
| 48 | |
|---|
| 49 | |
|---|
| 50 | |
|---|
| 51 | <td><a href="./../search-page.html" title="Search library">Search</a></td> |
|---|
| 52 | |
|---|
| 53 | |
|---|
| 54 | <td id="selected">File</td> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <td><a href="../../../Utilities//text_box.pro" title="Source code of a file">Source</a></td> |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | |
|---|
| 61 | <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td> |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | <td >Etc</td> |
|---|
| 65 | |
|---|
| 66 | <td id="flexible">Developer documentation</td> |
|---|
| 67 | </tr> |
|---|
| 68 | </table> |
|---|
| 69 | |
|---|
| 70 | </div> |
|---|
| 71 | |
|---|
| 72 | <div id="secondary_navbar"> |
|---|
| 73 | |
|---|
| 74 | <a href="testvar.html"><<prev file</a> | <a href="undefine.html">next file >></a> <a href="text_box.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a> summary: fields | routine 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">Utilities/</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"> |
|---|
| 90 | This procedure writes a short text message within a box-shaped |
|---|
| 91 | area in a graphic window. The message may be split at word |
|---|
| 92 | boundaries into several lines, and the character size and |
|---|
| 93 | orientation may be adjusted for the text to fit within the box. |
|---|
| 94 | </div> |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | <div id="routine_details"> |
|---|
| 105 | |
|---|
| 106 | |
|---|
| 107 | <div class="routine_details" id="_text_box"> |
|---|
| 108 | |
|---|
| 109 | <h2><a class="top" href="#container">top</a>text_box </h2> |
|---|
| 110 | |
|---|
| 111 | <p class="header"> |
|---|
| 112 | 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> |
|---|
| 113 | |
|---|
| 114 | <div class="comments"> |
|---|
| 115 | </div> |
|---|
| 116 | |
|---|
| 117 | |
|---|
| 118 | |
|---|
| 119 | |
|---|
| 120 | <h3>Parameters</h3> |
|---|
| 121 | |
|---|
| 122 | |
|---|
| 123 | <h4 id="_text_box_param_text">text |
|---|
| 124 | <span class="attr">in</span> |
|---|
| 125 | |
|---|
| 126 | |
|---|
| 127 | <span class="attr">required</span> |
|---|
| 128 | |
|---|
| 129 | <span class="attr">type:</span> <span class="value">string</span> |
|---|
| 130 | |
|---|
| 131 | |
|---|
| 132 | </h4> |
|---|
| 133 | |
|---|
| 134 | <div class="comments"> |
|---|
| 135 | message in ASCII. |
|---|
| 136 | </div> |
|---|
| 137 | |
|---|
| 138 | |
|---|
| 139 | |
|---|
| 140 | |
|---|
| 141 | |
|---|
| 142 | |
|---|
| 143 | <h3>Keywords</h3> |
|---|
| 144 | |
|---|
| 145 | <h4 id="_text_box_keyword_POS">POS |
|---|
| 146 | |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | |
|---|
| 152 | |
|---|
| 153 | |
|---|
| 154 | </h4> |
|---|
| 155 | |
|---|
| 156 | <div class="comments"> |
|---|
| 157 | 4 elements vector specifying the box position and size |
|---|
| 158 | pos[0],pos[1] specify the lower left corner coordinate, |
|---|
| 159 | pos[2],pos[3] specify the upper right corner coordinate, |
|---|
| 160 | data window normalized coordinates are used. |
|---|
| 161 | </div> |
|---|
| 162 | |
|---|
| 163 | <h4 id="_text_box_keyword_FG_COLOR">FG_COLOR |
|---|
| 164 | |
|---|
| 165 | |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | |
|---|
| 169 | |
|---|
| 170 | <span class="attr">default:</span> <span class="value">0</span> |
|---|
| 171 | |
|---|
| 172 | </h4> |
|---|
| 173 | |
|---|
| 174 | <div class="comments"> |
|---|
| 175 | color of box and legend titles |
|---|
| 176 | </div> |
|---|
| 177 | |
|---|
| 178 | <h4 id="_text_box_keyword_BG_COLOR">BG_COLOR |
|---|
| 179 | |
|---|
| 180 | |
|---|
| 181 | |
|---|
| 182 | |
|---|
| 183 | |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | </h4> |
|---|
| 188 | |
|---|
| 189 | <div class="comments"> |
|---|
| 190 | background color. |
|---|
| 191 | Setting BG_COLOR erases the area |
|---|
| 192 | covered by the text box (filling it with color BG_COLOR) |
|---|
| 193 | prior to writing the text. If both BG_COLOR and !p.color |
|---|
| 194 | are zero then the background color is reset to 255 to |
|---|
| 195 | guarantee a readability. |
|---|
| 196 | </div> |
|---|
| 197 | |
|---|
| 198 | <h4 id="_text_box_keyword_CENTER">CENTER |
|---|
| 199 | |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | </h4> |
|---|
| 208 | |
|---|
| 209 | <div class="comments"> |
|---|
| 210 | if set, center the text |
|---|
| 211 | </div> |
|---|
| 212 | |
|---|
| 213 | <h4 id="_text_box_keyword_RIGHT">RIGHT |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | </h4> |
|---|
| 223 | |
|---|
| 224 | <div class="comments"> |
|---|
| 225 | if set, right justify text |
|---|
| 226 | </div> |
|---|
| 227 | |
|---|
| 228 | <h4 id="_text_box_keyword_BOX">BOX |
|---|
| 229 | |
|---|
| 230 | |
|---|
| 231 | |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | </h4> |
|---|
| 238 | |
|---|
| 239 | <div class="comments"> |
|---|
| 240 | activate to show the box on graphic window. |
|---|
| 241 | </div> |
|---|
| 242 | |
|---|
| 243 | <h4 id="_text_box_keyword_VERT_SPACE">VERT_SPACE |
|---|
| 244 | |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | |
|---|
| 250 | <span class="attr">default:</span> <span class="value">1.5</span> |
|---|
| 251 | |
|---|
| 252 | </h4> |
|---|
| 253 | |
|---|
| 254 | <div class="comments"> |
|---|
| 255 | vertical spacing of lines in units of character height |
|---|
| 256 | </div> |
|---|
| 257 | |
|---|
| 258 | <h4 id="_text_box_keyword__EXTRA">_EXTRA |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | |
|---|
| 265 | |
|---|
| 266 | |
|---|
| 267 | </h4> |
|---|
| 268 | |
|---|
| 269 | <div class="comments"> |
|---|
| 270 | Used to pass keywords |
|---|
| 271 | </div> |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | |
|---|
| 275 | |
|---|
| 276 | <h3>Version history</h3> |
|---|
| 277 | |
|---|
| 278 | <h4>Version</h4><div class="preformat"> |
|---|
| 279 | $Id: text_box.pro 375 2008-08-08 15:55:40Z pinsard $ |
|---|
| 280 | </div> |
|---|
| 281 | <h4>History</h4><div class="preformat"> |
|---|
| 282 | Paul Ricchiazzi 7Jul93 |
|---|
| 283 | Institute for Computational Earth System Science |
|---|
| 284 | University of California, Santa Barbara |
|---|
| 285 | </div> |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | |
|---|
| 302 | <h3>Statistics</h3> |
|---|
| 303 | <table class="statistics"> |
|---|
| 304 | <tr><td>McCabe cyclic</td><td> 22</td></tr> |
|---|
| 305 | <tr><td>McCabe essential</td><td> 1</td></tr> |
|---|
| 306 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
|---|
| 307 | </table> |
|---|
| 308 | |
|---|
| 309 | |
|---|
| 310 | </div> |
|---|
| 311 | |
|---|
| 312 | </div> |
|---|
| 313 | |
|---|
| 314 | |
|---|
| 315 | |
|---|
| 316 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 317 | |
|---|
| 318 | </div> |
|---|
| 319 | |
|---|
| 320 | </body> |
|---|
| 321 | </html> |
|---|
