guibitmapbuttonctrl: members
16 implemented, 0 reserved. Entries are sorted by name.
Implemented
Section titled “Implemented”bitmap
Section titled “bitmap”guibitmapbuttonctrl.bitmap: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Image file; a bitmap button also uses the _h, _d and _i variants for hover, pressed and inactive.
new GuiBitmapButtonCtrl("MyControl") { bitmap = "button.png"; }Specification: gui.md§3.
buttontype
Section titled “buttontype”guibitmapbuttonctrl.buttontype: string
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
How the button behaves when clicked: pushbutton, togglebutton or radiobutton.
new GuiBitmapButtonCtrl("MyControl") { buttontype = "togglebutton"; }Specification: gui-legacy.md§29.
checked
Section titled “checked”guibitmapbuttonctrl.checked: boolean
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
Whether a toggle or radio button is checked (another name of value on a check box or radio control).
echo(MyControl.checked);Specification: gui-legacy.md§29.
gettext
Section titled “gettext”guibitmapbuttonctrl.gettext() -> string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
The text of a text edit or markup text control, as stored.
echo(Edit.getText());Specification: gui.md§3.
groupnum
Section titled “groupnum”guibitmapbuttonctrl.groupnum: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
The group of a radio-type button: choosing one clears the others of its group.
new GuiRadioCtrl("MyControl") { groupnum = 10; }Specification: gui.md§3.
guibitmapbuttonctrl.icon: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiBitmapButtonCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiBitmapButtonCtrl("MyControl") { icon = 1; }Specification: gui.md§3.
iconheight
Section titled “iconheight”guibitmapbuttonctrl.iconheight: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiBitmapButtonCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiBitmapButtonCtrl("MyControl") { iconheight = 1; }Specification: gui.md§3.
iconwidth
Section titled “iconwidth”guibitmapbuttonctrl.iconwidth: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiBitmapButtonCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiBitmapButtonCtrl("MyControl") { iconwidth = 1; }Specification: gui.md§3.
mouseoverbitmap
Section titled “mouseoverbitmap”guibitmapbuttonctrl.mouseoverbitmap: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiBitmapButtonCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiBitmapButtonCtrl("MyControl") { mouseoverbitmap = 1; }Specification: gui.md§3.
normalbitmap
Section titled “normalbitmap”guibitmapbuttonctrl.normalbitmap: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiBitmapButtonCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiBitmapButtonCtrl("MyControl") { normalbitmap = 1; }Specification: gui.md§3.
pressedbitmap
Section titled “pressedbitmap”guibitmapbuttonctrl.pressedbitmap: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiBitmapButtonCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiBitmapButtonCtrl("MyControl") { pressedbitmap = 1; }Specification: gui.md§3.
setbitmap
Section titled “setbitmap”guibitmapbuttonctrl.setbitmap(image: string, state?: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Sets a picture: the picture of a bitmap control, or the picture of one state of a bitmap button (0 normal, 1 mouse over, 2 pressed).
Button.setBitmap("btn_hot.png", 1);Specification: gui.md§3.
seticonsize
Section titled “seticonsize”guibitmapbuttonctrl.seticonsize(arg1: number, arg2: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Sets the size of the icons (at most 64 by 64) and raises onIconResized.
Control.seticonsize(0, 0);Specification: gui.md§3.
settext
Section titled “settext”guibitmapbuttonctrl.settext(text: string) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Replaces the text of a text edit; the caret goes to the end.
Edit.setText("hello");Specification: gui.md§3.
stylesection
Section titled “stylesection”guibitmapbuttonctrl.stylesection: string
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
Name of the part of the GUI style the control takes its colors from; kept without GUI styles.
new GuiBitmapButtonCtrl("MyControl") { stylesection = "Clock"; }Specification: gui.md§3.11.
guibitmapbuttonctrl.text: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
The text the control shows.
new GuiBitmapButtonCtrl("MyControl") { text = "Hello"; }Specification: gui.md§3.
Engine version 0.1.0. Built 2026-11-18.