| wxstatusbar | ||
|---|---|---|
 | Chapter 11. The wxWidgets-based (WXWN) Components |  |
wxstatusbar
Description
A wxstatusbar object provides a panel at the bottom of the window where text messages can be displayed. It can only be associated with one window at a time. It can also exist independently of being hosted within a window.
Type Tags
None
Object Value
wxstatusbar.new()
Description
Creates a new wxstatusbar object.
Prototype
wxstatusbar.new (
integer error
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| error | .nul | integer |
Specifies an object which is used to output any error code generated during
creation of the wxstatusbar object. If
error is not specified or is
.nul then any error which occurs during object
creation will halt the program. If an error object is specified and
an error occurs during object creation then the error code is
output into that object and the new methods
returns .nul.
|
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. |
| text | string | This property contains the text that is currently displayed in the status bar. |
| type | type | Specifies the wxtoolbar type object. |
| window | wxwindow | This property holds a reference to the window where the status bar is hosted. |
Methods
settext()
Description
Sets the text in the status bar. The wxstatusbar object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxstatusbarvar.settext (
string text
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| text | None | string | The new text to set in the status bar. |
setwindow()
Description
Creates the status bar in the target window.
Prototype
wxstatusbarvar.setwindow (
wxwindow window
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| window | None | wxwindow | The window that will host the status bar. |