| wxformtext | ||
|---|---|---|
 | Chapter 11. The wxWidgets-based (WXWN) Components |  |
wxformtext
Description
A wxformtext object is an area of a form where a piece of text is displayed.
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. | ||||||||||
| alignment | string |
The alignment of the content of the control. This will either be
"left", "right", or
"" if the content is centered. This must be set at
the time the control is created.
| ||||||||||
| backgroundrgb | rgb | Gives the color of the background of the text 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
wxformtext objects this is always
.false.
| ||||||||||
| font | wxfont | This is a reference to the wxfont object that describes how the text in the control is formatted. | ||||||||||
| form | wxform | Specifies the wxform object to which this text control belongs. | ||||||||||
| height | integer | Gives the height of the text control, in pixels. | ||||||||||
| left | integer | Gives the position of the left side of the text control relative to the left side of the form, in pixels. | ||||||||||
| name | string | The name of the wxformtext object. | ||||||||||
| next | type(wxformcontrol) |
Specifies the next wxformcontrol on the same form.
| ||||||||||
| 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. | ||||||||||
| text | string | The current text for the wxformtext object, which is displayed on the form. | ||||||||||
| textrgb | rgb | Gives the color of the text in the 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 text control relative to the top edge of the form, in pixels. | ||||||||||
| type | type | Specifies the wxformtext type object. | ||||||||||
| visible | boolean | Specifies whether or not the control is visible. | ||||||||||
| width | integer | Gives the width of the text 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
wxformtextvar.remove ()
Parameters
None
setbackgroundrgb()
Description
Sets the background color of the text control. The wxformtext
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
wxformtextvar.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 text 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 text 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 text 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 text 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
wxformtextvar.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 text control. The wxformtext object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformtextvar.setenabled (
boolean enabled
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| enabled | None | boolean | The desired enabled state for the text control. |
setfont()
Description
Sets the font to be used for the text in the text control. The wxformtext object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformtextvar.setfont (
wxfont font
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| font | None | wxfont | The wxfont object that will be used to format the text. |
setname()
Description
Sets the name of the text control. The wxformtext object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformtextvar.setname (
string name
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| name | None | string | The new name for the text control. |
setnext()
Description
Sets the position of the control in the z-order and tab order.
Prototype
wxformtextvar.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 wxformtext object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformtextvar.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 text control. The wxformtext object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformtextvar.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 text control on the form. |
| top | The current value of the top property | integer | The new position of the top edge of the text control on the form. |
| width | The current value of the width property | integer | The new width of the text control on the form. |
| height | The current value of the height property | integer | The new height of the text control on the form. |
settext()
Description
Sets the text in the text control. The wxformtext object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformtextvar.settext (
string text
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| text | None | string | The new text to set in the text control. |
settextrgb()
Description
Sets the color of the text in the control. The wxformtext 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
wxformtextvar.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 that 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 wxformtext object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformtextvar.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 text control. The wxformtext object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformtextvar.setvisible (
boolean visible
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| visible | None | boolean | The desired visibility of the text control. |