| wxformscrollbar | ||
|---|---|---|
 | Chapter 11. The wxWidgets-based (WXWN) Components |  |
wxformscrollbar
Description
A wxformscrollbar object is a free-standing scrollbar control either vertically or horizontally positioned on the form.
Type Tags
wxformcontrol
Object Value
Properties
| Property | Type | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| _ | type(*) | This property is provided for use by the user to attach any object of any type to the type in which this property is provided. | ||||||||||
| __ | type(*) | This property is provided for use by the user to attach any object of any type to the type in which this property is provided. It has the additional feature of being marked with the resolve keyword, so that object resolution can continue down this property. | ||||||||||
| backgroundrgb | rgb | Gives the color of the control. | ||||||||||
| captureable | boolean |
Specifies whether or not the control events can be captured by the form when
the controlcapture() method is called.
| ||||||||||
| enabled | boolean | Specifies whether or not the control is enabled. | ||||||||||
| focusable | boolean |
Specifies whether or not the control can have the input focus. For
wxformscrollbar objects this is always
.true
| ||||||||||
| form | wxform | Specifies the wxform object to which this control belongs. | ||||||||||
| height | integer | Gives the height of the control, in pixels. | ||||||||||
| left | integer | Gives the position of the left side of the control relative to the left side of the form, in pixels. | ||||||||||
| name | string | The name of the wxformscrollbar object. | ||||||||||
| next | type(wxformcontrol) |
Specifies the next wxformcontrol on the same form.
| ||||||||||
| ongotfocus | event | An event that is triggered when the scrollbar control receives input focus. The event handling function will receive the following parameters: (wxformscrollbar me[, type(*) reference]). The reference is only passed if it is provided by the user. | ||||||||||
| onlostfocus | event | An event that is triggered when the scrollbar control loses input focus. The event handling function will receive the following parameters: (wxformscrollbar me[, type(*) reference]). The reference is only passed if it is provided by the user. | ||||||||||
| onmouse | event |
An event that is triggered each time a mouse event occurs that matches
the bits set in the onmousemask property. The
onmouse event handling function should be defined as follows:
| ||||||||||
| onmousemask | integer | Holds the mask that decides which mouse events are captured and sent to the onmouse event handler. | ||||||||||
| onscroll | event |
An event that is triggered every time the scroll position of control changes.
The event handling function will receive the following parameters:
(wxformscrollbar me, string scrolltype[, type(*) reference]). The
reference is only passed if it is provided by the user. The
scrolltype will be one of: "top",
"bottom", "thumbdrop",
"thumbdrag", "pageup",
"pagedown", "lineup", or
"linedown".
| ||||||||||
| orientation | string |
This contains either "v" if the scroll bar is vertical or
"h" if the scroll bar is horizontal.
| ||||||||||
| pagesize | integer | This contains the number of values from the overall range that represent a single page (when clicking in the scroll bar area outside of the thumb itself). This then decides how far the thumb actually moves when a click in these areas occurs. Valid values are from 1 through the size of the range. | ||||||||||
| position | integer | This contains the current position of the thumb in the scroll bar. Valid values are from 0 to range minus thumbsize. | ||||||||||
| range | integer | This contains the range of values, beginning at 0 and ending at range - 1, that describe the granularity of the scroll bar. Valid values are from 1 through 4G. | ||||||||||
| thumbsize | integer | This contains the size of the thumb. The thumb size is normally automatically managed by the relationship between the range, the scrollbar size, and the page size, but this can be overridden. Valid values are from 1 up to the size of the range. | ||||||||||
| tooltip | string | Contains the test that is displayed as a tooltip for the control. | ||||||||||
| top | integer | Gives the position of the top edge of the control relative to the top edge of the form, in pixels. | ||||||||||
| type | type | Specifies the wxformscrollbar type object. | ||||||||||
| visible | boolean | Specifies whether or not the control is visible. | ||||||||||
| width | integer | Gives the width of the control, in pixels. |
Methods
remove()
Description
Removes the control from the form. If any object has a reference to the control, those references will no longer be valid. It is not safe to attempt to use a control after this method has been called.
Prototype
wxformscrollbarvar.remove ()
Parameters
None
setbackgroundrgb()
Description
Sets the color of the control. The wxformscrollbar object itself
is returned, to allow multiple setting methods to be put into one
expression. It is an error to specify both the rgb
argument and one or more of the red,
green, or blue arguments.
Prototype
wxformscrollbarvar.setbackgroundrgb (
integer rgbredgreenblue
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| rgb | The current value of the rgb property | integer | The new color of the control. It is inadvisable to specify any value for this argument that is not the value of an existing rgb object. |
| red | The current value of the rgb.red property | integer | The red component in the new color of the control. This must be between 0 and 255 inclusive. |
| green | The current value of the rgb.green property | integer | The green component in the new color of the control. This must be between 0 and 255 inclusive. |
| blue | The current value of the rgb.blue property | integer | The blue component in the new color of the control. This must be between 0 and 255 inclusive. |
setcaptureable()
Description
This method is used to determine whether the events for the control can be captured and passed to the form or not. By default, events can be captured.
Prototype
wxformscrollbarvar.setcaptureable (
boolean captureable
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| captureable | None | boolean |
Sets whether or not the events for this control can be captured by the form
using the controlcapture() method of the
form.
|
setenabled()
Description
Sets the enabled state of the control. The wxformscrollbar object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformscrollbarvar.setenabled (
boolean enabled
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| enabled | None | boolean | The desired enabled state for the control. |
setfocus()
Description
Sets focus to the control, provided that it is not invisible or disabled. If this is called for a form that is not yet in a container, then nothing will happen except that the focuscontrol of the wxform object will be set. Once the form is placed in a container, the control will get focus and the ongotfocus event will fire.
Prototype
wxformscrollbarvar.setfocus ()
Parameters
None
setname()
Description
Sets the name of the scrollbar control. The wxformscrollbar object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformscrollbarvar.setname (
string name
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| name | None | string | The new name for the control. |
setnext()
Description
Sets the position of the control in the z-order and tab order.
Prototype
wxformscrollbarvar.setnext (
type(wxformcontrol) next
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| next | None | type(wxformcontrol) |
Calling the method with the value .nul sets a control to be
the last one in the ring (the one before form.firstcontrol) and
so has the highest z-order, and passing any other control as the
argument puts the target control immediately below the one
specified as the parameter. The visible stacking of controls on a
form is such that the earliest in the ring is the furthest back
in the z-order.
|
setonmousemask()
Description
Sets the mask that is used to decide which mouse events will be trapped for the control. The wxformscrollbar object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformscrollbarvar.setonmousemask (
integer onmousemask
Parameters
| Parameter | Default value | Type name | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| onmousemask | None | integer |
The definition of which events should be handled by the onmouse event
handler. The
|
setposition()
Description
Sets the size and/or position of the control. The wxformscrollbar object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformscrollbarvar.setposition (
integer lefttopwidthheight
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| left | The current value of the left property | integer | The new position of the left side of the control on the form. |
| top | The current value of the top property | integer | The new position of the top edge of the control on the form. |
| width | The current value of the width property | integer | The new width of the control on the form. |
| height | The current value of the height property | integer | The new height of the control on the form. |
setscroll()
Description
Sets various properties of the control. The wxformscrollbar object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformscrollbarvar.setscroll (
integer rangepositionpagesizethumbsize
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| range | Current value of the range property | integer | The desired range for the control. |
| position | Current value of the position property | integer | The desired position of the thumb in the scrollbar control. |
| pagesize | Current value of the pagesize property | integer | The desired pagesize for the scrollbar control. |
| thumbsize | Current value of the thumbsize property | integer | The desired thumbsize for the scrollbar control. |
settooltip()
Description
Sets the text for the tooltip associated with the control. The wxformscrollbar object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformscrollbarvar.settooltip (
string tooltip
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| tooltip | None | string | The new text to set for the tooltip. |
setvisible()
Description
Sets the visibility of the control. The wxformscrollbar object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformscrollbarvar.setvisible (
boolean visible
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| visible | None | boolean | The desired visibility of the control. |