| wxformcombo | ||
|---|---|---|
 | Chapter 11. The wxWidgets-based (WXWN) Components |  |
wxformcombo
Description
A wxformcombo object is a text based control on a form with a separate list of items, one of which can be selected.
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 background of the combo control. | ||||||||||
| captureable | boolean |
Specifies whether or not the control events can be captured by the form when
the controlcapture() method is called.
| ||||||||||
| edittype | string |
A string that indicates the way in which the user can change the text in
the combo.
| ||||||||||
| enabled | boolean | Specifies whether or not the control is enabled. | ||||||||||
| focusable | boolean |
Specifies whether or not the control can have the input focus. For
wxformcombo objects this is always
.true
| ||||||||||
| font | wxfont | This is a reference to the wxfont object that describes how the text in the list control is formatted. | ||||||||||
| form | wxform | Specifies the wxform object to which this combo control belongs. | ||||||||||
| height | integer | Gives the height of the combo control, in pixels. | ||||||||||
| itemcount | integer | Gives the number of items in the combo control. | ||||||||||
| left | integer | Gives the position of the left side of the combo control relative to the left side of the form, in pixels. | ||||||||||
| name | string | The name of the wxformcombo object. | ||||||||||
| next | type(wxformcontrol) |
Specifies the next wxformcontrol on the same form.
| ||||||||||
| ongotfocus | event | An event that is triggered when the combo control receives input focus. The event handling function will receive the following parameters: (wxformcombo me[, type(*) reference]). The reference is only passed if it is provided by the user. | ||||||||||
| onlostfocus | event | An event that is triggered when the combo control loses input focus. The event handling function will receive the following parameters: (wxformcombo 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. | ||||||||||
| onselectionchange | event | An event which is triggered when what is selected in the combo control changes. The event handling function will receive the following parameters: (wxformcombo me[, type(*) reference]). The reference is only passed if it is provided by the user. | ||||||||||
| text | string |
The current text for the wxformcombo object, which is displayed
on the form. During editing and also during any
onlostfocus event for this combo control the
text property is still set to the original text of
the control, before editing started. The gettext
method can be used to retrieve the new text which the user has
entered into the control.
| ||||||||||
| textrgb | rgb | Gives the color of the text in the combo 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 combo control relative to the top edge of the form, in pixels. | ||||||||||
| type | type | Specifies the wxformcombo type object. | ||||||||||
| visible | boolean | Specifies whether or not the control is visible. | ||||||||||
| width | integer | Gives the width of the combo control, in pixels. |
Methods
delete()
Description
Deletes (removes) items from a combo control. The wxformcombo object itself is returned, to allow multiple methods to be put into one expression.
Prototype
wxformcombovar.delete (
integer …
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| None | integer | The 1-based index into the list of an item to delete. | |
| … | None |
deleteall()
Description
Deletes (removes) all items from a combo control. The wxformcombo object itself is returned, to allow multiple methods to be put into one expression.
Prototype
wxformcombovar.deleteall ()
Parameters
None
getselected()
Description
Searches a combo control's list for the next selected item after a specified
start point. The return value is the 1-based index of the first
selected item which is equal to or greater than the specified start
point, or is .nul if there is no such selected
item.
Prototype
wxformcombovar.getselected (
integer firstitem
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| firstitem | None | integer | The 1-based index of the first item to search for selection. |
gettext()
Description
Gets the most recent text for the edit portion of the control. During editing
and also during any onlostfocus event for this
combo control the gettext method will retrieve the
current text visible in the edit portion of the control. The
text property can be used to access the original
text that was in place before editing began. This primarily is of use
when using the "dropedit" form of the control.
Prototype
wxformcombovar.gettext ()
Parameters
None
insert()
Description
Adds items to a combo control's list. The wxformcombo object itself is returned, to allow multiple methods to be put into one expression.
Prototype
wxformcombovar.insert (
integer firstitem…
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| firstitem | The current value of the itemcount property plus
one, i.e. the end of the list. | integer | The 1-based index into the list to show the position to place the first of the items to be inserted. |
| None | string |
The string to be added as an item at position firstitem.
| |
| … | None |
isselected()
Description
Determines whether or not a specified item in a combo control is currently
selected. The method returns .true if the item is
selected, or .false otherwise.
Prototype
wxformcombovar.isselected (
integer item
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| item | None | integer | The 1-based index into the list of an item to determine the selection state of. |
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
wxformcombovar.remove ()
Parameters
None
select()
Description
Selects an item in a combo control. The wxformcombo object itself is returned, to allow multiple methods to be put into one expression.
Prototype
wxformcombovar.select (
integer itemselect
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| item | None | integer | The 1-based index of the item to select. |
| select | .true | boolean |
.true is the only valid value for this argument.
|
setbackgroundrgb()
Description
Sets the background color of the combo control. The wxformcombo
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
wxformcombovar.setbackgroundrgb (
integer rgbredgreenblue
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| rgb | The current value of the backgroundrgb
property | integer | The new background color of the combo control. It is inadvisable to specify any value for this argument which 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 combo 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 combo 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 combo 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
wxformcombovar.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 combo control. The wxformcombo object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformcombovar.setenabled (
boolean enabled
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| enabled | None | boolean | The desired enabled state for the combo 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
wxformcombovar.setfocus ()
Parameters
None
setfont()
Description
Sets the font to be used for the text in the combo control. The wxformcombo object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformcombovar.setfont (
wxfont font
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| font | None | wxfont | The wxfont object that will be used to format the text in the combo control. |
setname()
Description
Sets the name of the list control. The wxformlist object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformcombovar.setname (
string name
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| name | None | string | The new name for the list control. |
setnext()
Description
Sets the position of the control in the z-order and tab order.
Prototype
wxformcombovar.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 wxformcombo object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformcombovar.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 combo control. The wxformcombo object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformcombovar.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 combo control on the form. |
| top | The current value of the top property | integer | The new position of the top edge of the combo control on the form. |
| width | The current value of the width property | integer | The new width of the combo control on the form. |
| height | The current value of the height property | integer | The new height of the combo control on the form. |
settext()
Description
Sets the text in the control. The wxformcombo object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformcombovar.settext (
string text
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| text | None | string | The new text to set in the control. |
settextrgb()
Description
Sets the color of the text in the combo control. The wxformcombo
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
wxformcombovar.settextrgb (
integer rgbredgreenblue
Parameters
| 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 which is not the value of an existing rgb object. |
| red | The current value of the textrgb.red property | 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. |
settooltip()
Description
Sets the text for the tooltip associated with the control. The wxformcombo object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformcombovar.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 combo control. The wxformcombo object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformcombovar.setvisible (
boolean visible
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| visible | None | boolean | The desired visibility of the combo control. |
wxformcombo[]
Get
Subscripts
A numeric value giving the 1-based index of an item in the list.
Description
Retrieves the text of the specified item.
Set
Subscripts
A numeric value giving the 1-based index of an item in the list.
Description
Sets the text of the specified item.
Set Reference
Attempting to set a reference to an object is not supported.