[163] | 1 | |
---|
| 2 | |
---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
---|
| 4 | <head> |
---|
| 5 | <title>cw_bgroup.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=""><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="cw_calendar.html"><img src="./../../../next.gif" border="0" alt="Next"></a></td> |
---|
| 53 | </tr> |
---|
| 54 | </table> |
---|
| 55 | |
---|
| 56 | |
---|
| 57 | <h1><font size="-2">ToBeReviewed/WIDGET/COMPOUND_WIDGET/</font></h1> |
---|
| 58 | <h2>cw_bgroup.pro</h2> |
---|
| 59 | |
---|
| 60 | <dl> |
---|
| 61 | </dl> |
---|
| 62 | |
---|
| 63 | |
---|
| 64 | |
---|
| 65 | |
---|
| 66 | |
---|
| 67 | Compound widget |
---|
| 68 | |
---|
| 69 | |
---|
| 70 | Compound widget |
---|
| 71 | |
---|
| 72 | |
---|
| 73 | CW_BGROUP is a compound widget that simplifies creating |
---|
| 74 | a base of buttons. It handles the details of creating the |
---|
| 75 | proper base (standard, exclusive, or non-exclusive) and filling |
---|
| 76 | in the desired buttons. Events for the individual buttons are |
---|
| 77 | handled transparently, and a CW_BGROUP event returned. This |
---|
| 78 | event can return any one of the following: |
---|
| 79 | - The Index of the button within the base. |
---|
| 80 | - The widget ID of the button. |
---|
| 81 | - The name of the button. |
---|
| 82 | - An arbitrary value taken from an array of User values. |
---|
| 83 | |
---|
| 84 | |
---|
| 85 | |
---|
| 86 | <h2>Routine summary</h2> |
---|
| 87 | |
---|
| 88 | <dl> |
---|
| 89 | |
---|
| 90 | <dt><a href="#_cw_bgroup_setv">cw_bgroup_setv<i>, id, value</i></a><dt> |
---|
| 91 | <dd><font size="-1"></font></dd> |
---|
| 92 | |
---|
| 93 | <dt><a href="#_cw_bgroup_getv"><i>result = </i>cw_bgroup_getv(<i>id, value</i>)</a><dt> |
---|
| 94 | <dd><font size="-1"></font></dd> |
---|
| 95 | |
---|
| 96 | <dt><a href="#_cw_bgroup_event"><i>result = </i>cw_bgroup_event(<i>ev</i>)</a><dt> |
---|
| 97 | <dd><font size="-1"></font></dd> |
---|
| 98 | |
---|
| 99 | <dt><a href="#_cw_bgroup"><i>result = </i>cw_bgroup(<i>parent, names</i>, BUTTON_UVALUE=<i>array</i>, COLUMN=<i>COLUMN</i>, EVENT_FUNCT=<i>EVENT_FUNCT</i>, EXCLUSIVE=<i>EXCLUSIVE</i>, FONT=<i>FONT</i>, FRAME=<i>FRAME</i>, IDS=<i>IDS</i>, LABEL_TOP=<i>LABEL_TOP</i>, LABEL_LEFT=<i>LABEL_LEFT</i>, MAP=<i>MAP</i>, NONEXCLUSIVE=<i>NONEXCLUSIVE</i>, NO_RELEASE=<i>NO_RELEASE</i>, RETURN_ID=<i>RETURN_ID</i>, RETURN_INDEX=<i>RETURN_INDEX</i>, RETURN_NAME=<i>RETURN_NAME</i>, ROW=<i>ROW</i>, SCROLL=<i>SCROLL</i>, SET_VALUE=<i>SET_VALUE</i>, SPACE=<i>SPACE</i>, TAB_MODE=<i>TAB_MODE</i>, UVALUE=<i>UVALUE</i>, XOFFSET=<i>XOFFSET</i>, XPAD=<i>XPAD</i>, XSIZE=<i>XSIZE</i>, X_SCROLL_SIZE=<i>X_SCROLL_SIZE</i>, YOFFSET=<i>YOFFSET</i>, YPAD=<i>YPAD</i>, YSIZE=<i>YSIZE</i>, Y_SCROLL_SIZE=<i>Y_SCROLL_SIZE</i>, UNAME=<i>UNAME</i>)</a><dt> |
---|
| 100 | <dd><font size="-1"></font></dd> |
---|
| 101 | |
---|
| 102 | </dl> |
---|
| 103 | |
---|
| 104 | <p> </p> |
---|
| 105 | |
---|
| 106 | |
---|
| 107 | |
---|
| 108 | <a name="#_cw_bgroup_setv"></a> |
---|
| 109 | |
---|
| 110 | <h2>cw_bgroup_setv <font size="-1" color="#006633"> |
---|
| 111 | Compound widget |
---|
| 112 | </font></h2> |
---|
| 113 | |
---|
| 114 | <p><font face="Courier">cw_bgroup_setv<i>, <a href="#_cw_bgroup_setv_keyword_id">id</a>, <a href="#_cw_bgroup_setv_keyword_value">value</a></i></font></p> |
---|
| 115 | |
---|
| 116 | |
---|
| 117 | |
---|
| 118 | <h3>Return value</h3> |
---|
| 119 | |
---|
| 120 | |
---|
| 121 | |
---|
| 122 | |
---|
| 123 | <h3>Parameters</h3> |
---|
| 124 | |
---|
| 125 | |
---|
| 126 | <a name="#_cw_bgroup_setv_keyword_id"></a> |
---|
| 127 | <h4>id |
---|
| 128 | |
---|
| 129 | |
---|
| 130 | |
---|
| 131 | |
---|
| 132 | |
---|
| 133 | |
---|
| 134 | |
---|
| 135 | |
---|
| 136 | </h4> |
---|
| 137 | |
---|
| 138 | |
---|
| 139 | |
---|
| 140 | |
---|
| 141 | |
---|
| 142 | |
---|
| 143 | <a name="#_cw_bgroup_setv_keyword_value"></a> |
---|
| 144 | <h4>value |
---|
| 145 | |
---|
| 146 | |
---|
| 147 | |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | |
---|
| 151 | |
---|
| 152 | |
---|
| 153 | </h4> |
---|
| 154 | |
---|
| 155 | |
---|
| 156 | It is the default tick mark value (a floating-point number). |
---|
| 157 | |
---|
| 158 | |
---|
| 159 | |
---|
| 160 | |
---|
| 161 | |
---|
| 162 | |
---|
| 163 | <h3>Examples</h3> |
---|
| 164 | |
---|
| 165 | |
---|
| 166 | <h3>Version history</h3> |
---|
| 167 | |
---|
| 168 | <h4>Version</h4> |
---|
[168] | 169 | $Id: cw_bgroup.pro 163 2006-08-29 12:59:46Z navarro $ |
---|
[163] | 170 | <h4>History</h4> |
---|
| 171 | |
---|
| 172 | |
---|
| 173 | |
---|
| 174 | |
---|
| 175 | <h3>Known issues</h3> |
---|
| 176 | |
---|
| 177 | |
---|
| 178 | |
---|
| 179 | <h4>Restrictions</h4> |
---|
| 180 | |
---|
| 181 | |
---|
| 182 | |
---|
| 183 | <h3>Other attributes</h3> |
---|
| 184 | |
---|
| 185 | |
---|
| 186 | <h4>Uses routines</h4> |
---|
| 187 | |
---|
| 188 | |
---|
| 189 | |
---|
| 190 | |
---|
| 191 | |
---|
| 192 | |
---|
| 193 | <font size="-3"><p> </p></font> |
---|
| 194 | <hr size="1" color="#CCCCCC"/> |
---|
| 195 | |
---|
| 196 | <a name="#_cw_bgroup_getv"></a> |
---|
| 197 | |
---|
| 198 | <h2>cw_bgroup_getv <font size="-1" color="#006633"> |
---|
| 199 | |
---|
| 200 | </font></h2> |
---|
| 201 | |
---|
| 202 | <p><font face="Courier"><i>result = </i>cw_bgroup_getv(<i><a href="#_cw_bgroup_getv_keyword_id">id</a>, <a href="#_cw_bgroup_getv_keyword_value">value</a></i>)</font></p> |
---|
| 203 | |
---|
| 204 | |
---|
| 205 | |
---|
| 206 | <h3>Return value</h3> |
---|
| 207 | |
---|
| 208 | |
---|
| 209 | |
---|
| 210 | |
---|
| 211 | <h3>Parameters</h3> |
---|
| 212 | |
---|
| 213 | |
---|
| 214 | <a name="#_cw_bgroup_getv_keyword_id"></a> |
---|
| 215 | <h4>id |
---|
| 216 | |
---|
| 217 | |
---|
| 218 | |
---|
| 219 | |
---|
| 220 | |
---|
| 221 | |
---|
| 222 | |
---|
| 223 | |
---|
| 224 | </h4> |
---|
| 225 | |
---|
| 226 | |
---|
| 227 | |
---|
| 228 | |
---|
| 229 | |
---|
| 230 | |
---|
| 231 | <a name="#_cw_bgroup_getv_keyword_value"></a> |
---|
| 232 | <h4>value |
---|
| 233 | |
---|
| 234 | |
---|
| 235 | |
---|
| 236 | |
---|
| 237 | |
---|
| 238 | |
---|
| 239 | |
---|
| 240 | |
---|
| 241 | </h4> |
---|
| 242 | |
---|
| 243 | |
---|
| 244 | It is the default tick mark value (a floating-point number). |
---|
| 245 | |
---|
| 246 | |
---|
| 247 | |
---|
| 248 | |
---|
| 249 | |
---|
| 250 | |
---|
| 251 | <h3>Examples</h3> |
---|
| 252 | |
---|
| 253 | |
---|
| 254 | <h3>Version history</h3> |
---|
| 255 | |
---|
| 256 | <h4>Version</h4> |
---|
[168] | 257 | $Id: cw_bgroup.pro 163 2006-08-29 12:59:46Z navarro $ |
---|
[163] | 258 | <h4>History</h4> |
---|
| 259 | |
---|
| 260 | |
---|
| 261 | |
---|
| 262 | |
---|
| 263 | <h3>Known issues</h3> |
---|
| 264 | |
---|
| 265 | |
---|
| 266 | |
---|
| 267 | <h4>Restrictions</h4> |
---|
| 268 | |
---|
| 269 | |
---|
| 270 | |
---|
| 271 | <h3>Other attributes</h3> |
---|
| 272 | |
---|
| 273 | |
---|
| 274 | <h4>Uses routines</h4> |
---|
| 275 | |
---|
| 276 | |
---|
| 277 | |
---|
| 278 | |
---|
| 279 | |
---|
| 280 | |
---|
| 281 | <font size="-3"><p> </p></font> |
---|
| 282 | <hr size="1" color="#CCCCCC"/> |
---|
| 283 | |
---|
| 284 | <a name="#_cw_bgroup_event"></a> |
---|
| 285 | |
---|
| 286 | <h2>cw_bgroup_event <font size="-1" color="#006633"> |
---|
| 287 | |
---|
| 288 | </font></h2> |
---|
| 289 | |
---|
| 290 | <p><font face="Courier"><i>result = </i>cw_bgroup_event(<i><a href="#_cw_bgroup_event_keyword_ev">ev</a></i>)</font></p> |
---|
| 291 | |
---|
| 292 | |
---|
| 293 | |
---|
| 294 | <h3>Return value</h3> |
---|
| 295 | |
---|
| 296 | |
---|
| 297 | |
---|
| 298 | |
---|
| 299 | <h3>Parameters</h3> |
---|
| 300 | |
---|
| 301 | |
---|
| 302 | <a name="#_cw_bgroup_event_keyword_ev"></a> |
---|
| 303 | <h4>ev |
---|
| 304 | |
---|
| 305 | |
---|
| 306 | |
---|
| 307 | |
---|
| 308 | |
---|
| 309 | |
---|
| 310 | |
---|
| 311 | |
---|
| 312 | </h4> |
---|
| 313 | |
---|
| 314 | |
---|
| 315 | |
---|
| 316 | |
---|
| 317 | |
---|
| 318 | |
---|
| 319 | |
---|
| 320 | |
---|
| 321 | |
---|
| 322 | <h3>Examples</h3> |
---|
| 323 | |
---|
| 324 | |
---|
| 325 | <h3>Version history</h3> |
---|
| 326 | |
---|
| 327 | <h4>Version</h4> |
---|
[168] | 328 | $Id: cw_bgroup.pro 163 2006-08-29 12:59:46Z navarro $ |
---|
[163] | 329 | <h4>History</h4> |
---|
| 330 | |
---|
| 331 | |
---|
| 332 | |
---|
| 333 | |
---|
| 334 | <h3>Known issues</h3> |
---|
| 335 | |
---|
| 336 | |
---|
| 337 | |
---|
| 338 | <h4>Restrictions</h4> |
---|
| 339 | |
---|
| 340 | |
---|
| 341 | |
---|
| 342 | <h3>Other attributes</h3> |
---|
| 343 | |
---|
| 344 | |
---|
| 345 | <h4>Uses routines</h4> |
---|
| 346 | |
---|
| 347 | |
---|
| 348 | |
---|
| 349 | |
---|
| 350 | |
---|
| 351 | |
---|
| 352 | <font size="-3"><p> </p></font> |
---|
| 353 | <hr size="1" color="#CCCCCC"/> |
---|
| 354 | |
---|
| 355 | <a name="#_cw_bgroup"></a> |
---|
| 356 | |
---|
| 357 | <h2>cw_bgroup <font size="-1" color="#006633"> |
---|
| 358 | Compound widget |
---|
| 359 | </font></h2> |
---|
| 360 | |
---|
| 361 | <p><font face="Courier"><i>result = </i>cw_bgroup(<i><a href="#_cw_bgroup_keyword_parent">parent</a>, <a href="#_cw_bgroup_keyword_names">names</a></i>, <a href="#_cw_bgroup_keyword_BUTTON_UVALUE">BUTTON_UVALUE</a>=<i>array</i>, <a href="#_cw_bgroup_keyword_COLUMN">COLUMN</a>=<i>COLUMN</i>, <a href="#_cw_bgroup_keyword_EVENT_FUNCT">EVENT_FUNCT</a>=<i>EVENT_FUNCT</i>, <a href="#_cw_bgroup_keyword_EXCLUSIVE">EXCLUSIVE</a>=<i>EXCLUSIVE</i>, <a href="#_cw_bgroup_keyword_FONT">FONT</a>=<i>FONT</i>, <a href="#_cw_bgroup_keyword_FRAME">FRAME</a>=<i>FRAME</i>, <a href="#_cw_bgroup_keyword_IDS">IDS</a>=<i>IDS</i>, <a href="#_cw_bgroup_keyword_LABEL_TOP">LABEL_TOP</a>=<i>LABEL_TOP</i>, <a href="#_cw_bgroup_keyword_LABEL_LEFT">LABEL_LEFT</a>=<i>LABEL_LEFT</i>, <a href="#_cw_bgroup_keyword_MAP">MAP</a>=<i>MAP</i>, <a href="#_cw_bgroup_keyword_NONEXCLUSIVE">NONEXCLUSIVE</a>=<i>NONEXCLUSIVE</i>, <a href="#_cw_bgroup_keyword_NO_RELEASE">NO_RELEASE</a>=<i>NO_RELEASE</i>, <a href="#_cw_bgroup_keyword_RETURN_ID">RETURN_ID</a>=<i>RETURN_ID</i>, <a href="#_cw_bgroup_keyword_RETURN_INDEX">RETURN_INDEX</a>=<i>RETURN_INDEX</i>, <a href="#_cw_bgroup_keyword_RETURN_NAME">RETURN_NAME</a>=<i>RETURN_NAME</i>, <a href="#_cw_bgroup_keyword_ROW">ROW</a>=<i>ROW</i>, <a href="#_cw_bgroup_keyword_SCROLL">SCROLL</a>=<i>SCROLL</i>, <a href="#_cw_bgroup_keyword_SET_VALUE">SET_VALUE</a>=<i>SET_VALUE</i>, <a href="#_cw_bgroup_keyword_SPACE">SPACE</a>=<i>SPACE</i>, <a href="#_cw_bgroup_keyword_TAB_MODE">TAB_MODE</a>=<i>TAB_MODE</i>, <a href="#_cw_bgroup_keyword_UVALUE">UVALUE</a>=<i>UVALUE</i>, <a href="#_cw_bgroup_keyword_XOFFSET">XOFFSET</a>=<i>XOFFSET</i>, <a href="#_cw_bgroup_keyword_XPAD">XPAD</a>=<i>XPAD</i>, <a href="#_cw_bgroup_keyword_XSIZE">XSIZE</a>=<i>XSIZE</i>, <a href="#_cw_bgroup_keyword_X_SCROLL_SIZE">X_SCROLL_SIZE</a>=<i>X_SCROLL_SIZE</i>, <a href="#_cw_bgroup_keyword_YOFFSET">YOFFSET</a>=<i>YOFFSET</i>, <a href="#_cw_bgroup_keyword_YPAD">YPAD</a>=<i>YPAD</i>, <a href="#_cw_bgroup_keyword_YSIZE">YSIZE</a>=<i>YSIZE</i>, <a href="#_cw_bgroup_keyword_Y_SCROLL_SIZE">Y_SCROLL_SIZE</a>=<i>Y_SCROLL_SIZE</i>, <a href="#_cw_bgroup_keyword_UNAME">UNAME</a>=<i>UNAME</i>)</font></p> |
---|
| 362 | |
---|
| 363 | |
---|
| 364 | |
---|
| 365 | <h3>Return value</h3> |
---|
| 366 | The ID of the created widget is returned. |
---|
| 367 | |
---|
| 368 | |
---|
| 369 | |
---|
| 370 | <h3>Parameters</h3> |
---|
| 371 | |
---|
| 372 | |
---|
| 373 | <a name="#_cw_bgroup_keyword_parent"></a> |
---|
| 374 | <h4>parent |
---|
| 375 | <font size="-1" color="#006633">in</font> |
---|
| 376 | |
---|
| 377 | |
---|
| 378 | <font size="-1" color="#006633">required</font> |
---|
| 379 | |
---|
| 380 | |
---|
| 381 | |
---|
| 382 | |
---|
| 383 | </h4> |
---|
| 384 | |
---|
| 385 | |
---|
| 386 | The ID of the parent widget. |
---|
| 387 | |
---|
| 388 | |
---|
| 389 | |
---|
| 390 | <a name="#_cw_bgroup_keyword_names"></a> |
---|
| 391 | <h4>names |
---|
| 392 | |
---|
| 393 | |
---|
| 394 | |
---|
| 395 | |
---|
| 396 | |
---|
| 397 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string array</i></font> |
---|
| 398 | |
---|
| 399 | |
---|
| 400 | </h4> |
---|
| 401 | |
---|
| 402 | |
---|
| 403 | A string array, containing one string per button, |
---|
| 404 | giving the name of each button. |
---|
| 405 | |
---|
| 406 | |
---|
| 407 | |
---|
| 408 | |
---|
| 409 | |
---|
| 410 | <h3>Keywords</h3> |
---|
| 411 | |
---|
| 412 | |
---|
| 413 | <a name="#_cw_bgroup_keyword_BUTTON_UVALUE"></a> |
---|
| 414 | <h4>BUTTON_UVALUE |
---|
| 415 | |
---|
| 416 | |
---|
| 417 | |
---|
| 418 | |
---|
| 419 | |
---|
| 420 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>array</i></font> |
---|
| 421 | |
---|
| 422 | |
---|
| 423 | </h4> |
---|
| 424 | |
---|
| 425 | |
---|
| 426 | An array of user values to be associated with |
---|
| 427 | each button and returned in the event structure. |
---|
| 428 | |
---|
| 429 | |
---|
| 430 | <a name="#_cw_bgroup_keyword_COLUMN"></a> |
---|
| 431 | <h4>COLUMN |
---|
| 432 | |
---|
| 433 | |
---|
| 434 | |
---|
| 435 | |
---|
| 436 | |
---|
| 437 | |
---|
| 438 | |
---|
| 439 | |
---|
| 440 | </h4> |
---|
| 441 | |
---|
| 442 | |
---|
| 443 | Buttons will be arranged in the number of columns |
---|
| 444 | specified by this keyword. |
---|
| 445 | |
---|
| 446 | |
---|
| 447 | <a name="#_cw_bgroup_keyword_EVENT_FUNCT"></a> |
---|
| 448 | <h4>EVENT_FUNCT |
---|
| 449 | |
---|
| 450 | |
---|
| 451 | |
---|
| 452 | |
---|
| 453 | |
---|
| 454 | |
---|
| 455 | |
---|
| 456 | |
---|
| 457 | </h4> |
---|
| 458 | |
---|
| 459 | |
---|
| 460 | The name of an optional user-supplied event function |
---|
| 461 | for buttons. This function is called with the return |
---|
| 462 | value structure whenever a button is pressed, and |
---|
| 463 | follows the conventions for user-written event functions. |
---|
| 464 | |
---|
| 465 | |
---|
| 466 | <a name="#_cw_bgroup_keyword_EXCLUSIVE"></a> |
---|
| 467 | <h4>EXCLUSIVE |
---|
| 468 | |
---|
| 469 | |
---|
| 470 | |
---|
| 471 | |
---|
| 472 | |
---|
| 473 | |
---|
| 474 | |
---|
| 475 | |
---|
| 476 | </h4> |
---|
| 477 | |
---|
| 478 | |
---|
| 479 | Buttons will be placed in an exclusive base, with |
---|
| 480 | only one button allowed to be selected at a time. |
---|
| 481 | |
---|
| 482 | |
---|
| 483 | <a name="#_cw_bgroup_keyword_FONT"></a> |
---|
| 484 | <h4>FONT |
---|
| 485 | |
---|
| 486 | |
---|
| 487 | |
---|
| 488 | |
---|
| 489 | |
---|
| 490 | |
---|
| 491 | |
---|
| 492 | |
---|
| 493 | </h4> |
---|
| 494 | |
---|
| 495 | |
---|
| 496 | The name of the font to be used for the button |
---|
| 497 | titles. If this keyword is not specified, the default |
---|
| 498 | font is used. |
---|
| 499 | |
---|
| 500 | |
---|
| 501 | <a name="#_cw_bgroup_keyword_FRAME"></a> |
---|
| 502 | <h4>FRAME |
---|
| 503 | |
---|
| 504 | |
---|
| 505 | |
---|
| 506 | |
---|
| 507 | |
---|
| 508 | |
---|
| 509 | |
---|
| 510 | |
---|
| 511 | </h4> |
---|
| 512 | |
---|
| 513 | |
---|
| 514 | Specifies the width of the frame to be drawn around the base. |
---|
| 515 | |
---|
| 516 | |
---|
| 517 | <a name="#_cw_bgroup_keyword_IDS"></a> |
---|
| 518 | <h4>IDS |
---|
| 519 | |
---|
| 520 | |
---|
| 521 | |
---|
| 522 | |
---|
| 523 | |
---|
| 524 | |
---|
| 525 | |
---|
| 526 | |
---|
| 527 | </h4> |
---|
| 528 | |
---|
| 529 | |
---|
| 530 | A named variable into which the button IDs will be |
---|
| 531 | stored, as a longword vector. |
---|
| 532 | |
---|
| 533 | |
---|
| 534 | <a name="#_cw_bgroup_keyword_LABEL_TOP"></a> |
---|
| 535 | <h4>LABEL_TOP |
---|
| 536 | |
---|
| 537 | |
---|
| 538 | |
---|
| 539 | |
---|
| 540 | |
---|
| 541 | |
---|
| 542 | |
---|
| 543 | |
---|
| 544 | </h4> |
---|
| 545 | |
---|
| 546 | |
---|
| 547 | Creates a text label above the buttons. |
---|
| 548 | |
---|
| 549 | |
---|
| 550 | <a name="#_cw_bgroup_keyword_LABEL_LEFT"></a> |
---|
| 551 | <h4>LABEL_LEFT |
---|
| 552 | |
---|
| 553 | |
---|
| 554 | |
---|
| 555 | |
---|
| 556 | |
---|
| 557 | |
---|
| 558 | |
---|
| 559 | |
---|
| 560 | </h4> |
---|
| 561 | |
---|
| 562 | |
---|
| 563 | Creates a text label to the left of the buttons. |
---|
| 564 | |
---|
| 565 | |
---|
| 566 | <a name="#_cw_bgroup_keyword_MAP"></a> |
---|
| 567 | <h4>MAP |
---|
| 568 | |
---|
| 569 | |
---|
| 570 | |
---|
| 571 | |
---|
| 572 | |
---|
| 573 | |
---|
| 574 | |
---|
| 575 | |
---|
| 576 | </h4> |
---|
| 577 | |
---|
| 578 | |
---|
| 579 | If set, the base will be mapped when the widget |
---|
| 580 | is realized (the default). |
---|
| 581 | |
---|
| 582 | |
---|
| 583 | <a name="#_cw_bgroup_keyword_NONEXCLUSIVE"></a> |
---|
| 584 | <h4>NONEXCLUSIVE |
---|
| 585 | |
---|
| 586 | |
---|
| 587 | |
---|
| 588 | |
---|
| 589 | |
---|
| 590 | |
---|
| 591 | |
---|
| 592 | |
---|
| 593 | </h4> |
---|
| 594 | |
---|
| 595 | |
---|
| 596 | Buttons will be placed in an non-exclusive base. |
---|
| 597 | The buttons will be independent. |
---|
| 598 | |
---|
| 599 | |
---|
| 600 | <a name="#_cw_bgroup_keyword_NO_RELEASE"></a> |
---|
| 601 | <h4>NO_RELEASE |
---|
| 602 | |
---|
| 603 | |
---|
| 604 | |
---|
| 605 | |
---|
| 606 | |
---|
| 607 | |
---|
| 608 | |
---|
| 609 | |
---|
| 610 | </h4> |
---|
| 611 | |
---|
| 612 | |
---|
| 613 | If set, button release events will not be returned. |
---|
| 614 | |
---|
| 615 | |
---|
| 616 | <a name="#_cw_bgroup_keyword_RETURN_ID"></a> |
---|
| 617 | <h4>RETURN_ID |
---|
| 618 | |
---|
| 619 | |
---|
| 620 | |
---|
| 621 | |
---|
| 622 | |
---|
| 623 | |
---|
| 624 | |
---|
| 625 | |
---|
| 626 | </h4> |
---|
| 627 | |
---|
| 628 | |
---|
| 629 | If set, the VALUE field of returned events will be |
---|
| 630 | the widget ID of the button. |
---|
| 631 | |
---|
| 632 | |
---|
| 633 | <a name="#_cw_bgroup_keyword_RETURN_INDEX"></a> |
---|
| 634 | <h4>RETURN_INDEX |
---|
| 635 | |
---|
| 636 | |
---|
| 637 | |
---|
| 638 | |
---|
| 639 | |
---|
| 640 | |
---|
| 641 | |
---|
| 642 | |
---|
| 643 | </h4> |
---|
| 644 | |
---|
| 645 | |
---|
| 646 | If set, the VALUE field of returned events will be |
---|
| 647 | the zero-based index of the button within the base. |
---|
| 648 | THIS IS THE DEFAULT. |
---|
| 649 | |
---|
| 650 | |
---|
| 651 | <a name="#_cw_bgroup_keyword_RETURN_NAME"></a> |
---|
| 652 | <h4>RETURN_NAME |
---|
| 653 | |
---|
| 654 | |
---|
| 655 | |
---|
| 656 | |
---|
| 657 | |
---|
| 658 | |
---|
| 659 | |
---|
| 660 | |
---|
| 661 | </h4> |
---|
| 662 | |
---|
| 663 | |
---|
| 664 | If set, the VALUE field of returned events will be |
---|
| 665 | the name of the button within the base. |
---|
| 666 | |
---|
| 667 | |
---|
| 668 | <a name="#_cw_bgroup_keyword_ROW"></a> |
---|
| 669 | <h4>ROW |
---|
| 670 | |
---|
| 671 | |
---|
| 672 | |
---|
| 673 | |
---|
| 674 | |
---|
| 675 | |
---|
| 676 | |
---|
| 677 | |
---|
| 678 | </h4> |
---|
| 679 | |
---|
| 680 | |
---|
| 681 | Buttons will be arranged in the number of rows |
---|
| 682 | specified by this keyword. |
---|
| 683 | |
---|
| 684 | |
---|
| 685 | <a name="#_cw_bgroup_keyword_SCROLL"></a> |
---|
| 686 | <h4>SCROLL |
---|
| 687 | |
---|
| 688 | |
---|
| 689 | |
---|
| 690 | |
---|
| 691 | |
---|
| 692 | |
---|
| 693 | |
---|
| 694 | |
---|
| 695 | </h4> |
---|
| 696 | |
---|
| 697 | |
---|
| 698 | If set, the base will include scroll bars to allow |
---|
| 699 | viewing a large base through a smaller viewport. |
---|
| 700 | |
---|
| 701 | |
---|
| 702 | <a name="#_cw_bgroup_keyword_SET_VALUE"></a> |
---|
| 703 | <h4>SET_VALUE |
---|
| 704 | |
---|
| 705 | |
---|
| 706 | |
---|
| 707 | |
---|
| 708 | |
---|
| 709 | |
---|
| 710 | |
---|
| 711 | |
---|
| 712 | </h4> |
---|
| 713 | |
---|
| 714 | |
---|
| 715 | The initial value of the buttons. This is equivalent |
---|
| 716 | to the later statement: |
---|
| 717 | |
---|
| 718 | WIDGET_CONTROL, widget, set_value=value |
---|
| 719 | |
---|
| 720 | |
---|
| 721 | <a name="#_cw_bgroup_keyword_SPACE"></a> |
---|
| 722 | <h4>SPACE |
---|
| 723 | |
---|
| 724 | |
---|
| 725 | |
---|
| 726 | |
---|
| 727 | |
---|
| 728 | |
---|
| 729 | |
---|
| 730 | |
---|
| 731 | </h4> |
---|
| 732 | |
---|
| 733 | |
---|
| 734 | The space, in pixels, to be left around the edges |
---|
| 735 | of a row or column major base. This keyword is |
---|
| 736 | ignored if EXCLUSIVE or NONEXCLUSIVE are specified. |
---|
| 737 | |
---|
| 738 | |
---|
| 739 | <a name="#_cw_bgroup_keyword_TAB_MODE"></a> |
---|
| 740 | <h4>TAB_MODE |
---|
| 741 | |
---|
| 742 | |
---|
| 743 | |
---|
| 744 | |
---|
| 745 | |
---|
| 746 | |
---|
| 747 | |
---|
| 748 | |
---|
| 749 | </h4> |
---|
| 750 | |
---|
| 751 | |
---|
| 752 | |
---|
| 753 | <a name="#_cw_bgroup_keyword_UVALUE"></a> |
---|
| 754 | <h4>UVALUE |
---|
| 755 | |
---|
| 756 | |
---|
| 757 | |
---|
| 758 | |
---|
| 759 | |
---|
| 760 | |
---|
| 761 | |
---|
| 762 | |
---|
| 763 | </h4> |
---|
| 764 | |
---|
| 765 | |
---|
| 766 | The user value to be associated with the widget. |
---|
| 767 | |
---|
| 768 | |
---|
| 769 | <a name="#_cw_bgroup_keyword_XOFFSET"></a> |
---|
| 770 | <h4>XOFFSET |
---|
| 771 | |
---|
| 772 | |
---|
| 773 | |
---|
| 774 | |
---|
| 775 | |
---|
| 776 | |
---|
| 777 | |
---|
| 778 | |
---|
| 779 | </h4> |
---|
| 780 | |
---|
| 781 | |
---|
| 782 | The X offset of the widget relative to its parent. |
---|
| 783 | |
---|
| 784 | |
---|
| 785 | <a name="#_cw_bgroup_keyword_XPAD"></a> |
---|
| 786 | <h4>XPAD |
---|
| 787 | |
---|
| 788 | |
---|
| 789 | |
---|
| 790 | |
---|
| 791 | |
---|
| 792 | |
---|
| 793 | |
---|
| 794 | |
---|
| 795 | </h4> |
---|
| 796 | |
---|
| 797 | |
---|
| 798 | The horizontal space, in pixels, between children |
---|
| 799 | of a row or column major base. Ignored if EXCLUSIVE |
---|
| 800 | or NONEXCLUSIVE are specified. |
---|
| 801 | |
---|
| 802 | |
---|
| 803 | <a name="#_cw_bgroup_keyword_XSIZE"></a> |
---|
| 804 | <h4>XSIZE |
---|
| 805 | |
---|
| 806 | |
---|
| 807 | |
---|
| 808 | |
---|
| 809 | |
---|
| 810 | |
---|
| 811 | |
---|
| 812 | |
---|
| 813 | </h4> |
---|
| 814 | |
---|
| 815 | |
---|
| 816 | The width of the base. |
---|
| 817 | |
---|
| 818 | <a name="#_cw_bgroup_keyword_X_SCROLL_SIZE"></a> |
---|
| 819 | <h4>X_SCROLL_SIZE |
---|
| 820 | |
---|
| 821 | |
---|
| 822 | |
---|
| 823 | |
---|
| 824 | |
---|
| 825 | |
---|
| 826 | |
---|
| 827 | |
---|
| 828 | </h4> |
---|
| 829 | |
---|
| 830 | |
---|
| 831 | The width of the viewport if SCROLL is specified. |
---|
| 832 | |
---|
| 833 | |
---|
| 834 | <a name="#_cw_bgroup_keyword_YOFFSET"></a> |
---|
| 835 | <h4>YOFFSET |
---|
| 836 | |
---|
| 837 | |
---|
| 838 | |
---|
| 839 | |
---|
| 840 | |
---|
| 841 | |
---|
| 842 | |
---|
| 843 | |
---|
| 844 | </h4> |
---|
| 845 | |
---|
| 846 | |
---|
| 847 | The Y offset of the widget relative to its parent. |
---|
| 848 | |
---|
| 849 | |
---|
| 850 | <a name="#_cw_bgroup_keyword_YPAD"></a> |
---|
| 851 | <h4>YPAD |
---|
| 852 | |
---|
| 853 | |
---|
| 854 | |
---|
| 855 | |
---|
| 856 | |
---|
| 857 | |
---|
| 858 | |
---|
| 859 | |
---|
| 860 | </h4> |
---|
| 861 | |
---|
| 862 | |
---|
| 863 | The vertical space, in pixels, between children of |
---|
| 864 | a row or column major base. Ignored if EXCLUSIVE |
---|
| 865 | or NONEXCLUSIVE are specified. |
---|
| 866 | |
---|
| 867 | |
---|
| 868 | <a name="#_cw_bgroup_keyword_YSIZE"></a> |
---|
| 869 | <h4>YSIZE |
---|
| 870 | |
---|
| 871 | |
---|
| 872 | |
---|
| 873 | |
---|
| 874 | |
---|
| 875 | |
---|
| 876 | |
---|
| 877 | |
---|
| 878 | </h4> |
---|
| 879 | |
---|
| 880 | |
---|
| 881 | The height of the base. |
---|
| 882 | |
---|
| 883 | |
---|
| 884 | <a name="#_cw_bgroup_keyword_Y_SCROLL_SIZE"></a> |
---|
| 885 | <h4>Y_SCROLL_SIZE |
---|
| 886 | |
---|
| 887 | |
---|
| 888 | |
---|
| 889 | |
---|
| 890 | |
---|
| 891 | |
---|
| 892 | |
---|
| 893 | |
---|
| 894 | </h4> |
---|
| 895 | |
---|
| 896 | |
---|
| 897 | The height of the viewport if SCROLL is specified. |
---|
| 898 | |
---|
| 899 | |
---|
| 900 | <a name="#_cw_bgroup_keyword_UNAME"></a> |
---|
| 901 | <h4>UNAME |
---|
| 902 | |
---|
| 903 | |
---|
| 904 | |
---|
| 905 | |
---|
| 906 | |
---|
| 907 | |
---|
| 908 | |
---|
| 909 | |
---|
| 910 | </h4> |
---|
| 911 | |
---|
| 912 | |
---|
| 913 | The user name to be associated with the widget. |
---|
| 914 | |
---|
| 915 | |
---|
| 916 | |
---|
| 917 | |
---|
| 918 | |
---|
| 919 | <h3>Version history</h3> |
---|
| 920 | |
---|
| 921 | <h4>Version</h4> |
---|
[168] | 922 | $Id: cw_bgroup.pro 163 2006-08-29 12:59:46Z navarro $ |
---|
[163] | 923 | |
---|
| 924 | <h4>History</h4> |
---|
| 925 | 15 June 1992, AB |
---|
| 926 | 7 April 1993, AB, Removed state caching. |
---|
| 927 | 6 Oct. 1994, KDB, Font keyword is not applied to the label. |
---|
| 928 | 10 FEB 1995, DJC fixed bad bug in event procedure, getting |
---|
| 929 | id of stash widget. |
---|
| 930 | 11 April 1995, AB Removed Motif special cases. |
---|
| 931 | |
---|
| 932 | Copyright (c) 1992-2005, Research Systems, Inc. All rights reserved. |
---|
| 933 | Unauthorized reproduction prohibited. |
---|
| 934 | |
---|
| 935 | |
---|
| 936 | |
---|
| 937 | <h3>Known issues</h3> |
---|
| 938 | |
---|
| 939 | |
---|
| 940 | |
---|
| 941 | <h4>Restrictions</h4> |
---|
| 942 | This widget generates event structures with the following definition: |
---|
| 943 | |
---|
| 944 | event = { ID:0L, TOP:0L, HANDLER:0L, SELECT:0, VALUE:0 } |
---|
| 945 | |
---|
| 946 | The SELECT field is passed through from the button event. VALUE is |
---|
| 947 | either the INDEX, ID, NAME, or BUTTON_UVALUE of the button, |
---|
| 948 | depending on how the widget was created. |
---|
| 949 | |
---|
| 950 | |
---|
| 951 | Only buttons with textual names are handled by this widget. |
---|
| 952 | Bitmaps are not understood. |
---|
| 953 | |
---|
| 954 | |
---|
| 955 | |
---|
| 956 | |
---|
| 957 | |
---|
| 958 | |
---|
| 959 | |
---|
| 960 | |
---|
| 961 | |
---|
| 962 | |
---|
| 963 | <font size="-3"><p> </p></font> |
---|
| 964 | <hr size="1" color="#CCCCCC"/> |
---|
| 965 | |
---|
| 966 | |
---|
| 967 | |
---|
| 968 | |
---|
[187] | 969 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
---|
[163] | 970 | |
---|
| 971 | </body> |
---|
| 972 | </html> |
---|