/usr/share/doc/libxaw7-dev/Scrollbar.xml is in libxaw-doc 2:1.0.13-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 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 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 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 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 | <sect1 id="Scrollbar_Widget">
<title>Scrollbar Widget</title>
<literallayout class="monospaced">
Application header file <X11/Xaw/Scrollbar.h>
Class header file <X11/Xaw/ScrollbarP.h>
Class scrollbarWidgetClass
Class Name Scrollbar
Superclass Simple
</literallayout>
<para>
A Scrollbar widget is a rectangle, called the ``canvas,'' on
which another rectangle, the ``thumb,'' moves in one
dimension, either vertically or horizontally. A Scrollbar
can be used alone, as a value generator, or it can be used
within a composite widget (for example, a Viewport). When a
Scrollbar is used to move, or ``scroll,'' the contents of
another widget, the size and the position of the thumb usually give
feedback as to what portion of the other widget's contents
are visible.
</para>
<para>
Each pointer button invokes a specific action. Pointer
buttons 1 and 3 do not move the thumb automatically.
Instead, they return the pixel position of the cursor on the
scroll region. When pointer button 2 is clicked, the thumb
moves to the current pointer position. When pointer button
2 is held down and the pointer is moved, the thumb follows
the pointer.
</para>
<para>
The pointer cursor in the scroll region changes depending on the current
action. When no pointer button is pressed, the cursor appears as a
double-headed arrow that points in the direction that scrolling can
occur. When pointer button 1 or 3 is pressed, the cursor appears as a
single-headed arrow that points in the logical direction that the thumb
will move. When pointer button 2 is pressed, the cursor
appears as an arrow that points to the top or the left of the thumb.
</para>
<para>
When the user scrolls, the application receives notification
through callback procedures. For both discrete scrolling actions, the
callback returns the Scrollbar widget, the client_data, and the pixel
position of the pointer when the button was released. For continuous
scrolling, the callback routine returns the scroll bar widget, the
client data, and the current relative position of the thumb. When the
thumb is moved using pointer button 2, the callback procedure is invoked
continuously. When either button 1 or 3 is pressed, the callback
procedure is invoked only when the button is released and the client
callback procedure is responsible for moving the thumb.
</para>
<sect2 id='Scrollbar::Resources'>
<title>Resources</title>
<para>
When creating a Scrollbar widget instance, the following resources are
retrieved from the argument list or from the resource database:
</para>
<informaltable>
<tgroup cols='5' align='center'>
<colspec colname='c1'/>
<colspec colname='c2'/>
<colspec colname='c3'/>
<colspec colname='c4'/>
<colspec colname='c5'/>
<thead>
<row>
<entry>Name</entry>
<entry>Class</entry>
<entry>Type</entry>
<entry>Notes</entry>
<entry>Default Value</entry>
</row>
</thead>
<tbody>
<row>
<entry>accelerators</entry>
<entry>Accelerators</entry>
<entry>AcceleratorTable</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>ancestorSensitive</entry>
<entry>AncestorSensitive</entry>
<entry>Boolean</entry>
<entry>D</entry>
<entry>True</entry>
</row>
<row>
<entry>background</entry>
<entry>Background</entry>
<entry>Pixel</entry>
<entry></entry>
<entry>XtDefaultBackground</entry>
</row>
<row>
<entry>backgroundPixmap</entry>
<entry>Pixmap</entry>
<entry>Pixmap</entry>
<entry></entry>
<entry>XtUnspecifiedPixmap</entry>
</row>
<row>
<entry>borderColor</entry>
<entry>BorderColor</entry>
<entry>Pixel</entry>
<entry></entry>
<entry>XtDefaultForeground</entry>
</row>
<row>
<entry>borderPixmap</entry>
<entry>Pixmap</entry>
<entry>Pixmap</entry>
<entry></entry>
<entry>XtUnspecifiedPixmap</entry>
</row>
<row>
<entry>borderWidth</entry>
<entry>BorderWidth</entry>
<entry>Dimension</entry>
<entry></entry>
<entry>1</entry>
</row>
<row>
<entry>colormap</entry>
<entry>Colormap</entry>
<entry>Colormap</entry>
<entry></entry>
<entry>parent's Colormap</entry>
</row>
<row>
<entry>cursor</entry>
<entry>Cursor</entry>
<entry>Cursor</entry>
<entry></entry>
<entry>None</entry>
</row>
<row>
<entry>cursorName</entry>
<entry>Cursor</entry>
<entry>String</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>depth</entry>
<entry>Depth</entry>
<entry>int</entry>
<entry>C</entry>
<entry>parent's Depth</entry>
</row>
<row>
<entry>destroyCallback</entry>
<entry>Callback</entry>
<entry>XtCallbackList</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>foreground</entry>
<entry>Foreground</entry>
<entry>Pixel</entry>
<entry></entry>
<entry>XtDefaultForeground</entry>
</row>
<row>
<entry>height</entry>
<entry>Height</entry>
<entry>Dimension</entry>
<entry>A</entry>
<entry>depends on orientation</entry>
</row>
<row>
<entry>insensitiveBorder</entry>
<entry>Insensitive</entry>
<entry>Pixmap</entry>
<entry></entry>
<entry>GreyPixmap</entry>
</row>
<row>
<entry>international</entry>
<entry>International</entry>
<entry>Boolean</entry>
<entry>C</entry>
<entry>False</entry>
</row>
<row>
<entry>jumpProc</entry>
<entry>Callback</entry>
<entry>XtCallbackList</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>length</entry>
<entry>Length</entry>
<entry>Dimension</entry>
<entry></entry>
<entry>1</entry>
</row>
<row>
<entry>mappedWhenManaged</entry>
<entry>MappedWhenManaged</entry>
<entry>Boolean</entry>
<entry></entry>
<entry>True</entry>
</row>
<row>
<entry>minimumThumb</entry>
<entry>MinimumThumb</entry>
<entry>Dimension</entry>
<entry></entry>
<entry>7</entry>
</row>
<row>
<entry>orientation</entry>
<entry>Orientation</entry>
<entry>Orientation</entry>
<entry></entry>
<entry>XtorientVertical (vertical)</entry>
</row>
<row>
<entry>pointerColor</entry>
<entry>Foreground</entry>
<entry>Pixel</entry>
<entry></entry>
<entry>XtDefaultForeground</entry>
</row>
<row>
<entry>pointerColorBackground</entry>
<entry>Background</entry>
<entry>Pixel</entry>
<entry></entry>
<entry>XtDefaultBackground</entry>
</row>
<row>
<entry>screen</entry>
<entry>Screen</entry>
<entry>Screen</entry>
<entry>R</entry>
<entry>parent's Screen</entry>
</row>
<row>
<entry>scrollDCursor</entry>
<entry>Cursor</entry>
<entry>Cursor</entry>
<entry></entry>
<entry>XC_sb_down_arrow</entry>
</row>
<row>
<entry>scrollHCursor</entry>
<entry>Cursor</entry>
<entry>Cursor</entry>
<entry></entry>
<entry>XC_sb_h_double_arrow</entry>
</row>
<row>
<entry>scrollLCursor</entry>
<entry>Cursor</entry>
<entry>Cursor</entry>
<entry></entry>
<entry>XC_sb_left_arrow</entry>
</row>
<row>
<entry>scrollProc</entry>
<entry>Callback</entry>
<entry>XtCallbackList</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>scrollRCursor</entry>
<entry>Cursor</entry>
<entry>Cursor</entry>
<entry></entry>
<entry>XC_sb_right_arrow</entry>
</row>
<row>
<entry>scrollUCursor</entry>
<entry>Cursor</entry>
<entry>Cursor</entry>
<entry></entry>
<entry>XC_sb_up_arrow</entry>
</row>
<row>
<entry>scrollVCursor</entry>
<entry>Cursor</entry>
<entry>Cursor</entry>
<entry></entry>
<entry>XC_sb_v_arrow</entry>
</row>
<row>
<entry>sensitive</entry>
<entry>Sensitive</entry>
<entry>Boolean</entry>
<entry></entry>
<entry>True</entry>
</row>
<row>
<entry>shown</entry>
<entry>Shown</entry>
<entry>Float</entry>
<entry></entry>
<entry>0.0</entry>
</row>
<row>
<entry>thickness</entry>
<entry>Thickness</entry>
<entry>Dimension</entry>
<entry></entry>
<entry>14</entry>
</row>
<row>
<entry>thumb</entry>
<entry>Thumb</entry>
<entry>Bitmap</entry>
<entry></entry>
<entry>GreyPixmap</entry>
</row>
<row>
<entry>thumbProc</entry>
<entry>Callback</entry>
<entry>XtCallbackList</entry>
<entry></entry>
<entry>NULL</entry>
</row>
<row>
<entry>topOfThumb</entry>
<entry>TopOfThumb</entry>
<entry>Float</entry>
<entry></entry>
<entry>0.0</entry>
</row>
<row>
<entry>translations</entry>
<entry>Translations</entry>
<entry>TranslationTable</entry>
<entry></entry>
<entry>See below</entry>
</row>
<row>
<entry>width</entry>
<entry>Width</entry>
<entry>Dimension</entry>
<entry>A</entry>
<entry>depends on orientation</entry>
</row>
<row>
<entry>x</entry>
<entry>Position</entry>
<entry>Position</entry>
<entry></entry>
<entry>0</entry>
</row>
<row>
<entry>y</entry>
<entry>Position</entry>
<entry>Position</entry>
<entry></entry>
<entry>0</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<variablelist>
<varlistentry>
<term>
<function>foreground</function>
</term>
<listitem>
<para>
A pixel value which indexes the widget's colormap to derive the color
used to draw the thumb.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>jumpProc</function>
</term>
<listitem>
<para>
All functions on this callback list are called when the
<function>NotifyThumb</function> action is invoked. See the <function>Scrollbar
Actions</function> section for details.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>length</function>
</term>
<listitem>
<para>
The height of a vertical scrollbar or the width of a horizontal scrollbar.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>minimumThumb</function>
</term>
<listitem>
<para>
The smallest size, in pixels, to which the thumb can shrink.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>orientation</function>
</term>
<listitem>
<para>
The orientation is the direction that the thumb will be allowed to move.
This value can be either <function>XtorientVertical</function> or
<function>XtorientHorizontal</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>scrollDCursor</function>
</term>
<listitem>
<para>
This cursor is used when scrolling backward in a vertical scrollbar.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>scrollHCursor</function>
</term>
<listitem>
<para>
This cursor is used when a horizontal scrollbar is inactive.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>scrollLCursor</function>
</term>
<listitem>
<para>
This cursor is used when scrolling forward in a horizontal scrollbar.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>scrollProc</function>
</term>
<listitem>
<para>
All functions on this callback list may be called when the
<function>NotifyScroll</function> action is invoked. See the \fBScrollbar
Actions\fP section for details.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>scrollRCursor</function>
</term>
<listitem>
<para>
This cursor is used when scrolling backward in a horizontal scrollbar,
or when thumbing a vertical scrollbar.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>scrollUCursor</function>
</term>
<listitem>
<para>
This cursor is used when scrolling forward in a vertical scrollbar, or when
thumbing a horizontal scrollbar.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>scrollVCursor</function>
</term>
<listitem>
<para>
This cursor is used when a vertical scrollbar is inactive.
<!-- .Se -->
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>shown</function>
</term>
<listitem>
<para>
This is the size of the thumb, expressed as a percentage (0.0 - 1.0)
of the length of the scrollbar.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>thickness</function>
</term>
<listitem>
<para>
The width of a vertical scrollbar or the height of a horizontal scrollbar.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>thumb</function>
</term>
<listitem>
<para>
This pixmap is used to tile (or stipple) the thumb of the scrollbar. If
no tiling is desired, then set this resource to <function>None</function>. This
resource will accept either a bitmap or a pixmap that is the same depth
as the window. The resource converter for this resource constructs
bitmaps from the contents of files. (See <function>Converting Bitmaps</function> for
details.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>topOfThumb</function>
</term>
<listitem>
<para>
The location of the top of the thumb, as a percentage (0.0 - 1.0)
of the length of the scrollbar. This resource was called <function>top</function> in
previous versions of the Athena widget set. The name collided with the
a Form widget constraint resource, and had to be changed.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id="Scrollbar_Actions">
<title>Scrollbar Actions</title>
<para>
<!-- .LP -->
The actions supported by the Scrollbar widget are:
</para>
<variablelist>
<varlistentry>
<term>
<function>StartScroll</function>(<emphasis remap='I'>value</emphasis>)
</term>
<listitem>
<para>
The possible <emphasis remap='I'>values</emphasis> are Forward, Backward, or Continuous.
This must be the first action to begin a new movement.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>NotifyScroll</function>(<emphasis remap='I'>value</emphasis>)
</term>
<listitem>
<para>
The possible <emphasis remap='I'>values</emphasis> are Proportional or FullLength. If the
argument to StartScroll was Forward or Backward, NotifyScroll executes
the <function>scrollProc</function> callbacks and passes either; the position of the
pointer, if <emphasis remap='I'>value</emphasis> is Proportional, or the full length of the
scroll bar, if <emphasis remap='I'>value</emphasis> is FullLength. If the argument to
StartScroll was Continuous, NotifyScroll returns without executing any
callbacks.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>EndScroll</function>(\^)
</term>
<listitem>
<para>
This must be the last action after a movement is complete.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>MoveThumb</function>(\^)
</term>
<listitem>
<para>
Repositions the Scrollbar's thumb to the current pointer location.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<function>NotifyThumb</function>(\^)\
</term>
<listitem>
<para>
Calls the
<!-- .PN jumpProc -->
callbacks and passes the relative position of the
pointer as a percentage of the scroll bar length.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The default bindings for Scrollbar are:
<!-- .IN "Scrollbar widget" "default translation table" -->
</para>
<literallayout class="monospaced">
<Btn1Down>: StartScroll(Forward)
<Btn2Down>: StartScroll(Continuous) MoveThumb(\|) NotifyThumb(\|)
<Btn3Down>: StartScroll(Backward)
<Btn2Motion>: MoveThumb(\|) NotifyThumb(\|)
<BtnUp>: NotifyScroll(Proportional) EndScroll(\|)
</literallayout>
<para>
Examples of additional bindings a user might wish to specify in a
resource file are:
</para>
<literallayout class="monospaced">
*Scrollbar.Translations: \\
~Meta<Key>space: StartScroll(Forward) NotifyScroll(FullLength) \\n\\
Meta<Key>space: StartScroll(Backward) NotifyScroll(FullLength) \\n\\
EndScroll(\|)
</literallayout>
</sect2>
<sect2 id="Scrollbar_Callbacks">
<title>Scrollbar Callbacks</title>
<!-- .IN "Scrollbar widget" "callbacks" -->
<para>
<!-- .LP -->
There are two callback lists provided by the Scrollbar widget.
The procedural interface for these functions is described here.
</para>
<para>
<!-- .LP -->
The calling interface to the <function>scrollProc</function> callback procedure is:
<!-- .IN "ScrollProc" "" "@DEF@" -->
</para>
<funcsynopsis id='ScrollProc'>
<funcprototype>
<funcdef>void<function> ScrollProc</function></funcdef>
<paramdef>Widget<parameter> scrollbar</parameter></paramdef>
<paramdef>XtPointer<parameter> client_data</parameter></paramdef>
<paramdef>XtPointer<parameter> position</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<emphasis remap='I'>scrollbar</emphasis>
</term>
<listitem>
<para>
Specifies the Scrollbar widget.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis remap='I'>client_data</emphasis>
</term>
<listitem>
<para>
Specifies the client data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis remap='I'>position</emphasis>
</term>
<listitem>
<para>
Specifies a pixel position in integer form.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The <function>scrollProc</function> callback is used for incremental scrolling
and is called by the <function>NotifyScroll</function> action.
The position argument is a signed quantity and should be cast to an int
when used. Using the default button bindings, button 1 returns a
positive value, and button 3 returns a negative value. In both cases,
the magnitude of the value is the distance of the pointer in
pixels from the top (or left) of the Scrollbar. The value will never
be greater than the length of the Scrollbar.
</para>
<para>
The calling interface to the <function>jumpProc</function> callback procedure is:
</para>
<!-- .IN "jumpProc" "" "@DEF@" -->
<funcsynopsis id='JumpProc'>
<funcprototype>
<funcdef>void<function> JumpProc</function></funcdef>
<paramdef>Widget<parameter> scrollbar</parameter></paramdef>
<paramdef>XtPointer<parameter> client_data</parameter></paramdef>
<paramdef>XtPointer<parameter> percent_ptr</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<!-- .FN -->
<variablelist>
<varlistentry>
<term>
<emphasis remap='I'>scrollbar</emphasis>
</term>
<listitem>
<para>
Specifies the ID of the scroll bar widget.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis remap='I'>client_data</emphasis>
</term>
<listitem>
<para>
Specifies the client data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis remap='I'>percent_ptr</emphasis>
</term>
<listitem>
<para>
Specifies the floating point position of the thumb (0.0 \- 1.0).
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The <function>jumpProc</function> callback is used to implement smooth scrolling and
is called by the <function>NotifyThumb</function> action. Percent_ptr must be cast
to a pointer to float before use; i.e.
</para>
<literallayout class="monospaced">
float percent = *(float*)percent_ptr;
</literallayout>
<para>
With the default button bindings, button 2 moves the thumb interactively,
and the <function>jumpProc</function> is called on each new position of the pointer,
while the pointer button remains down. The value specified by
<emphasis remap='I'>percent_ptr</emphasis> is the current location of the thumb (from the top or
left of the Scrollbar) expressed as a percentage of the length of the
Scrollbar.
</para>
</sect2>
<sect2 id="Convenience_Routines">
<title>Convenience Routines</title>
<para>
<!-- .IN "Scrollbar widget" "setting thumb values" -->
To set the position and length of a Scrollbar thumb, use
<!-- .PN XawScrollbarSetThumb . -->
<!-- .IN "XawScrollbarSetThumb" "" "@DEF@" -->
</para>
<funcsynopsis id='XawScrollbarSetThumb'>
<funcprototype>
<funcdef>void<function> XawScrollbarSetThumb</function></funcdef>
<paramdef>Widget<parameter> w</parameter></paramdef>
<paramdef>float<parameter> top</parameter></paramdef>
<paramdef>float<parameter> shown</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<emphasis remap='I'>w</emphasis>
</term>
<listitem>
<para>
Specifies the Scrollbar widget.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis remap='I'>top</emphasis>
</term>
<listitem>
<para>
Specifies the position of the top of the thumb as a fraction of the
length of the Scrollbar.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis remap='I'>shown</emphasis>
</term>
<listitem>
<para>
Specifies the length of the thumb as a fraction of the total length
of the Scrollbar.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<function>XawScrollbarThumb</function>
moves the visible thumb to a new position (0.0 \- 1.0) and length (0.0 \- 1.0).
Either the top or shown arguments can be specified as \-1.0,
in which case the current value is left unchanged.
Values greater than 1.0 are truncated to 1.0.
</para>
<para>
If called from <function>jumpProc</function>, <xref linkend='XawScrollbarSetThumb' xrefstyle='select: title'/> has no effect.
</para>
</sect2>
<sect2 id="Setting_Float_Resources">
<title>Setting Float Resources</title>
<!-- .IN "float resources" "setting" -->
<para>
The <function>shown</function> and <function>topOfThumb</function> resources are of type
<emphasis remap='I'>float</emphasis>. These resources can be difficult to get into an
argument list. The reason is that C performs an automatic cast of
the float value to an integer value, usually truncating the important
information. The following code fragment is one portable method of
getting a float into an argument list.
</para>
<literallayout class="monospaced">
top = 0.5;
if (sizeof(float) > sizeof(XtArgVal)) {
/*
\ * If a float is larger than an XtArgVal then pass this
\ * resource value by reference.
\ */
XtSetArg(args[0], XtNshown, &top);
}
else {
/*
\ * Convince C not to perform an automatic conversion, which
\ * would truncate 0.5 to 0.
\ */
XtArgVal * l_top = (XtArgVal *) &top;
XtSetArg(args[0], XtNshown, *l_top);
}
</literallayout>
</sect2>
</sect1>
|