| wxformoption | ||
|---|---|---|
 | Chapter 11. The wxWidgets-based (WXWN) Components |  |
A wxformoption object is a control that indicates whether it is 'checked' or not, normally by showing a circle that is either empty or has a dot in it. The control also contains a piece of text that labels it.
| 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 background of the option 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
wxformoption objects this is always
.true.
| ||||||||||
| font | wxfont | This is a reference to the wxfont object that describes how the text in the option control is formatted. | ||||||||||
| form | wxform | Specifies the wxform object to which this option control belongs. | ||||||||||
| height | integer | Gives the height of the option control, in pixels. | ||||||||||
| left | integer | Gives the position of the left side of the option control relative to the left side of the form, in pixels. | ||||||||||
| name | string | The name of the wxformoption object. | ||||||||||
| next | type(wxformcontrol) |
Specifies the next wxformcontrol on the same
form.
| ||||||||||
| onchange | event | An event which is triggered every time the user checks the the control. Normally the user cannot uncheck an option control. The event handling function will receive the following parameters: (wxformoption me[, type(*) reference]). The reference is only passed if it is provided by the user. | ||||||||||
| ongotfocus | event | An event that is triggered when the option control receives input focus. The event handling function will receive the following parameters: (wxformoption me[, type(*) reference]). The reference is only passed if it is provided by the user. | ||||||||||
| onlostfocus | event | An event that is triggered when the option control loses input focus. The event handling function will receive the following parameters: (wxformoption 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. | ||||||||||
| state | string |
A string which indicates whether or not the option control is
currently in a 'checked' state or not. If the control is not checked
then the value of state is "". If the control is
checked then the value of state is "on".
| ||||||||||
| text | string | The current text for the wxformoption object, which is displayed on the form. | ||||||||||
| textrgb | rgb | Gives the color of the text in the option control. | ||||||||||
| 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 option control relative to the top edge of the form, in pixels. | ||||||||||
| type | type | Specifies the wxformoption type object. | ||||||||||
| visible | boolean | Specifies whether or not the control is visible. | ||||||||||
| width | integer | Gives the width of the option control, in pixels. |
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.
Sets the background color of the option control. The
wxformoption 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.
wxformoptionvar.setbackgroundrgb (
integer rgbredgreenblue
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| rgb | The current value of the backgroundrgb
property | integer | The new background color of the option 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
backgroundrgb.red property | integer | The red component in the new background color of the option control. This must be between 0 and 255 inclusive. |
| green | The current value of the
backgroundrgb.green property | integer | The green component in the new background color of the option control. This must be between 0 and 255 inclusive. |
| blue | The current value of the
backgroundrgb.blue property | integer | The blue component in the new background color of the option control. This must be between 0 and 255 inclusive. |
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.
Sets the enabled state of the option control. The wxformoption object itself is returned, to allow multiple setting methods to be put into one expression.
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.
Sets the font to be used for the text in the option control. The wxformoption object itself is returned, to allow multiple setting methods to be put into one expression.
Sets the name of the option control. The wxformoption object itself is returned, to allow multiple setting methods to be put into one expression.
| 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.
|
Sets the mask that is used to decide which mouse events will be trapped for the control. The wxformoption object itself is returned, to allow multiple setting methods to be put into one expression.
| Parameter | Default value | Type name | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| onmousemask | None | integer |
The definition of which events should be handled by the
onmouse event handler. The
|
Sets the size and/or position of the option control. The wxformoption object itself is returned, to allow multiple setting methods to be put into one expression.
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| left | The current value of the left
property | integer | The new position of the left side of the option control on the form. |
| top | The current value of the top
property | integer | The new position of the top edge of the option control on the form. |
| width | The current value of the width
property | integer | The new width of the option control on the form. |
| height | The current value of the height
property | integer | The new height of the option control on the form. |
Sets the state of the option control, i.e. whether or not it has the appearance of being 'checked'. The wxformoption object itself is returned, to allow multiple setting methods to be put into one expression.
Sets the text in the label part of the control. The wxformoption object itself is returned, to allow multiple setting methods to be put into one expression.
Sets the color of the text in the label part of the control. The
wxformoption 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.
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| rgb | The current value of the textrgb
property | integer | The new color of the text in 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 textrgb.red
propery | integer | The red component in the new text color of the control. This must be between 0 and 255 inclusive. |
| green | The current value of the textrgb.green
property | integer | The green component in the new text color of the control. This must be between 0 and 255 inclusive. |
| blue | The current value of the text.blue
property | integer | The blue component in the new text color of the control. This must be between 0 and 255 inclusive. |
Sets the text for the tooltip associated with the control. The wxformoption object itself is returned, to allow multiple setting methods to be put into one expression.
Sets the visibility of the option control. The wxformoption object itself is returned, to allow multiple setting methods to be put into one expression.
| |  | |
| wxformlist |  | wxformscrollbar |
