Developer Resources

BitmapButton

Overview

The BitmapButton class represents a button control which can be added a window. It can be clicked by the user using the mouse, or activated by the keyboard if the control has keyboard focus. This type of button can only display a bitmap without any label. When the button is pushed, the click event is fired.

Base Class

FormControl

Constructor

BitmapButton(bitmap : Bitmap, x_pos : Integer, y_pos : Integer, width : Integer, height : Integer)

Arguments

bitmap
The bitmap to be shown on the control.
x_pos
The x position of the control.
y_pos
The y position of the control.
width
The width of the control.
height
The height of the control.

Events

BitmapButton.click
Fired when the button is clicked.

Methods

BitmapButton.getBitmap
Returns the button's current bitmap.
BitmapButton.setBitmap
Sets the label text on the button.
BitmapButton.setDefault
Sets whether the button is a form's 'default' button

Inherited Methods

FormControl.captureMouse
Captures the mouse on this form control.
FormControl.disablePaint
Disables the window from redrawing itself.
FormControl.enablePaint
Enables the window to redraw itself.
FormControl.getBackgroundColor
Gets the background color of the form control.
FormControl.getClientSize
Gets the client size of the form control.
FormControl.getEnabled
Indicates whether or not a form control is enabled.
FormControl.getFont
Gets the default font for the text of form control.
FormControl.getForegroundColor
Gets the foreground color of the form control.
FormControl.getMaxSize
Gets the maximum size of the form control.
FormControl.getMinSize
Gets the minimum size of the form control.
FormControl.getMousePosition
Gets the mouse position relative to this form control.
FormControl.getNativeHandle
Gets the native handle of the window/control
FormControl.getPosition
Gets the position of a form control.
FormControl.getSize
Gets the size of the form control.
FormControl.invalidate
Invalidates a form control, which will cause it to be repainted on the next paint event.
FormControl.refresh
Refreshes a form control, which immediately repaints the entire form control.
FormControl.releaseMouse
Releases the mouse from being captured on this form control.
FormControl.setBackgroundColor
Sets the background color of the form control.
FormControl.setClientSize
Sets the client size of a form control.
FormControl.setEnabled
Enables or disables the form control.
FormControl.setFocus
Sets the focus to the form control.
FormControl.setFont
Sets the default font for the text of the form control.
FormControl.setForegroundColor
Sets the foreground color of the form control.
FormControl.setMaxSize
Sets the maximum size of a form control.
FormControl.setMinSize
Sets the minimum size of a form control.
FormControl.setPosition
Sets the position of a form control relative to the the form control's parent.
FormControl.setSize
Sets the size of a form control.
FormControl.show
Shows or hides the form control.
FormControl.update
Updates a form control, which will immediately repaint any invalid areas.

BitmapButton.getBitmap

function BitmapButton.getBitmap() : Bitmap

Returns

The button's current bitmap.

Description

Returns the button's current bitmap.

BitmapButton.setBitmap

function BitmapButton.setBitmap(bitmap : Bitmap)

Arguments

bitmap
The new bitmap

Description

Sets the button's bitmap to the bitmap specified in the bitmap parameter.

BitmapButton.setDefault

function BitmapButton.setDefault()

Description

Sets a button as a form's 'default' button. A default button is activated whenever the enter key is pressed when a form is focused.