Difference between revisions of "Lua:Class:Button"
Jump to navigation
Jump to search
m (→Examples: Syntax Highlight.) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Lua]] | [[Category:Lua]] | ||
{{NeedWork}} | {{NeedWork}} | ||
| − | {{ | + | {{Class|'''class''' Button ''':''' ButtonControl}} |
The Button class represents a clickable button control. | The Button class represents a clickable button control. | ||
| Line 79: | Line 79: | ||
===Examples=== | ===Examples=== | ||
| − | < | + | <syntaxhighlight lang="lua" line> |
local form = createForm() | local form = createForm() | ||
form.Caption = "Button Example" | form.Caption = "Button Example" | ||
| Line 94: | Line 94: | ||
form.showModal() | form.showModal() | ||
form.destroy() | form.destroy() | ||
| − | </ | + | </syntaxhighlight> |
| − | < | + | <syntaxhighlight lang="lua" line> |
local form = createForm() | local form = createForm() | ||
form.Caption = "Button Example" | form.Caption = "Button Example" | ||
| Line 109: | Line 109: | ||
form.destroy() | form.destroy() | ||
| − | </ | + | </syntaxhighlight> |
{{LuaSeeAlso}} | {{LuaSeeAlso}} | ||
Latest revision as of 00:44, 27 June 2026
The Button class represents a clickable button control.
A Button inherits from ButtonControl, WinControl, Control, Component, and Object. It can be created with createButton and must belong to an owner inherited from WinControl.
Inheritance[edit]
| Class | Inherits From | Description |
|---|---|---|
| Button | ButtonControl | A clickable button control. |
| ButtonControl | WinControl | Base class for button-like controls. |
| WinControl | Control | Base class for windowed controls. |
| Control | Component | Base class for visual controls. |
| Component | Object | Base class for components. |
Creation[edit]
Creates a Button object that belongs to the given owner.
The owner can be any object inherited from WinControl.
Function Parameters[edit]
| Parameter | Type | Description |
|---|---|---|
| owner | WinControl | The owner of the button. This can be any object inherited from WinControl. |
Properties[edit]
| Property | Type | Description |
|---|---|---|
| ModalResult | ModalResult | The result this button will give the modal form when clicked. |
Methods[edit]
| Method | Return Type | Description |
|---|---|---|
| getModalResult(button) | ModalResult | Returns the ModalResult value of the specified button. |
| setModalResult(button, mr) | void | Sets the ModalResult value of the specified button. |
Examples[edit]
1 local form = createForm()
2 form.Caption = "Button Example"
3
4 local button = createButton(form)
5 button.Parent = form
6 button.Caption = "Close"
7 button.Left = 20
8 button.Top = 20
9 button.Width = 100
10
11 button.ModalResult = mrOK
12
13 form.showModal()
14 form.destroy()
1 local form = createForm()
2 form.Caption = "Button Example"
3
4 local button = createButton(form)
5 button.Parent = form
6 button.Caption = "OK"
7
8 setModalResult(button, mrOK)
9
10 print("ModalResult: " .. tostring(getModalResult(button)))
11
12 form.destroy()
