Skip to content

Latest commit

 

History

History
149 lines (66 loc) · 1.74 KB

button.md

File metadata and controls

149 lines (66 loc) · 1.74 KB

Button

A simple button.

UiButton example

var libui = require('libui');

var win = new libui.UiWindow('UiButton example', 640, 480, true);

var widget = new libui.UiButton();
win.setChild(widget);

win.onClosing(function () {
	win.close();
	libui.stopLoop();
});

win.show();

libui.startLoop();

Constructor

new libui.UiButton()

Create a new UiButton object.


Properties

See properties implementation for generic details on how properties are implemented.

visible: Boolean

Whether the widget should be visible or hidden. Read write. Defaults to true.

enabled: Boolean

Whether the widget should be enabled or disabled. Read write. Defaults to true.

text: String

The static text of the button. Read write.


Methods

destroy

Destroy and free the control.

setParent

Change the parent of the control

Arguments

  • parent: UiControl - the new parent of the widget or null to detach it.

toplevel

Return whether the control is a top level one or not.

setVisible

Set the value of property visible

Arguments

  • value: Boolean - The new value for visible property.

getVisible

Return the value of property visible

setEnabled

Set the value of property enabled

Arguments

  • value: Boolean - The new value for enabled property.

getEnabled

Return the value of property enabled

setText

Set the value of property text

Arguments

  • value: String - The new value for text property.

getText

Return the value of property text


Events

See events implementation for generic details on how events are implemented.

onClicked

Emitted when the button is clicked