| wxformbitmap | ||
|---|---|---|
 | Chapter 11. The wxWidgets-based (WXWN) Components |  |
wxformbitmap
Description
A wxformbitmap object is an image control that can display an image on a form in any size (wxformbitmapbutton has a size limitation on some platforms of maximum 64 pixels in each dimension). Images can be unchanged, stretched or squeezed to fit the container, or scaled to fit the container while retaining the aspect ratio.
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 control in the case that the control is not completely filled by the associated bitmap. | ||||||||||
| bitmap | wxbitmap | The wxbitmap object that is used as the source of the bitmap in 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
wxformbitmap objects this is always
.false
| ||||||||||
| 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 wxformbitmap 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. | ||||||||||
| scaling | string |
Determines the type of scaling used on the bitmap. This can be one of:
"hfit", "vfit",
"handvfit", "preserveaspect",
or the empty string. If no scaling is specified, then the image will
be cropped to fit the control as needed. Otherwise the image will be
stretched horizontally to fill the container, vertically to fill the
container, or in both directions.
| ||||||||||
| 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 wxformbitmap 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
wxformbitmapvar.remove ()
Parameters
None
setbackgroundrgb()
Description
Sets the color of the control. The wxformbitmap 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
wxformbitmapvar.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. |
setbitmap()
Description
Sets the bitmap associated with the control. The wxformbitmap object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformbitmapvar.setbitmap (
wxbitmap bitmap
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| bitmap | None | wxbitmap | The wxbitmap object to be assigned as the source of the bitmap in the control. |
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
wxformbitmapvar.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 wxformbitmap object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformbitmapvar.setenabled (
boolean enabled
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| enabled | None | boolean | The desired enabled state for the control. |
setname()
Description
Sets the name of the bitmap control. The wxformbitmap object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformbitmapvar.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
wxformbitmapvar.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 wxformbitmap object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformbitmapvar.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 wxformbitmap object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformbitmapvar.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. |
setscaling()
Description
Sets the scaling method to be used for the bitmap in the control. The wxformbitmap object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformbitmapvar.setscaling (
string scaling
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| scaling | None | string |
The scaling method to be used when adjusting the bitmap to its container. This
is one of: "hfit", "vfit",
"handvfit",
"preserveaspect", or the empty string
(""). If no scaling is specified, then the
image will be cropped to fit the container as needed. Otherwise
the image will be stretched horizontally to fill the container,
vertically to fill the container, or in both directions.
|
settooltip()
Description
Sets the text for the tooltip associated with the control. The wxformbitmap object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformbitmapvar.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 wxformbitmap object itself is returned, to allow multiple setting methods to be put into one expression.
Prototype
wxformbitmapvar.setvisible (
boolean visible
Parameters
| Parameter | Default value | Type name | Description |
|---|---|---|---|
| visible | None | boolean | The desired visibility of the control. |