home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / X / mit / doc / Xaw / Repeater < prev    next >
Encoding:
Text File  |  1991-07-29  |  4.8 KB  |  186 lines
  1. .NH 2
  2. Repeater Widget
  3. .XS
  4.     Repeater Widget
  5. .XE
  6. .IN "Repeater widget" "" "@DEF@"
  7. .Ds 0
  8. .TA 2.0i
  9. .ta 2.0i
  10. .sp
  11. Application header file    <X11/Xaw/Repeater.h>
  12. .IN "Repeater.h" ""
  13. Class header file    <X11/Xaw/RepeaterP.h>
  14. .IN "RepeaterP.h" ""
  15. Class    repeaterWidgetClass
  16. .IN "repeaterWidgetClass" ""
  17. Class Name    Repeater
  18. .IN "Repeater widget" "class name"
  19. Superclass    Command
  20. .sp
  21. .De
  22. .LP
  23. The Repeater widget is a version of the Command button that triggers 
  24. at an increasing rate while it is held down.  It is typically used to
  25. implement valuators or certain types of scrollbars.
  26. .NH 3
  27. Resources
  28. .LP
  29. When creating a Repeater widget instance, the following resources are
  30. retrieved from the argument list or from the resource database:
  31. .LP
  32. .IN "Repeater widget" "resources"
  33. .ps 9
  34. .nr PS 9
  35. .vs 11
  36. .nr VS 11
  37. .TS H
  38. expand;
  39. lw(1i) lw(1i) lw(1i) lw(.5i) lw(2i).
  40. _
  41. .sp 3p
  42. .TB
  43. Name    Class    Type    Notes    Default Value
  44. .sp 3p
  45. _
  46. .TH
  47. .R
  48. .sp 3p
  49. accelerators    Accelerators    AcceleratorTable        NULL
  50. ancestorSensitive    AncestorSensitive    Boolean    D    True
  51. background    Background    Pixel        XtDefaultBackground
  52. backgroundPixmap    Pixmap    Pixmap        XtUnspecifiedPixmap
  53. bitmap    Bitmap    Pixmap        None
  54. borderColor    BorderColor    Pixel        XtDefaultForeground
  55. borderPixmap    Pixmap    Pixmap        XtUnspecifiedPixmap
  56. borderWidth    BorderWidth    Dimension        1
  57. callback    Callback    XtCallbackList        NULL
  58. colormap    Colormap    Colormap        Parent's Colormap
  59. cornerRoundPercent    CornerRoundPercent    Dimension        25
  60. cursor    Cursor    Cursor        None
  61. cursorName    Cursor    String        NULL
  62. decay    Decay    Int        5
  63. depth    Depth    int    C    Parent's Depth
  64. destroyCallback    Callback    XtCallbackList        NULL
  65. encoding    Encoding    UnsignedChar        XawTextEncoding8bit
  66. flash    Boolean    Boolean        False
  67. font    Font    XFontStruct        XtDefaultFont
  68. foreground    Foreground    Pixel        XtDefaultForeground
  69. height    Height    Dimension    A    \fBfont\fP height + 2 * \fBinternalHeight\fP
  70. highlightThickness    Thickness    Dimension    A    2 (0 if Shaped)
  71. initialDelay    Delay    Int        200
  72. insensitiveBorder    Insensitive    Pixmap        GreyPixmap
  73. internalHeight    Height    Dimension        2
  74. internalWidth    Width    Dimension        4
  75. justify    Justify    Justify        XtJustifyCenter (center)
  76. label    Label    String        name of widget
  77. leftBitmap    LeftBitmap    Bitmap        None
  78. mappedWhenManaged    MappedWhenManaged    Boolean        True
  79. minimumDelay    MinimumDelay    Int        10
  80. pointerColor    Foreground    Pixel        XtDefaultForeground
  81. pointerColorBackground    Background    Pixel        XtDefaultBackground
  82. repeatDelay    Delay    Int        50
  83. resize    Resize    Boolean        True
  84. screen    Screen    Pointer    R    Parent's Screen
  85. sensitive    Sensitive    Boolean        True
  86. shapeStyle    ShapeStyle    ShapeStyle        Rectangle
  87. startCallback    StartCallback    Callback        NULL
  88. stopCallback    StopCallback    Callback        NULL
  89. translations    Translations    TranslationTable        See below
  90. width    Width    Dimension    A    \fBlabel\fP width + 2 * \fBinternalWidth\fP
  91. x    Position    Position        0
  92. y    Position    Position        0
  93. .sp 3p
  94. _
  95. .TE
  96. .ps 11
  97. .nr PS 11
  98. .vs 13
  99. .nr VS 13
  100. \" Resource Descriptions
  101. .Ac
  102. .As
  103. .Bg
  104. .Gp
  105. .Bm
  106. .Bc
  107. .Bp
  108. .Bw
  109. .Cb
  110. .Cm
  111. .Cr
  112. .Cu
  113. .Pn
  114. .IP \fBdecay\fP 1.5i
  115. The number of milliseconds that should be subtracted from each succeeding 
  116. interval while the Repeater button is being held down until the interval
  117. has reached \fBminimumDelay\fP milliseconds.
  118. .Dp
  119. .Dc
  120. .Le
  121. .IP \fBflash\fP 1.5i
  122. Whether or not to flash the Repeater button whenever the timer goes off.
  123. .Lf
  124. .Lg
  125. .Hw
  126. .Ht
  127. .IP \fBinitialDelay\fP 1.5i
  128. The number of milliseconds between the beginning of the Repeater button
  129. being held down and the first invocation of the \fBcallback\fP function.
  130. .Ib
  131. .Ih
  132. .Ju
  133. .La
  134. .Ll
  135. .Mm
  136. .IP \fBminimumDelay\fP 1.5i
  137. The minimum time between callbacks in milliseconds.
  138. .Pf
  139. .Pb
  140. .IP \fBrepeatDelay\fP 1.5i
  141. The number of milliseconds between each callback after the first (minus an
  142. increasing number of \fBdecay\fPs).
  143. .Re
  144. .Sc
  145. .Se
  146. .Ss 
  147. .IP \fBstartCallback\fP 1.5i
  148. The list of functions to invoke by the \fBstart\fP action (typically
  149. when the Repeater button is first pressed).  The callback data parameter
  150. is set to NULL.
  151. .IP \fBstopCallback\fP 1.5i
  152. The list of functions to invoke by the \fBstop\fP action (typically
  153. when the Repeater button is released).  The callback data parameter
  154. is set to NULL.
  155. .Tr
  156. .Xy
  157. .NH 3
  158. Repeater Actions
  159. .IN "Repeater widget" "actions"
  160. .LP
  161. The Repeater widget supports the following actions beyond those of the Command
  162. button:
  163. .IP \fBstart\fP() 1.5i
  164. This invokes the functions on the \fBstartCallback\fP and \fBcallback\fP lists
  165. and sets a timer to go off in \fBinitialDelay\fP milliseconds.  The timer
  166. will cause the \fBcallback\fP functions to be invoked with increasing
  167. frequency until the \fBstop\fP action occurs.
  168. .IP \fBstop\fP() 1.5i
  169. This invokes the functions on the \fBstopCallback\fP list and prevents any
  170. further timers from occuring until the next \fBstart\fP action.
  171. .LP
  172. .sp
  173. .IN "Repeater widget" "translation bindings"
  174. The following are the default translation bindings used by the
  175. Repeater widget: 
  176. .LP
  177. .Ds 0
  178. .TA .5i 2.25i
  179. .ta .5i 2.25i
  180.     <EnterWindow>:    highlight(\|)
  181.     <LeaveWindow>:    unhighlight(\|)
  182.     <Btn1Down>:    set(\|) start(\|)
  183.     <Btn1Up>:    stop(\|) unset(\|)
  184. .De
  185. .LP
  186.