[69] | 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 on Sat Mar 11 21:40:00 2006 --> |
---|
| 6 | |
---|
| 7 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
| 8 | <head> |
---|
| 9 | <title>xidldoc.pro (IDLdoc project documentation)</title> |
---|
| 10 | |
---|
| 11 | |
---|
| 12 | <style type="text/css" media="all"> |
---|
| 13 | |
---|
| 14 | /* CSS for all files which appear in the "main" viewing area: overview, |
---|
| 15 | directory overviews, warnings, index, search, pro files, source |
---|
| 16 | code, help, and etc files. */ |
---|
| 17 | |
---|
| 18 | /* Link styles --------------------------------------------------------------- */ |
---|
| 19 | |
---|
| 20 | a { text-decoration: none; } |
---|
| 21 | |
---|
| 22 | a:link, a:visited { |
---|
| 23 | color: #660000; |
---|
| 24 | border-bottom: 1px dotted #C0C0F0; |
---|
| 25 | } |
---|
| 26 | |
---|
| 27 | a:hover, a:focus { |
---|
| 28 | color: #993333; |
---|
| 29 | background: #FFFFCC; |
---|
| 30 | border-bottom: 1px dotted #303099; |
---|
| 31 | } |
---|
| 32 | |
---|
| 33 | |
---|
| 34 | /* Main styles --------------------------------------------------------------- */ |
---|
| 35 | |
---|
| 36 | body { |
---|
| 37 | margin: 0; |
---|
| 38 | padding: 0; |
---|
| 39 | font-size: 10pt; |
---|
| 40 | font-family: Verdana, Helvetica, Arial, sans-serif; |
---|
| 41 | background-color: #FFFFFF; |
---|
| 42 | } |
---|
| 43 | |
---|
| 44 | p { |
---|
| 45 | margin-top: 0.5em; |
---|
| 46 | margin-bottom: 0; |
---|
| 47 | } |
---|
| 48 | |
---|
| 49 | #container { margin: 1em; } |
---|
| 50 | |
---|
| 51 | code.section { white-space: pre; } |
---|
| 52 | |
---|
| 53 | pre.snippet { |
---|
| 54 | margin-left: 5%; |
---|
| 55 | background: #F0F0F0; |
---|
| 56 | border: 1px dashed #999999; |
---|
| 57 | width: 43em; |
---|
| 58 | padding: 0.5em 0.5em 0.5em 0.5em; |
---|
| 59 | white-space: pre; |
---|
| 60 | } |
---|
| 61 | |
---|
| 62 | /* Navbar styles ------------------------------------------------------------- */ |
---|
| 63 | |
---|
| 64 | #navbar_title { |
---|
| 65 | color: #000033; |
---|
| 66 | background-color: #F0F0FF; |
---|
| 67 | font-family: Arial, Helvetica, sans-serif; |
---|
| 68 | padding: 20px 30px; |
---|
| 69 | border-bottom: 1px solid #000033; |
---|
| 70 | } |
---|
| 71 | |
---|
| 72 | #navbar_title * { |
---|
| 73 | margin: 0; |
---|
| 74 | padding: 0; |
---|
| 75 | } |
---|
| 76 | |
---|
| 77 | #navbar_title h1 { |
---|
| 78 | letter-spacing: 0.1em; |
---|
| 79 | font-variant: small-caps; |
---|
| 80 | font-size: 250%; |
---|
| 81 | text-indent: -1em; |
---|
| 82 | padding-left: 1em; |
---|
| 83 | } |
---|
| 84 | |
---|
| 85 | #navbar_title h2 { |
---|
| 86 | font-size: 110%; |
---|
| 87 | font-weight: normal; |
---|
| 88 | color: #333399; |
---|
| 89 | } |
---|
| 90 | |
---|
| 91 | #main_navbar table { |
---|
| 92 | width: 100%; |
---|
| 93 | border-bottom: 1px solid #666699; |
---|
| 94 | } |
---|
| 95 | |
---|
| 96 | #main_navbar td { |
---|
| 97 | background: #CCCCFF; |
---|
| 98 | font-size: 80%; |
---|
| 99 | font-weight: bold; |
---|
| 100 | font-family: Arial, Helvetica, sans-serif; |
---|
| 101 | border-top: 3px solid #CCCCFF; |
---|
| 102 | border-bottom: 3px solid #CCCCFF; |
---|
| 103 | padding-left: 6px; |
---|
| 104 | padding-right: 6px; |
---|
| 105 | margin: 0; |
---|
| 106 | } |
---|
| 107 | |
---|
| 108 | #main_navbar td#selected { |
---|
| 109 | background: #CCCCFF; |
---|
| 110 | font-size: 80%; |
---|
| 111 | font-weight: bold; |
---|
| 112 | font-family: Arial, Helvetica, sans-serif; |
---|
| 113 | border-top: 3px solid #333399; |
---|
| 114 | border-bottom: 3px solid #CCCCFF; |
---|
| 115 | padding-left: 6px; |
---|
| 116 | padding-right: 6px; |
---|
| 117 | margin: 0; |
---|
| 118 | } |
---|
| 119 | |
---|
| 120 | #main_navbar td#flexible { |
---|
| 121 | width: 100%; |
---|
| 122 | text-align: right; |
---|
| 123 | padding-right: 1em; |
---|
| 124 | background: #CCCCFF; |
---|
| 125 | font-size: 70%; |
---|
| 126 | font-weight: normal; |
---|
| 127 | font-family: Arial, Helvetica, sans-serif; |
---|
| 128 | text-transform: uppercase; |
---|
| 129 | border-top: 3px solid #CCCCFF; |
---|
| 130 | border-bottom: 3px solid #CCCCFF; |
---|
| 131 | } |
---|
| 132 | |
---|
| 133 | #main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; } |
---|
| 134 | |
---|
| 135 | #main_navbar a:hover, #main_navbar a:focus { |
---|
| 136 | color: #FFFF66; |
---|
| 137 | background: #CCCCFF; |
---|
| 138 | border-bottom: 1px none #606099; |
---|
| 139 | border: 0; |
---|
| 140 | } |
---|
| 141 | |
---|
| 142 | #secondary_navbar { |
---|
| 143 | font-size: 80%; |
---|
| 144 | font-weight: normal; |
---|
| 145 | font-family: Arial, Helvetica, sans-serif; |
---|
| 146 | margin-top: 4px; |
---|
| 147 | margin-left: 20px; |
---|
| 148 | white-space: nowrap; |
---|
| 149 | } |
---|
| 150 | |
---|
| 151 | |
---|
| 152 | /* Tagline and footer styles ------------------------------------------------- */ |
---|
| 153 | |
---|
| 154 | div#tagline { |
---|
| 155 | margin-top: 6px; |
---|
| 156 | border-top: 1px dotted lightsteelblue; |
---|
| 157 | padding-top: 6px; |
---|
| 158 | font-size: 66%; |
---|
| 159 | font-style: italic; |
---|
| 160 | } |
---|
| 161 | |
---|
| 162 | div#footer { |
---|
| 163 | margin-top: 6px; |
---|
| 164 | border-top: 1px dotted lightsteelblue; |
---|
| 165 | padding-top: 6px; |
---|
| 166 | font-size: 66%; |
---|
| 167 | font-style: italic; |
---|
| 168 | } |
---|
| 169 | |
---|
| 170 | /* Basic data presenation styles -------------------------------------------- */ |
---|
| 171 | |
---|
| 172 | .index_letter { |
---|
| 173 | font-size: 300%; |
---|
| 174 | font-weight: bold; |
---|
| 175 | color: #000066; |
---|
| 176 | margin: 0.5em 0 0 -0.1em; |
---|
| 177 | } |
---|
| 178 | |
---|
| 179 | h1, h2, h3, h4 { |
---|
| 180 | font-weight: normal; |
---|
| 181 | color: #3333CC; |
---|
| 182 | } |
---|
| 183 | |
---|
| 184 | h1 { |
---|
| 185 | padding-top: 0.75em; |
---|
| 186 | font-size: 160%; |
---|
| 187 | } |
---|
| 188 | |
---|
| 189 | h2 { |
---|
| 190 | padding-top: 1em; |
---|
| 191 | font-size: 120%; |
---|
| 192 | } |
---|
| 193 | |
---|
| 194 | h3 { |
---|
| 195 | padding-top: 0.75em; |
---|
| 196 | margin-bottom: 0.25em; |
---|
| 197 | font-size: 100%; |
---|
| 198 | } |
---|
| 199 | |
---|
| 200 | h4 { |
---|
| 201 | padding: 0; |
---|
| 202 | margin: 0.5em 0 0 0; |
---|
| 203 | font-size: 80%; |
---|
| 204 | } |
---|
| 205 | |
---|
| 206 | table.basic { |
---|
| 207 | empty-cells: show; |
---|
| 208 | margin: 1.5em 1em 0 1em; |
---|
| 209 | border: 1px dotted #CFCFFF; |
---|
| 210 | font-size: 80%; |
---|
| 211 | } |
---|
| 212 | |
---|
| 213 | table.basic th { |
---|
| 214 | background-color: #F0F0FF; |
---|
| 215 | font-weight: bold; |
---|
| 216 | text-align: left; |
---|
| 217 | padding: 4px 1em 4px 4px; |
---|
| 218 | border-bottom: 1px dotted #666699; |
---|
| 219 | } |
---|
| 220 | |
---|
| 221 | table.basic td { |
---|
| 222 | vertical-align: top; |
---|
| 223 | padding: 4px 1em 4px 4px; |
---|
| 224 | } |
---|
| 225 | |
---|
| 226 | dd { |
---|
| 227 | margin-bottom: 0.25em; |
---|
| 228 | font-size: 80%; |
---|
| 229 | } |
---|
| 230 | |
---|
| 231 | |
---|
| 232 | /* Warnings styles ----------------------------------------------------------- */ |
---|
| 233 | |
---|
| 234 | |
---|
| 235 | #todo dl, #bugs dl { |
---|
| 236 | margin: 0 0 0 1.5em; |
---|
| 237 | font-size: 80%; |
---|
| 238 | } |
---|
| 239 | |
---|
| 240 | #todo dd, #bugs dd { |
---|
| 241 | margin-left: 3em; |
---|
| 242 | font-size: 100%; |
---|
| 243 | } |
---|
| 244 | |
---|
| 245 | #undoc table, #obsolete table, #statistics table { |
---|
| 246 | width: 80%; |
---|
| 247 | margin-left: 2em; |
---|
| 248 | } |
---|
| 249 | |
---|
| 250 | #undoc td, #obsolete td, #statistics td { |
---|
| 251 | padding: 0 0 0 0; |
---|
| 252 | font-size: 80%; |
---|
| 253 | white-space: nowrap; |
---|
| 254 | } |
---|
| 255 | |
---|
| 256 | #undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; } |
---|
| 257 | |
---|
| 258 | #undoc td.docstat, #statistics td.stat { |
---|
| 259 | width: 50%; |
---|
| 260 | text-align: right; |
---|
| 261 | } |
---|
| 262 | |
---|
| 263 | #undoc td.partialdoc, #statistics td.caution { color: #CC6600; } |
---|
| 264 | |
---|
| 265 | #undoc td.notdoc, #statistics td.warning { color: #993333; } |
---|
| 266 | |
---|
| 267 | /* File + routine styles ----------------------------------------------------- */ |
---|
| 268 | |
---|
| 269 | h1.directory { |
---|
| 270 | padding: 1em 0 0 0; |
---|
| 271 | margin: 0; |
---|
| 272 | font-size: 66%; |
---|
| 273 | } |
---|
| 274 | |
---|
| 275 | h1.directory a { border-bottom: 0; } |
---|
| 276 | |
---|
| 277 | h2.pro_file { |
---|
| 278 | padding: 0; |
---|
| 279 | margin: 0; |
---|
| 280 | font-size: 140%; |
---|
| 281 | } |
---|
| 282 | |
---|
| 283 | div#file_attr { |
---|
| 284 | padding: 0 1em 0 1em; |
---|
| 285 | margin: 1em; |
---|
| 286 | background: #F6F6F6; |
---|
| 287 | border: 1px dotted #999999; |
---|
| 288 | } |
---|
| 289 | |
---|
| 290 | div#file_attr dt { |
---|
| 291 | font-size: 80%; |
---|
| 292 | font-weight: bold; |
---|
| 293 | } |
---|
| 294 | |
---|
| 295 | div#file_attr dd { |
---|
| 296 | font-size: 80%; |
---|
| 297 | } |
---|
| 298 | |
---|
| 299 | div#class_diagram { |
---|
| 300 | padding: 1em 0 1em 0; |
---|
| 301 | white-space: pre; |
---|
| 302 | font-family: 'Courier New'; |
---|
| 303 | } |
---|
| 304 | |
---|
| 305 | table#sav_attr { |
---|
| 306 | font-size: 90%; |
---|
| 307 | margin: 1em; |
---|
| 308 | padding: 1em 1em 1em 1em; |
---|
| 309 | background: #F6F6F6; |
---|
| 310 | border: 1px dotted #999999; |
---|
| 311 | } |
---|
| 312 | |
---|
| 313 | table#sav_attr th { text-align: left; } |
---|
| 314 | |
---|
| 315 | table#sav_attr td { vertical-align: top; padding-right: 2em; } |
---|
| 316 | |
---|
| 317 | table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; } |
---|
| 318 | |
---|
| 319 | p.sav_warning { margin-left: 4em; font-family: 80%; } |
---|
| 320 | |
---|
| 321 | table.variables { |
---|
| 322 | font-family: 'Courier New', monospace; |
---|
| 323 | font-size: 80%; |
---|
| 324 | text-indent: -2em; |
---|
| 325 | padding-left: 2em; |
---|
| 326 | } |
---|
| 327 | |
---|
| 328 | table.variables td.image { width: 64px; } |
---|
| 329 | |
---|
| 330 | div#file_comments { |
---|
| 331 | margin: 2em; |
---|
| 332 | font-size: 80%; |
---|
| 333 | } |
---|
| 334 | |
---|
| 335 | |
---|
| 336 | div.field_summary { |
---|
| 337 | padding: 0 1em 0 1em; |
---|
| 338 | margin: 1em; |
---|
| 339 | background: #FFFFF0; |
---|
| 340 | border: 1px dotted #C0C000; |
---|
| 341 | } |
---|
| 342 | |
---|
| 343 | div#routine_summary { |
---|
| 344 | padding: 0 1em 0 1em; |
---|
| 345 | margin: 1em; |
---|
| 346 | background: #F0F0FF; |
---|
| 347 | border: 1px dotted #9999FF; |
---|
| 348 | } |
---|
| 349 | |
---|
| 350 | div.field_summary h2, div#routine_summary h2 { |
---|
| 351 | padding: 0.5em 0 0 0; |
---|
| 352 | margin: 0; |
---|
| 353 | } |
---|
| 354 | |
---|
| 355 | div.field_summary table, div.field_summary p { |
---|
| 356 | margin: 1em 1em; |
---|
| 357 | } |
---|
| 358 | |
---|
| 359 | div.field_summary td.name { |
---|
| 360 | vertical-align: top; |
---|
| 361 | padding-bottom: 0.25em; |
---|
| 362 | color: #3333CC; |
---|
| 363 | } |
---|
| 364 | |
---|
| 365 | div.field_summary span.field_type { |
---|
| 366 | font-weight: normal; |
---|
| 367 | font-size: 80%; |
---|
| 368 | color: black; |
---|
| 369 | } |
---|
| 370 | |
---|
| 371 | div.field_summary td.comments { |
---|
| 372 | vertical-align: top; |
---|
| 373 | padding-left: 2em; |
---|
| 374 | font-size: 80%; |
---|
| 375 | } |
---|
| 376 | |
---|
| 377 | p.commaList { |
---|
| 378 | margin: 1em 1em 1em 1em; |
---|
| 379 | } |
---|
| 380 | |
---|
| 381 | span.warning { |
---|
| 382 | color: #CC6633; |
---|
| 383 | font-weight: bold; |
---|
| 384 | font-size: 66%; |
---|
| 385 | text-transform: uppercase; |
---|
| 386 | } |
---|
| 387 | |
---|
| 388 | span.categories { |
---|
| 389 | color: #006633; |
---|
| 390 | font-weight: bold; |
---|
| 391 | font-size: 66%; |
---|
| 392 | text-transform: uppercase; |
---|
| 393 | } |
---|
| 394 | |
---|
| 395 | span.undoc { |
---|
| 396 | color: #FF6633; |
---|
| 397 | font-weight: bold; |
---|
| 398 | font-size: 80%; |
---|
| 399 | text-transform: uppercase; |
---|
| 400 | } |
---|
| 401 | |
---|
| 402 | span.attr { |
---|
| 403 | color: #006633; |
---|
| 404 | font-weight: bold; |
---|
| 405 | font-size: 80%; |
---|
| 406 | text-transform: uppercase; |
---|
| 407 | } |
---|
| 408 | |
---|
| 409 | span.value { |
---|
| 410 | color: #006633; |
---|
| 411 | font-weight: normal; |
---|
| 412 | text-transform: none; |
---|
| 413 | } |
---|
| 414 | |
---|
| 415 | a.top { |
---|
| 416 | font-weight: bold; |
---|
| 417 | font-size: 66%; |
---|
| 418 | text-transform: uppercase; |
---|
| 419 | float: right; |
---|
| 420 | } |
---|
| 421 | |
---|
| 422 | span.result { |
---|
| 423 | font-family: Verdana, Arial, Helvetica, sans-serif; |
---|
| 424 | font-style: italic; |
---|
| 425 | font-size: 80%; |
---|
| 426 | } |
---|
| 427 | |
---|
| 428 | div#routine_summary p, div.routine_details p.header { |
---|
| 429 | padding-top: 0.5em; |
---|
| 430 | margin-left: 1.5em; |
---|
| 431 | text-indent: -1.5em; |
---|
| 432 | font-family: 'Courier New', monospace; |
---|
| 433 | } |
---|
| 434 | |
---|
| 435 | div.routine_details { |
---|
| 436 | padding: 0.5em 1em 0.5em 1em; |
---|
| 437 | margin: 1em; |
---|
| 438 | border: 1px dotted #CCCCCC; |
---|
| 439 | } |
---|
| 440 | |
---|
| 441 | div.routine_details h2 { |
---|
| 442 | padding-top: 0; |
---|
| 443 | margin-top: 0; |
---|
| 444 | } |
---|
| 445 | |
---|
| 446 | div.routine_details div.value { |
---|
| 447 | margin: 0 1em 0 1em; |
---|
| 448 | font-size: 80%; |
---|
| 449 | } |
---|
| 450 | |
---|
| 451 | div.routine_details div.comments { |
---|
| 452 | font-size: 80%; |
---|
| 453 | margin: 0.75em 1em 1em 1em; |
---|
| 454 | } |
---|
| 455 | |
---|
| 456 | div.routine_details div.preformat { |
---|
| 457 | white-space: pre; |
---|
| 458 | } |
---|
| 459 | |
---|
| 460 | table.statistics { |
---|
| 461 | font-size: 80%; |
---|
| 462 | margin-left: 1em; |
---|
| 463 | } |
---|
| 464 | |
---|
| 465 | table.statistics td { |
---|
| 466 | padding: 0 2em 0 0; |
---|
| 467 | } |
---|
| 468 | |
---|
| 469 | /* Overview styles ----------------------------------------------------------- */ |
---|
| 470 | |
---|
| 471 | div.overview { |
---|
| 472 | width: 100%; |
---|
| 473 | margin-top: 1em; |
---|
| 474 | clear: both; |
---|
| 475 | } |
---|
| 476 | |
---|
| 477 | div.overview table { |
---|
| 478 | empty-cells: show; |
---|
| 479 | font-size: 90%; |
---|
| 480 | margin: 1em 1em 1em 1em; |
---|
| 481 | padding: 1em 0.5em 1em 0.5em; |
---|
| 482 | background: #F6F6F6; |
---|
| 483 | border: 1px dotted #999999; |
---|
| 484 | } |
---|
| 485 | |
---|
| 486 | div.overview td { |
---|
| 487 | padding: 3px 1em 3px 1em; |
---|
| 488 | } |
---|
| 489 | |
---|
| 490 | div.overview td.dir { |
---|
| 491 | width: 1%; |
---|
| 492 | vertical-align: top; |
---|
| 493 | text-align: right; |
---|
| 494 | padding-right: 1em; |
---|
| 495 | } |
---|
| 496 | |
---|
| 497 | |
---|
| 498 | /* Navigation list styles for tree structures -------------------------------- */ |
---|
| 499 | |
---|
| 500 | #tree { |
---|
| 501 | text-align: left; |
---|
| 502 | font-size: 90%; |
---|
| 503 | margin: 0.75em 0 0.75em 0; |
---|
| 504 | padding: 0; |
---|
| 505 | } |
---|
| 506 | |
---|
| 507 | #tree ul { |
---|
| 508 | text-align: left; |
---|
| 509 | margin: 0; |
---|
| 510 | padding: 0; |
---|
| 511 | } |
---|
| 512 | |
---|
| 513 | #tree li { |
---|
| 514 | margin: 0 0 0 15px; |
---|
| 515 | padding: 0; |
---|
| 516 | list-style-type: none; |
---|
| 517 | } |
---|
| 518 | |
---|
| 519 | #tree .symbols { |
---|
| 520 | float: left; |
---|
| 521 | width: 12px; |
---|
| 522 | height: 1em; |
---|
| 523 | padding-left: 4px; |
---|
| 524 | background-position: 0 100%; |
---|
| 525 | background-repeat: no-repeat; |
---|
| 526 | } |
---|
| 527 | |
---|
| 528 | /* Search styles ------------------------------------------------------------- */ |
---|
| 529 | |
---|
| 530 | input.writein { |
---|
| 531 | padding-left: 0.5em; |
---|
| 532 | border: 1px solid #CCCCCC; |
---|
| 533 | font-family: 'Courier New'; |
---|
| 534 | background: #FFFFF3; |
---|
| 535 | } |
---|
| 536 | |
---|
| 537 | #search form { |
---|
| 538 | margin-left: 2em; |
---|
| 539 | } |
---|
| 540 | |
---|
| 541 | #search table { |
---|
| 542 | margin: 1em 1em 0 2em; |
---|
| 543 | padding: 1em 2em 1em 2em; |
---|
| 544 | background: #F6F6F6; |
---|
| 545 | border: 1px dotted #999999; |
---|
| 546 | } |
---|
| 547 | |
---|
| 548 | #search tr { |
---|
| 549 | text-align: center; |
---|
| 550 | } |
---|
| 551 | |
---|
| 552 | #search td { |
---|
| 553 | font-size: 80%; |
---|
| 554 | text-align: left; |
---|
| 555 | } |
---|
| 556 | |
---|
| 557 | #search td * { |
---|
| 558 | vertical-align: middle; |
---|
| 559 | } |
---|
| 560 | |
---|
| 561 | #search p { |
---|
| 562 | font-size: 66%; |
---|
| 563 | margin: 0 3em 2em 3em; |
---|
| 564 | } |
---|
| 565 | |
---|
| 566 | /* Help styles --------------------------------------------------------------- */ |
---|
| 567 | |
---|
| 568 | div.toc { |
---|
| 569 | padding: 0 1em 0 1em; |
---|
| 570 | margin: 1em; |
---|
| 571 | background: #F0F0FF; |
---|
| 572 | border: 1px dotted #9999FF; |
---|
| 573 | width: 19em; |
---|
| 574 | } |
---|
| 575 | |
---|
| 576 | div.right { |
---|
| 577 | float: right; |
---|
| 578 | width: 22em; |
---|
| 579 | } |
---|
| 580 | |
---|
| 581 | ol.toc { |
---|
| 582 | list-style-type: upper-roman; |
---|
| 583 | } |
---|
| 584 | |
---|
| 585 | ol.toc ol { |
---|
| 586 | padding-left: 3em; |
---|
| 587 | margin-left: 0; |
---|
| 588 | list-style-type: lower-alpha; |
---|
| 589 | } |
---|
| 590 | |
---|
| 591 | dl.variables dt { font-size: 80%; } |
---|
| 592 | dl.variables dd { margin-bottom: 0.5em; } |
---|
| 593 | |
---|
| 594 | </style> |
---|
| 595 | <style type="text/css" media="print"> |
---|
| 596 | #navbar_title { |
---|
| 597 | background-color: #FFFFFF; |
---|
| 598 | } |
---|
| 599 | |
---|
| 600 | #main_navbar td { |
---|
| 601 | background: #FFFFFF; |
---|
| 602 | border-top: 0.25em solid #FFFFFF; |
---|
| 603 | border-bottom: 0.25em solid #FFFFFF; |
---|
| 604 | } |
---|
| 605 | |
---|
| 606 | #main_navbar td#selected { |
---|
| 607 | background: #FFFFFF; |
---|
| 608 | border-top: 0.25em solid #333399; |
---|
| 609 | border-bottom: 0.25em solid #FFFFFF; |
---|
| 610 | } |
---|
| 611 | |
---|
| 612 | #main_navbar td#flexible { |
---|
| 613 | background: #FFFFFF; |
---|
| 614 | border-top: 0.25em solid #FFFFFF; |
---|
| 615 | border-bottom: 0.25em solid #FFFFFF; |
---|
| 616 | } |
---|
| 617 | |
---|
| 618 | #secondary_navbar { |
---|
| 619 | display: none; |
---|
| 620 | } |
---|
| 621 | |
---|
| 622 | </style> |
---|
| 623 | |
---|
| 624 | |
---|
| 625 | <script type="text/javascript"> |
---|
| 626 | function setTitle() { |
---|
| 627 | parent.document.title="xidldoc.pro (IDLdoc project documentation)"; |
---|
| 628 | } |
---|
| 629 | </script> |
---|
| 630 | </head> |
---|
| 631 | |
---|
| 632 | <body onload="setTitle();"> |
---|
| 633 | |
---|
| 634 | <div id="navbar_title"> |
---|
| 635 | <h1>IDLdoc project documentation</h1> |
---|
| 636 | <h2>"The IDL code documentation project documentation"</h2> |
---|
| 637 | </div> |
---|
| 638 | |
---|
| 639 | |
---|
| 640 | |
---|
| 641 | <div id="container"> |
---|
| 642 | |
---|
| 643 | <h1 class="directory"><a href="directory-overview.html">idldoc\xidldoc\</a></h1> |
---|
| 644 | <h2 class="pro_file">xidldoc.pro</h2> |
---|
| 645 | |
---|
| 646 | <div id="file_attr"> |
---|
| 647 | <dl> |
---|
| 648 | <dt>Last modification:</dt> |
---|
| 649 | <dd>Sat Mar 11 21:30:44 2006</dd> |
---|
| 650 | </dl> |
---|
| 651 | </div> |
---|
| 652 | |
---|
| 653 | <div id="file_comments"> xIDLdoc is a graphical front-end for IDLdoc, the IDL |
---|
| 654 | documentation system developed by Michael D. Galloy of RSI's Global |
---|
| 655 | Services Group. |
---|
| 656 | |
---|
| 657 | <p> To use xIDLdoc, IDLdoc should already be installed in a user's |
---|
| 658 | IDL path or compiled in memory. IDLdoc messages, warnings and errors are |
---|
| 659 | displayed in the IDL output log. |
---|
| 660 | </div> |
---|
| 661 | |
---|
| 662 | |
---|
| 663 | |
---|
| 664 | |
---|
| 665 | |
---|
| 666 | |
---|
| 667 | |
---|
| 668 | |
---|
| 669 | <div id="routine_summary"> |
---|
| 670 | <h2>Routine summary</h2> |
---|
| 671 | |
---|
| 672 | <dl> |
---|
| 673 | |
---|
| 674 | <dt><p><a href="#_xidldoc::get_value"><span class="result">result = </span>xidldoc::get_value(<span class="result">uname</span>)</a></p><dt> |
---|
| 675 | <dd> Finds and returns the value of a widget (or, for a button widget, whether it is set), given the uname of the widget.</dd> |
---|
| 676 | |
---|
| 677 | <dt><p><a href="#_xidldoc::set_value">xidldoc::set_value<span class="result">, uname, value</span></a></p><dt> |
---|
| 678 | <dd> Finds and sets the value of a widget, given the uname of the widget and the value to set.</dd> |
---|
| 679 | |
---|
| 680 | <dt><p><a href="#_xidldoc::run">xidldoc::run</a></p><dt> |
---|
| 681 | <dd> Runs IDLdoc, given the parameters set in the xIDLdoc UI.</dd> |
---|
| 682 | |
---|
| 683 | <dt><p><a href="#_xidldoc::handle_events">xidldoc::handle_events<span class="result">, event</span></a></p><dt> |
---|
| 684 | <dd> Handles events in the xIDLdoc UI.</dd> |
---|
| 685 | |
---|
| 686 | <dt><p><a href="#_xidldoc::cleanup_widgets">xidldoc::cleanup_widgets<span class="result">, top</span></a></p><dt> |
---|
| 687 | <dd> Destroys the UI and cleans up any resources associated with it.</dd> |
---|
| 688 | |
---|
| 689 | <dt><p><a href="#_xidldoc::start_xmanager">xidldoc::start_xmanager</a></p><dt> |
---|
| 690 | <dd> Calls XMANAGER to register xIDLdoc's widget interface.</dd> |
---|
| 691 | |
---|
| 692 | <dt><p><a href="#_xidldoc::display">xidldoc::display</a></p><dt> |
---|
| 693 | <dd> Displays the header image in the draw window, if present.</dd> |
---|
| 694 | |
---|
| 695 | <dt><p><a href="#_xidldoc::realize">xidldoc::realize</a></p><dt> |
---|
| 696 | <dd> Realizes the widget hierarchy.</dd> |
---|
| 697 | |
---|
| 698 | <dt><p><a href="#_xidldoc::center_ui">xidldoc::center_ui</a></p><dt> |
---|
| 699 | <dd> Centers the UI on the display.</dd> |
---|
| 700 | |
---|
| 701 | <dt><p><a href="#_xidldoc::make_input_row">xidldoc::make_input_row<span class="result">, parent, label, text</span>[, /no_button]</a></p><dt> |
---|
| 702 | <dd> Makes a UI element consisting of a label, a text field and a "Browse" button.</dd> |
---|
| 703 | |
---|
| 704 | <dt><p><a href="#_xidldoc::select_font"><span class="result">result = </span>xidldoc::select_font([/big][, /bold])</a></p><dt> |
---|
| 705 | <dd> Returns a string containing the name of a font that can be used in a label or text widget.</dd> |
---|
| 706 | |
---|
| 707 | <dt><p><a href="#_xidldoc::build_widgets">xidldoc::build_widgets</a></p><dt> |
---|
| 708 | <dd> Builds the widget hierarchy.</dd> |
---|
| 709 | |
---|
| 710 | <dt><p><a href="#_xidldoc::destruct">xidldoc::destruct</a></p><dt> |
---|
| 711 | <dd> The actual class destructor.</dd> |
---|
| 712 | |
---|
| 713 | <dt><p><a href="#_xidldoc::cleanup">xidldoc::cleanup</a></p><dt> |
---|
| 714 | <dd> The official class destructor.</dd> |
---|
| 715 | |
---|
| 716 | <dt><p><a href="#_xidldoc::init"><span class="result">result = </span>xidldoc::init([header_image=<span class="result">RGB image</span>])</a></p><dt> |
---|
| 717 | <dd> Class constructor, used to load class data.</dd> |
---|
| 718 | |
---|
| 719 | <dt><p><a href="#_xidldoc__define">xidldoc__define</a></p><dt> |
---|
| 720 | <dd> The xIDLdoc class data definition routine.</dd> |
---|
| 721 | |
---|
| 722 | <dt><p><a href="#_xidldoc">xidldoc</a></p><dt> |
---|
| 723 | <dd> This is a wrapper for simplifying the creation and use of an <code>xIDLdoc</code> object.</dd> |
---|
| 724 | |
---|
| 725 | </dl> |
---|
| 726 | </div> |
---|
| 727 | |
---|
| 728 | |
---|
| 729 | <div id="routine_details"> |
---|
| 730 | |
---|
| 731 | |
---|
| 732 | <div class="routine_details" id="_xidldoc::get_value"> |
---|
| 733 | |
---|
| 734 | <h2><a class="top" href="#container">top</a>xidldoc::get_value </h2> |
---|
| 735 | |
---|
| 736 | <p class="header"> |
---|
| 737 | <span class="result">result = </span>xidldoc::get_value(<span class="result"><a href="#_xidldoc::get_value_param_uname">uname</a></span>)</p> |
---|
| 738 | |
---|
| 739 | <div class="comments"> |
---|
| 740 | Finds and returns the value of a widget (or, for a button widget, |
---|
| 741 | whether it is set), given the uname of the widget. |
---|
| 742 | </div> |
---|
| 743 | |
---|
| 744 | <h3>Return value</h3><div class="value"> The value of the widget, or for a button, 1 if set, 0 if |
---|
| 745 | not set.</div> |
---|
| 746 | |
---|
| 747 | |
---|
| 748 | <h3>Parameters</h3> |
---|
| 749 | |
---|
| 750 | |
---|
| 751 | <h4 id="_xidldoc::get_value_param_uname">uname |
---|
| 752 | <span class="attr">in</span> |
---|
| 753 | |
---|
| 754 | |
---|
| 755 | <span class="attr">required</span> |
---|
| 756 | |
---|
| 757 | <span class="attr">type:</span> <span class="value">string</span> |
---|
| 758 | |
---|
| 759 | |
---|
| 760 | </h4> |
---|
| 761 | |
---|
| 762 | <div class="comments"> The user value of the |
---|
| 763 | widget being manipulated.</div> |
---|
| 764 | |
---|
| 765 | |
---|
| 766 | |
---|
| 767 | |
---|
| 768 | |
---|
| 769 | |
---|
| 770 | |
---|
| 771 | |
---|
| 772 | |
---|
| 773 | |
---|
| 774 | |
---|
| 775 | |
---|
| 776 | |
---|
| 777 | |
---|
| 778 | |
---|
| 779 | |
---|
| 780 | |
---|
| 781 | |
---|
| 782 | |
---|
| 783 | |
---|
| 784 | |
---|
| 785 | |
---|
| 786 | |
---|
| 787 | |
---|
| 788 | |
---|
| 789 | |
---|
| 790 | |
---|
| 791 | |
---|
| 792 | |
---|
| 793 | </div> |
---|
| 794 | |
---|
| 795 | |
---|
| 796 | <div class="routine_details" id="_xidldoc::set_value"> |
---|
| 797 | |
---|
| 798 | <h2><a class="top" href="#container">top</a>xidldoc::set_value </h2> |
---|
| 799 | |
---|
| 800 | <p class="header"> |
---|
| 801 | xidldoc::set_value<span class="result">, <a href="#_xidldoc::set_value_param_uname">uname</a>, <a href="#_xidldoc::set_value_param_value">value</a></span></p> |
---|
| 802 | |
---|
| 803 | <div class="comments"> |
---|
| 804 | Finds and sets the value of a widget, given the uname of the widget |
---|
| 805 | and the value to set. |
---|
| 806 | </div> |
---|
| 807 | |
---|
| 808 | |
---|
| 809 | |
---|
| 810 | |
---|
| 811 | <h3>Parameters</h3> |
---|
| 812 | |
---|
| 813 | |
---|
| 814 | <h4 id="_xidldoc::set_value_param_uname">uname |
---|
| 815 | <span class="attr">in</span> |
---|
| 816 | |
---|
| 817 | |
---|
| 818 | <span class="attr">required</span> |
---|
| 819 | |
---|
| 820 | <span class="attr">type:</span> <span class="value">string</span> |
---|
| 821 | |
---|
| 822 | |
---|
| 823 | </h4> |
---|
| 824 | |
---|
| 825 | <div class="comments"> The user value of the |
---|
| 826 | widget being manipulated.</div> |
---|
| 827 | |
---|
| 828 | <h4 id="_xidldoc::set_value_param_value">value |
---|
| 829 | <span class="attr">in</span> |
---|
| 830 | |
---|
| 831 | |
---|
| 832 | <span class="attr">required</span> |
---|
| 833 | |
---|
| 834 | |
---|
| 835 | |
---|
| 836 | |
---|
| 837 | </h4> |
---|
| 838 | |
---|
| 839 | <div class="comments"> The value to assign the widget.</div> |
---|
| 840 | |
---|
| 841 | |
---|
| 842 | |
---|
| 843 | |
---|
| 844 | |
---|
| 845 | |
---|
| 846 | |
---|
| 847 | |
---|
| 848 | |
---|
| 849 | |
---|
| 850 | |
---|
| 851 | |
---|
| 852 | |
---|
| 853 | |
---|
| 854 | |
---|
| 855 | |
---|
| 856 | |
---|
| 857 | |
---|
| 858 | |
---|
| 859 | |
---|
| 860 | |
---|
| 861 | |
---|
| 862 | |
---|
| 863 | |
---|
| 864 | |
---|
| 865 | |
---|
| 866 | |
---|
| 867 | |
---|
| 868 | |
---|
| 869 | </div> |
---|
| 870 | |
---|
| 871 | |
---|
| 872 | <div class="routine_details" id="_xidldoc::run"> |
---|
| 873 | |
---|
| 874 | <h2><a class="top" href="#container">top</a>xidldoc::run </h2> |
---|
| 875 | |
---|
| 876 | <p class="header"> |
---|
| 877 | xidldoc::run</p> |
---|
| 878 | |
---|
| 879 | <div class="comments"> |
---|
| 880 | Runs IDLdoc, given the parameters set in the xIDLdoc UI. IDLdoc |
---|
| 881 | messages, warnings and errors are displayed in the IDL output |
---|
| 882 | log. It is assumed that the user has IDLdoc installed, either in |
---|
| 883 | their path, or already compiled in memory.</div> |
---|
| 884 | |
---|
| 885 | |
---|
| 886 | |
---|
| 887 | |
---|
| 888 | |
---|
| 889 | |
---|
| 890 | |
---|
| 891 | |
---|
| 892 | |
---|
| 893 | |
---|
| 894 | |
---|
| 895 | |
---|
| 896 | |
---|
| 897 | |
---|
| 898 | |
---|
| 899 | |
---|
| 900 | |
---|
| 901 | |
---|
| 902 | |
---|
| 903 | |
---|
| 904 | |
---|
| 905 | |
---|
| 906 | |
---|
| 907 | |
---|
| 908 | |
---|
| 909 | |
---|
| 910 | |
---|
| 911 | |
---|
| 912 | |
---|
| 913 | |
---|
| 914 | </div> |
---|
| 915 | |
---|
| 916 | |
---|
| 917 | <div class="routine_details" id="_xidldoc::handle_events"> |
---|
| 918 | |
---|
| 919 | <h2><a class="top" href="#container">top</a>xidldoc::handle_events </h2> |
---|
| 920 | |
---|
| 921 | <p class="header"> |
---|
| 922 | xidldoc::handle_events<span class="result">, <a href="#_xidldoc::handle_events_param_event">event</a></span></p> |
---|
| 923 | |
---|
| 924 | <div class="comments"> |
---|
| 925 | Handles events in the xIDLdoc UI. All events generated in the UI |
---|
| 926 | pass through the wrapper routine HANDLE_EVENTS and arrive here, |
---|
| 927 | where the event is parsed based on the generating widget's user |
---|
| 928 | name. |
---|
| 929 | </div> |
---|
| 930 | |
---|
| 931 | |
---|
| 932 | |
---|
| 933 | |
---|
| 934 | <h3>Parameters</h3> |
---|
| 935 | |
---|
| 936 | |
---|
| 937 | <h4 id="_xidldoc::handle_events_param_event">event |
---|
| 938 | <span class="attr">in</span> |
---|
| 939 | |
---|
| 940 | |
---|
| 941 | <span class="attr">required</span> |
---|
| 942 | |
---|
| 943 | <span class="attr">type:</span> <span class="value">structure</span> |
---|
| 944 | |
---|
| 945 | |
---|
| 946 | </h4> |
---|
| 947 | |
---|
| 948 | <div class="comments"> The event structure |
---|
| 949 | passed from XMANAGER.</div> |
---|
| 950 | |
---|
| 951 | |
---|
| 952 | |
---|
| 953 | |
---|
| 954 | |
---|
| 955 | |
---|
| 956 | |
---|
| 957 | |
---|
| 958 | |
---|
| 959 | |
---|
| 960 | |
---|
| 961 | |
---|
| 962 | |
---|
| 963 | |
---|
| 964 | |
---|
| 965 | |
---|
| 966 | |
---|
| 967 | |
---|
| 968 | |
---|
| 969 | |
---|
| 970 | |
---|
| 971 | |
---|
| 972 | |
---|
| 973 | |
---|
| 974 | |
---|
| 975 | |
---|
| 976 | |
---|
| 977 | |
---|
| 978 | |
---|
| 979 | </div> |
---|
| 980 | |
---|
| 981 | |
---|
| 982 | <div class="routine_details" id="_xidldoc::cleanup_widgets"> |
---|
| 983 | |
---|
| 984 | <h2><a class="top" href="#container">top</a>xidldoc::cleanup_widgets </h2> |
---|
| 985 | |
---|
| 986 | <p class="header"> |
---|
| 987 | xidldoc::cleanup_widgets<span class="result">, <a href="#_xidldoc::cleanup_widgets_param_top">top</a></span></p> |
---|
| 988 | |
---|
| 989 | <div class="comments"> |
---|
| 990 | Destroys the UI and cleans up any resources associated with it. |
---|
| 991 | Destroys the object in this case, as well. |
---|
| 992 | |
---|
| 993 | <p> This method is called by XMANAGER through the widget cleanup routine |
---|
| 994 | CLEANUP_WIDGETS. |
---|
| 995 | </div> |
---|
| 996 | |
---|
| 997 | |
---|
| 998 | |
---|
| 999 | |
---|
| 1000 | <h3>Parameters</h3> |
---|
| 1001 | |
---|
| 1002 | |
---|
| 1003 | <h4 id="_xidldoc::cleanup_widgets_param_top">top |
---|
| 1004 | <span class="attr">in</span> |
---|
| 1005 | |
---|
| 1006 | |
---|
| 1007 | |
---|
| 1008 | |
---|
| 1009 | <span class="attr">type:</span> <span class="value">long</span> |
---|
| 1010 | |
---|
| 1011 | |
---|
| 1012 | </h4> |
---|
| 1013 | |
---|
| 1014 | <div class="comments"> The top-level base widget identifier, |
---|
| 1015 | required in the call by XMANAGER.</div> |
---|
| 1016 | |
---|
| 1017 | |
---|
| 1018 | |
---|
| 1019 | |
---|
| 1020 | |
---|
| 1021 | |
---|
| 1022 | |
---|
| 1023 | |
---|
| 1024 | |
---|
| 1025 | |
---|
| 1026 | |
---|
| 1027 | |
---|
| 1028 | |
---|
| 1029 | |
---|
| 1030 | |
---|
| 1031 | |
---|
| 1032 | |
---|
| 1033 | |
---|
| 1034 | |
---|
| 1035 | |
---|
| 1036 | |
---|
| 1037 | |
---|
| 1038 | |
---|
| 1039 | |
---|
| 1040 | |
---|
| 1041 | |
---|
| 1042 | |
---|
| 1043 | |
---|
| 1044 | |
---|
| 1045 | </div> |
---|
| 1046 | |
---|
| 1047 | |
---|
| 1048 | <div class="routine_details" id="_xidldoc::start_xmanager"> |
---|
| 1049 | |
---|
| 1050 | <h2><a class="top" href="#container">top</a>xidldoc::start_xmanager </h2> |
---|
| 1051 | |
---|
| 1052 | <p class="header"> |
---|
| 1053 | xidldoc::start_xmanager</p> |
---|
| 1054 | |
---|
| 1055 | <div class="comments"> |
---|
| 1056 | Calls XMANAGER to register xIDLdoc's widget interface. Events are |
---|
| 1057 | passed through the wrapper routine HANDLE_EVENTS. The kill_notify |
---|
| 1058 | signal is passed through CLEANUP_WIDGETS. |
---|
| 1059 | |
---|
| 1060 | <p> Note that the NO_BLOCK keyword is ignored by IDL Runtime/Virtual |
---|
| 1061 | Machine for IDL < 6.0. |
---|
| 1062 | </div> |
---|
| 1063 | |
---|
| 1064 | |
---|
| 1065 | |
---|
| 1066 | |
---|
| 1067 | |
---|
| 1068 | |
---|
| 1069 | |
---|
| 1070 | |
---|
| 1071 | |
---|
| 1072 | |
---|
| 1073 | |
---|
| 1074 | |
---|
| 1075 | |
---|
| 1076 | |
---|
| 1077 | |
---|
| 1078 | |
---|
| 1079 | |
---|
| 1080 | |
---|
| 1081 | |
---|
| 1082 | |
---|
| 1083 | <h3>Other attributes</h3> |
---|
| 1084 | |
---|
| 1085 | |
---|
| 1086 | <h4>Uses routines</h4><div class="value"> HANDLE_EVENTS, CLEANUP_WIDGETS</div> |
---|
| 1087 | |
---|
| 1088 | |
---|
| 1089 | |
---|
| 1090 | |
---|
| 1091 | |
---|
| 1092 | |
---|
| 1093 | </div> |
---|
| 1094 | |
---|
| 1095 | |
---|
| 1096 | <div class="routine_details" id="_xidldoc::display"> |
---|
| 1097 | |
---|
| 1098 | <h2><a class="top" href="#container">top</a>xidldoc::display </h2> |
---|
| 1099 | |
---|
| 1100 | <p class="header"> |
---|
| 1101 | xidldoc::display</p> |
---|
| 1102 | |
---|
| 1103 | <div class="comments"> |
---|
| 1104 | Displays the header image in the draw window, if present.</div> |
---|
| 1105 | |
---|
| 1106 | |
---|
| 1107 | |
---|
| 1108 | |
---|
| 1109 | |
---|
| 1110 | |
---|
| 1111 | |
---|
| 1112 | |
---|
| 1113 | |
---|
| 1114 | |
---|
| 1115 | |
---|
| 1116 | |
---|
| 1117 | |
---|
| 1118 | |
---|
| 1119 | |
---|
| 1120 | |
---|
| 1121 | |
---|
| 1122 | |
---|
| 1123 | |
---|
| 1124 | |
---|
| 1125 | |
---|
| 1126 | |
---|
| 1127 | |
---|
| 1128 | |
---|
| 1129 | |
---|
| 1130 | |
---|
| 1131 | |
---|
| 1132 | |
---|
| 1133 | |
---|
| 1134 | |
---|
| 1135 | </div> |
---|
| 1136 | |
---|
| 1137 | |
---|
| 1138 | <div class="routine_details" id="_xidldoc::realize"> |
---|
| 1139 | |
---|
| 1140 | <h2><a class="top" href="#container">top</a>xidldoc::realize </h2> |
---|
| 1141 | |
---|
| 1142 | <p class="header"> |
---|
| 1143 | xidldoc::realize</p> |
---|
| 1144 | |
---|
| 1145 | <div class="comments"> |
---|
| 1146 | Realizes the widget hierarchy.</div> |
---|
| 1147 | |
---|
| 1148 | |
---|
| 1149 | |
---|
| 1150 | |
---|
| 1151 | |
---|
| 1152 | |
---|
| 1153 | |
---|
| 1154 | |
---|
| 1155 | |
---|
| 1156 | |
---|
| 1157 | |
---|
| 1158 | |
---|
| 1159 | |
---|
| 1160 | |
---|
| 1161 | |
---|
| 1162 | |
---|
| 1163 | |
---|
| 1164 | |
---|
| 1165 | |
---|
| 1166 | |
---|
| 1167 | |
---|
| 1168 | |
---|
| 1169 | |
---|
| 1170 | |
---|
| 1171 | |
---|
| 1172 | |
---|
| 1173 | |
---|
| 1174 | |
---|
| 1175 | |
---|
| 1176 | |
---|
| 1177 | </div> |
---|
| 1178 | |
---|
| 1179 | |
---|
| 1180 | <div class="routine_details" id="_xidldoc::center_ui"> |
---|
| 1181 | |
---|
| 1182 | <h2><a class="top" href="#container">top</a>xidldoc::center_ui </h2> |
---|
| 1183 | |
---|
| 1184 | <p class="header"> |
---|
| 1185 | xidldoc::center_ui</p> |
---|
| 1186 | |
---|
| 1187 | <div class="comments"> |
---|
| 1188 | Centers the UI on the display.</div> |
---|
| 1189 | |
---|
| 1190 | |
---|
| 1191 | |
---|
| 1192 | |
---|
| 1193 | |
---|
| 1194 | |
---|
| 1195 | |
---|
| 1196 | |
---|
| 1197 | |
---|
| 1198 | |
---|
| 1199 | |
---|
| 1200 | |
---|
| 1201 | |
---|
| 1202 | |
---|
| 1203 | |
---|
| 1204 | |
---|
| 1205 | |
---|
| 1206 | |
---|
| 1207 | |
---|
| 1208 | |
---|
| 1209 | |
---|
| 1210 | |
---|
| 1211 | |
---|
| 1212 | |
---|
| 1213 | |
---|
| 1214 | |
---|
| 1215 | |
---|
| 1216 | |
---|
| 1217 | |
---|
| 1218 | |
---|
| 1219 | </div> |
---|
| 1220 | |
---|
| 1221 | |
---|
| 1222 | <div class="routine_details" id="_xidldoc::make_input_row"> |
---|
| 1223 | |
---|
| 1224 | <h2><a class="top" href="#container">top</a>xidldoc::make_input_row </h2> |
---|
| 1225 | |
---|
| 1226 | <p class="header"> |
---|
| 1227 | xidldoc::make_input_row<span class="result">, <a href="#_xidldoc::make_input_row_param_parent">parent</a>, <a href="#_xidldoc::make_input_row_param_label">label</a>, <a href="#_xidldoc::make_input_row_param_text">text</a></span>[, /<a href="#_xidldoc::make_input_row_keyword_no_button">no_button</a>]</p> |
---|
| 1228 | |
---|
| 1229 | <div class="comments"> |
---|
| 1230 | Makes a UI element consisting of a label, a text field and a |
---|
| 1231 | "Browse" button. |
---|
| 1232 | </div> |
---|
| 1233 | |
---|
| 1234 | |
---|
| 1235 | |
---|
| 1236 | |
---|
| 1237 | <h3>Parameters</h3> |
---|
| 1238 | |
---|
| 1239 | |
---|
| 1240 | <h4 id="_xidldoc::make_input_row_param_parent">parent |
---|
| 1241 | <span class="attr">in</span> |
---|
| 1242 | |
---|
| 1243 | |
---|
| 1244 | <span class="attr">required</span> |
---|
| 1245 | |
---|
| 1246 | <span class="attr">type:</span> <span class="value">long</span> |
---|
| 1247 | |
---|
| 1248 | |
---|
| 1249 | </h4> |
---|
| 1250 | |
---|
| 1251 | <div class="comments"> The widget identifier |
---|
| 1252 | of the parent base of this group of widgets.</div> |
---|
| 1253 | |
---|
| 1254 | <h4 id="_xidldoc::make_input_row_param_label">label |
---|
| 1255 | <span class="attr">in</span> |
---|
| 1256 | |
---|
| 1257 | |
---|
| 1258 | <span class="attr">required</span> |
---|
| 1259 | |
---|
| 1260 | <span class="attr">type:</span> <span class="value">string</span> |
---|
| 1261 | |
---|
| 1262 | |
---|
| 1263 | </h4> |
---|
| 1264 | |
---|
| 1265 | <div class="comments"> The text to display in |
---|
| 1266 | the label widget.</div> |
---|
| 1267 | |
---|
| 1268 | <h4 id="_xidldoc::make_input_row_param_text">text |
---|
| 1269 | <span class="attr">in</span> |
---|
| 1270 | |
---|
| 1271 | |
---|
| 1272 | <span class="attr">required</span> |
---|
| 1273 | |
---|
| 1274 | <span class="attr">type:</span> <span class="value">string</span> |
---|
| 1275 | |
---|
| 1276 | |
---|
| 1277 | </h4> |
---|
| 1278 | |
---|
| 1279 | <div class="comments"> The text to display in |
---|
| 1280 | the text widget.</div> |
---|
| 1281 | |
---|
| 1282 | |
---|
| 1283 | |
---|
| 1284 | |
---|
| 1285 | |
---|
| 1286 | |
---|
| 1287 | <h3>Keywords</h3> |
---|
| 1288 | |
---|
| 1289 | <h4 id="_xidldoc::make_input_row_keyword_no_button">no_button |
---|
| 1290 | <span class="attr">in</span> |
---|
| 1291 | |
---|
| 1292 | <span class="attr">optional</span> |
---|
| 1293 | |
---|
| 1294 | |
---|
| 1295 | <span class="attr">type:</span> <span class="value">boolean</span> |
---|
| 1296 | |
---|
| 1297 | |
---|
| 1298 | </h4> |
---|
| 1299 | |
---|
| 1300 | <div class="comments"> Set to not |
---|
| 1301 | display the "Browse" button.</div> |
---|
| 1302 | |
---|
| 1303 | |
---|
| 1304 | |
---|
| 1305 | |
---|
| 1306 | |
---|
| 1307 | |
---|
| 1308 | |
---|
| 1309 | |
---|
| 1310 | |
---|
| 1311 | |
---|
| 1312 | <h3>Known issues</h3> |
---|
| 1313 | |
---|
| 1314 | |
---|
| 1315 | <h4>Todo items</h4><div class="value"> Make this into a compound widget. |
---|
| 1316 | </div> |
---|
| 1317 | |
---|
| 1318 | |
---|
| 1319 | |
---|
| 1320 | |
---|
| 1321 | |
---|
| 1322 | |
---|
| 1323 | |
---|
| 1324 | |
---|
| 1325 | |
---|
| 1326 | |
---|
| 1327 | |
---|
| 1328 | |
---|
| 1329 | </div> |
---|
| 1330 | |
---|
| 1331 | |
---|
| 1332 | <div class="routine_details" id="_xidldoc::select_font"> |
---|
| 1333 | |
---|
| 1334 | <h2><a class="top" href="#container">top</a>xidldoc::select_font </h2> |
---|
| 1335 | |
---|
| 1336 | <p class="header"> |
---|
| 1337 | <span class="result">result = </span>xidldoc::select_font([/<a href="#_xidldoc::select_font_keyword_big">big</a>][, /<a href="#_xidldoc::select_font_keyword_bold">bold</a>])</p> |
---|
| 1338 | |
---|
| 1339 | <div class="comments"> |
---|
| 1340 | Returns a string containing the name of a font that can be used in a |
---|
| 1341 | label or text widget. |
---|
| 1342 | </div> |
---|
| 1343 | |
---|
| 1344 | <h3>Return value</h3><div class="value"> A string giving the name of the font.</div> |
---|
| 1345 | |
---|
| 1346 | |
---|
| 1347 | |
---|
| 1348 | |
---|
| 1349 | |
---|
| 1350 | <h3>Keywords</h3> |
---|
| 1351 | |
---|
| 1352 | <h4 id="_xidldoc::select_font_keyword_big">big |
---|
| 1353 | <span class="attr">in</span> |
---|
| 1354 | |
---|
| 1355 | <span class="attr">optional</span> |
---|
| 1356 | |
---|
| 1357 | |
---|
| 1358 | <span class="attr">type:</span> <span class="value">boolean</span> |
---|
| 1359 | |
---|
| 1360 | |
---|
| 1361 | </h4> |
---|
| 1362 | |
---|
| 1363 | <div class="comments"> Set this keyword to get |
---|
| 1364 | a larger font.</div> |
---|
| 1365 | |
---|
| 1366 | <h4 id="_xidldoc::select_font_keyword_bold">bold |
---|
| 1367 | <span class="attr">in</span> |
---|
| 1368 | |
---|
| 1369 | <span class="attr">optional</span> |
---|
| 1370 | |
---|
| 1371 | |
---|
| 1372 | <span class="attr">type:</span> <span class="value">boolean</span> |
---|
| 1373 | |
---|
| 1374 | |
---|
| 1375 | </h4> |
---|
| 1376 | |
---|
| 1377 | <div class="comments"> Set this keyword to get |
---|
| 1378 | a bold font.</div> |
---|
| 1379 | |
---|
| 1380 | |
---|
| 1381 | |
---|
| 1382 | |
---|
| 1383 | |
---|
| 1384 | |
---|
| 1385 | |
---|
| 1386 | |
---|
| 1387 | |
---|
| 1388 | |
---|
| 1389 | <h3>Known issues</h3> |
---|
| 1390 | |
---|
| 1391 | |
---|
| 1392 | <h4>Todo items</h4><div class="value"> Make this into an independent function outside this class |
---|
| 1393 | definition. |
---|
| 1394 | </div> |
---|
| 1395 | |
---|
| 1396 | |
---|
| 1397 | |
---|
| 1398 | |
---|
| 1399 | |
---|
| 1400 | |
---|
| 1401 | |
---|
| 1402 | |
---|
| 1403 | |
---|
| 1404 | |
---|
| 1405 | |
---|
| 1406 | |
---|
| 1407 | </div> |
---|
| 1408 | |
---|
| 1409 | |
---|
| 1410 | <div class="routine_details" id="_xidldoc::build_widgets"> |
---|
| 1411 | |
---|
| 1412 | <h2><a class="top" href="#container">top</a>xidldoc::build_widgets </h2> |
---|
| 1413 | |
---|
| 1414 | <p class="header"> |
---|
| 1415 | xidldoc::build_widgets</p> |
---|
| 1416 | |
---|
| 1417 | <div class="comments"> |
---|
| 1418 | Builds the widget hierarchy. Lots of buttons and fields. |
---|
| 1419 | |
---|
| 1420 | <p>Each widget has a user name (uname) used to identify the widget |
---|
| 1421 | in the <code>get_value</code> and <code>set_value</code> methods.</div> |
---|
| 1422 | |
---|
| 1423 | |
---|
| 1424 | |
---|
| 1425 | |
---|
| 1426 | |
---|
| 1427 | |
---|
| 1428 | |
---|
| 1429 | |
---|
| 1430 | |
---|
| 1431 | |
---|
| 1432 | |
---|
| 1433 | |
---|
| 1434 | |
---|
| 1435 | |
---|
| 1436 | |
---|
| 1437 | |
---|
| 1438 | |
---|
| 1439 | |
---|
| 1440 | |
---|
| 1441 | |
---|
| 1442 | |
---|
| 1443 | |
---|
| 1444 | |
---|
| 1445 | |
---|
| 1446 | |
---|
| 1447 | |
---|
| 1448 | |
---|
| 1449 | |
---|
| 1450 | |
---|
| 1451 | |
---|
| 1452 | </div> |
---|
| 1453 | |
---|
| 1454 | |
---|
| 1455 | <div class="routine_details" id="_xidldoc::destruct"> |
---|
| 1456 | |
---|
| 1457 | <h2><a class="top" href="#container">top</a>xidldoc::destruct </h2> |
---|
| 1458 | |
---|
| 1459 | <p class="header"> |
---|
| 1460 | xidldoc::destruct</p> |
---|
| 1461 | |
---|
| 1462 | <div class="comments"> |
---|
| 1463 | The actual class destructor. All cleanup code goes here, since it |
---|
| 1464 | can be called directly.</div> |
---|
| 1465 | |
---|
| 1466 | |
---|
| 1467 | |
---|
| 1468 | |
---|
| 1469 | |
---|
| 1470 | |
---|
| 1471 | |
---|
| 1472 | |
---|
| 1473 | |
---|
| 1474 | |
---|
| 1475 | |
---|
| 1476 | |
---|
| 1477 | |
---|
| 1478 | |
---|
| 1479 | |
---|
| 1480 | |
---|
| 1481 | |
---|
| 1482 | |
---|
| 1483 | |
---|
| 1484 | |
---|
| 1485 | |
---|
| 1486 | |
---|
| 1487 | |
---|
| 1488 | |
---|
| 1489 | |
---|
| 1490 | |
---|
| 1491 | |
---|
| 1492 | |
---|
| 1493 | |
---|
| 1494 | |
---|
| 1495 | </div> |
---|
| 1496 | |
---|
| 1497 | |
---|
| 1498 | <div class="routine_details" id="_xidldoc::cleanup"> |
---|
| 1499 | |
---|
| 1500 | <h2><a class="top" href="#container">top</a>xidldoc::cleanup </h2> |
---|
| 1501 | |
---|
| 1502 | <p class="header"> |
---|
| 1503 | xidldoc::cleanup</p> |
---|
| 1504 | |
---|
| 1505 | <div class="comments"> |
---|
| 1506 | The official class destructor. This method can't be called |
---|
| 1507 | directly, however, so all code is placed in the |
---|
| 1508 | <code>destruct</code> method instead.</div> |
---|
| 1509 | |
---|
| 1510 | |
---|
| 1511 | |
---|
| 1512 | |
---|
| 1513 | |
---|
| 1514 | |
---|
| 1515 | |
---|
| 1516 | |
---|
| 1517 | |
---|
| 1518 | |
---|
| 1519 | |
---|
| 1520 | |
---|
| 1521 | |
---|
| 1522 | |
---|
| 1523 | |
---|
| 1524 | |
---|
| 1525 | |
---|
| 1526 | |
---|
| 1527 | |
---|
| 1528 | |
---|
| 1529 | |
---|
| 1530 | |
---|
| 1531 | |
---|
| 1532 | |
---|
| 1533 | |
---|
| 1534 | |
---|
| 1535 | |
---|
| 1536 | |
---|
| 1537 | |
---|
| 1538 | |
---|
| 1539 | </div> |
---|
| 1540 | |
---|
| 1541 | |
---|
| 1542 | <div class="routine_details" id="_xidldoc::init"> |
---|
| 1543 | |
---|
| 1544 | <h2><a class="top" href="#container">top</a>xidldoc::init </h2> |
---|
| 1545 | |
---|
| 1546 | <p class="header"> |
---|
| 1547 | <span class="result">result = </span>xidldoc::init([<a href="#_xidldoc::init_keyword_header_image">header_image</a>=<span class="result">RGB image</span>])</p> |
---|
| 1548 | |
---|
| 1549 | <div class="comments"> |
---|
| 1550 | Class constructor, used to load class data. Only one instance of |
---|
| 1551 | xIDLdoc can run at any time. |
---|
| 1552 | |
---|
| 1553 | <p> Note that only a pixel-interleaved RGB image can be displayed at |
---|
| 1554 | the top of the interface. |
---|
| 1555 | </div> |
---|
| 1556 | |
---|
| 1557 | <h3>Return value</h3><div class="value"> 1 on success, 0 on failure.</div> |
---|
| 1558 | |
---|
| 1559 | |
---|
| 1560 | |
---|
| 1561 | |
---|
| 1562 | |
---|
| 1563 | <h3>Keywords</h3> |
---|
| 1564 | |
---|
| 1565 | <h4 id="_xidldoc::init_keyword_header_image">header_image |
---|
| 1566 | <span class="attr">in</span> |
---|
| 1567 | |
---|
| 1568 | <span class="attr">optional</span> |
---|
| 1569 | |
---|
| 1570 | |
---|
| 1571 | <span class="attr">type:</span> <span class="value">RGB image</span> |
---|
| 1572 | |
---|
| 1573 | |
---|
| 1574 | </h4> |
---|
| 1575 | |
---|
| 1576 | <div class="comments"> A |
---|
| 1577 | pixel-interleaved RGB image to be displayed at the top of the |
---|
| 1578 | xIDLdoc interface.</div> |
---|
| 1579 | |
---|
| 1580 | |
---|
| 1581 | |
---|
| 1582 | |
---|
| 1583 | |
---|
| 1584 | |
---|
| 1585 | |
---|
| 1586 | |
---|
| 1587 | |
---|
| 1588 | |
---|
| 1589 | |
---|
| 1590 | |
---|
| 1591 | |
---|
| 1592 | |
---|
| 1593 | |
---|
| 1594 | |
---|
| 1595 | |
---|
| 1596 | |
---|
| 1597 | |
---|
| 1598 | |
---|
| 1599 | |
---|
| 1600 | |
---|
| 1601 | |
---|
| 1602 | |
---|
| 1603 | |
---|
| 1604 | |
---|
| 1605 | </div> |
---|
| 1606 | |
---|
| 1607 | |
---|
| 1608 | <div class="routine_details" id="_xidldoc__define"> |
---|
| 1609 | |
---|
| 1610 | <h2><a class="top" href="#container">top</a>xidldoc__define </h2> |
---|
| 1611 | |
---|
| 1612 | <p class="header"> |
---|
| 1613 | xidldoc__define</p> |
---|
| 1614 | |
---|
| 1615 | <div class="comments"> |
---|
| 1616 | The xIDLdoc class data definition routine. |
---|
| 1617 | </div> |
---|
| 1618 | |
---|
| 1619 | |
---|
| 1620 | |
---|
| 1621 | |
---|
| 1622 | |
---|
| 1623 | |
---|
| 1624 | |
---|
| 1625 | |
---|
| 1626 | |
---|
| 1627 | |
---|
| 1628 | |
---|
| 1629 | |
---|
| 1630 | |
---|
| 1631 | |
---|
| 1632 | |
---|
| 1633 | |
---|
| 1634 | |
---|
| 1635 | |
---|
| 1636 | |
---|
| 1637 | |
---|
| 1638 | |
---|
| 1639 | |
---|
| 1640 | |
---|
| 1641 | |
---|
| 1642 | |
---|
| 1643 | |
---|
| 1644 | |
---|
| 1645 | |
---|
| 1646 | |
---|
| 1647 | |
---|
| 1648 | </div> |
---|
| 1649 | |
---|
| 1650 | |
---|
| 1651 | <div class="routine_details" id="_xidldoc"> |
---|
| 1652 | |
---|
| 1653 | <h2><a class="top" href="#container">top</a>xidldoc </h2> |
---|
| 1654 | |
---|
| 1655 | <p class="header"> |
---|
| 1656 | xidldoc</p> |
---|
| 1657 | |
---|
| 1658 | <div class="comments"> |
---|
| 1659 | This is a wrapper for simplifying the creation and use of an |
---|
| 1660 | <code>xIDLdoc</code> object. |
---|
| 1661 | </div> |
---|
| 1662 | |
---|
| 1663 | |
---|
| 1664 | |
---|
| 1665 | |
---|
| 1666 | |
---|
| 1667 | |
---|
| 1668 | |
---|
| 1669 | <h3>Examples</h3><div class="value"> |
---|
| 1670 | <pre> |
---|
| 1671 | IDL> xidldoc |
---|
| 1672 | </pre> |
---|
| 1673 | </div> |
---|
| 1674 | <h3>Version history</h3> |
---|
| 1675 | <h4>Author</h4><div class="value"> Mark Piper, RSI, 2004</div> |
---|
| 1676 | |
---|
| 1677 | <h4>History</h4><div class="value"> |
---|
| 1678 | <ul> |
---|
| 1679 | <li>2005-03-28, MP: Desensitized checkbox for STATISTICS keyword. |
---|
| 1680 | <li>2005-07-21, MP: Resensitized checkbox for STATISTICS keyword. |
---|
| 1681 | Added checkboxes for the ASSISTANT and PREFORMAT keywords. |
---|
| 1682 | <li>2006-03-11, MG: Added tooltips for buttons, desensitized checkbox for |
---|
| 1683 | BROWSE_ROUTINES, added text box for LOG_FILE keyword |
---|
| 1684 | </ul></div> |
---|
| 1685 | |
---|
| 1686 | |
---|
| 1687 | <h3>Known issues</h3> |
---|
| 1688 | |
---|
| 1689 | |
---|
| 1690 | <h4>Todo items</h4><div class="value"> Save settings between calls in an init file stored with |
---|
| 1691 | APP_USER_DIR. Requires IDL 6.1.</div> |
---|
| 1692 | |
---|
| 1693 | |
---|
| 1694 | <h3>Other attributes</h3> |
---|
| 1695 | |
---|
| 1696 | <h4>Requires IDL version</h4><div class="value"> IDL 6.0</div> |
---|
| 1697 | <h4>Uses routines</h4><div class="value"> Michael D. Galloy's IDLdoc. IDLdoc can be downloaded for free |
---|
| 1698 | from the RSI codebank: <code>(www.rsinc.com/codebank)</code>. |
---|
| 1699 | Also SOURCEROOT.</div> |
---|
| 1700 | <h4>Pre-condition</h4><div class="value"> IDLdoc must be in the user's path or already compiled in the |
---|
| 1701 | user's IDL session.</div> |
---|
| 1702 | |
---|
| 1703 | |
---|
| 1704 | |
---|
| 1705 | |
---|
| 1706 | |
---|
| 1707 | </div> |
---|
| 1708 | |
---|
| 1709 | </div> |
---|
| 1710 | |
---|
| 1711 | |
---|
| 1712 | |
---|
| 1713 | <div id="tagline">Produced by IDLdoc 2.0 on Sat Mar 11 21:40:01 2006.</div> |
---|
| 1714 | |
---|
| 1715 | </div> |
---|
| 1716 | |
---|
| 1717 | </body> |
---|
| 1718 | </html> |
---|