Difference between revisions of "Lua:Class:Form"
m (Reverted edits by This content is not available (Talk) to last revision by TheyCallMeTim13) |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Lua]] | [[Category:Lua]] | ||
| − | '''Form Class''' (Inheritance ScrollingWinControl- | + | '''Form Class''' (Inheritance ''[[Lua:Class:ScrollingWinControl|ScrollingWinControl]]''->''[[Lua:Class:CustomControl|CustomControl]]''->''[[Lua:Class:WinControl|WinControl]]''->''[[Lua:Class:Control|Control]]''->''[[Lua:Class:Component|Component]]''->''[[Lua:Class:Object|Object]]'') |
| − | |||
| + | The Form class is a window | ||
'''createForm'''(visible OPT) | '''createForm'''(visible OPT) | ||
| − | + | Creates a Form class object(window) and returns the pointer for it. Visible is default true but can be changed | |
| + | '''createFormFromFile'''(filename) | ||
| + | Creates a Form class object and initializes it based on the data in the given file. | ||
| + | It returns the generated form | ||
| − | |||
| − | |||
| − | |||
== Properties == | == Properties == | ||
| Line 16: | Line 16: | ||
== Methods == | == Methods == | ||
| − | |||
| − | |||
'''saveToFile'''(filename) | '''saveToFile'''(filename) | ||
| − | + | Saves a userdefined form. (DOES NOT WORK ON NORMAL FORMS LIKE MAINFORM) | |
| − | |||
'''centerScreen'''() | '''centerScreen'''() | ||
| − | + | Places the form at the center of the screen | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | ''' | + | '''hide'''() |
| − | + | Hide the form | |
| + | '''show'''() | ||
| + | Show the form | ||
'''showModal'''() | '''showModal'''() | ||
| − | + | Show the form and wait for it to close and get the close result | |
| − | |||
'''isForegroundWindow'''() | '''isForegroundWindow'''() | ||
| − | + | returns true if the specified form has focus | |
| + | '''onClose'''(function) | ||
| + | function (sender) Return a CloseAction to determine how to close the window | ||
| − | ''' | + | '''getMenu'''(form) |
| − | + | Returns the mainmenu object of this form | |
| + | '''setMenu'''(mainmenu) | ||
| + | Sets a menu for the form | ||
| − | |||
| − | |||
| − | + | == Examples == | |
| − | |||
| − | |||
| − | |||
| − | |||
<pre> | <pre> | ||
function goodbyeMessage(sender) | function goodbyeMessage(sender) | ||
| Line 73: | Line 64: | ||
| − | + | {{LuaSeeAlso}} | |
| − | |||
| − | |||
Latest revision as of 19:07, 18 March 2019
Form Class (Inheritance ScrollingWinControl->CustomControl->WinControl->Control->Component->Object)
The Form class is a window
createForm(visible OPT) Creates a Form class object(window) and returns the pointer for it. Visible is default true but can be changed
createFormFromFile(filename) Creates a Form class object and initializes it based on the data in the given file. It returns the generated form
Contents
Properties[edit]
Methods[edit]
saveToFile(filename) Saves a userdefined form. (DOES NOT WORK ON NORMAL FORMS LIKE MAINFORM)
centerScreen() Places the form at the center of the screen
hide() Hide the form
show() Show the form
showModal() Show the form and wait for it to close and get the close result
isForegroundWindow() returns true if the specified form has focus
onClose(function) function (sender) Return a CloseAction to determine how to close the window
getMenu(form) Returns the mainmenu object of this form
setMenu(mainmenu) Sets a menu for the form
Examples[edit]
function goodbyeMessage(sender) print "called by form_onClose" closeCE() -- Just closes ce end local forms = createForm(true) -- true = visible(optional), false = not visible when created. forms.hide() -- hides the form sleep(3000) forms.show() -- again makes the form visible sleep(3000) forms.centerScreen() -- Places the form at the center of the screen if forms.isForegroundWindow(forms) then print "form in focus" end forms.onClose(goodbyeMessage) -- delegates goodbyeMessage function. goodbyeMessage should have the prototype "goodbyeMessage(oneArgument)"
