Lua:Class:Form - Revision history

Dark Byte: Reverted edits by This content is not available (Talk) to last revision by TheyCallMeTim13

2019-03-18T19:07:26Z

Reverted edits by This content is not available (Talk) to last revision by TheyCallMeTim13

This content is not available: Replaced content with 'Sorry! Content not available.'

2019-03-16T15:58:21Z

Replaced content with '<span style="font-size:25px;color:red">Sorry! Content not available.</span>'

TheyCallMeTim13 at 01:57, 25 January 2018

2018-01-25T01:57:15Z

TheyCallMeTim13 at 01:55, 25 January 2018

2018-01-25T01:55:23Z

TheyCallMeTim13: moved Form to Lua:Class:Form

2018-01-25T00:19:12Z

moved Form to Lua:Class:Form

TheyCallMeTim13 at 21:53, 19 March 2017

2017-03-19T21:53:17Z

TheyCallMeTim13 at 11:49, 19 March 2017

2017-03-19T11:49:49Z

Dark Byte at 23:48, 17 January 2017

2017-01-17T23:48:02Z

Dark Byte at 23:45, 17 January 2017

2017-01-17T23:45:13Z

Freiza at 06:49, 14 April 2012

2012-04-14T06:49:57Z

← Older revision		Revision as of 19:07, 18 March 2019
Line 1:		Line 1:
−	~~<span style="font~~-~~size~~:~~25px~~;~~color~~:~~red~~"~~>Sorry! Content~~ not ~~available~~.</~~span~~>	+	[[Category:Lua]]
		+	'''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)
		+	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 ==
		+
		+
		+	== Methods ==
		+	'''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 ==
		+	<pre>
		+	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)"
		+	</pre>
		+
		+
		+	{{LuaSeeAlso}}

← Older revision		Revision as of 15:58, 16 March 2019
Line 1:		Line 1:
−	~~[[Category:Lua]]~~	+	<span style="font-size:25px;color:red">Sorry! Content not available.</span>
−	~~'''Form Class''' (Inheritance ''[[Lua:Class:ScrollingWinControl\|ScrollingWinControl]]''~~-~~>''[[Lua:Class~~:~~CustomControl\|CustomControl]]''-&gt~~;~~''[[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)~~
−	~~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 ==~~
−
−
−	~~== Methods ==~~
−	~~'''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 ==~~
−	~~<pre~~>
−	~~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)"~~
−	</~~pre~~>
−
−
−	~~{{LuaSeeAlso}}~~

@@ Line 1: / Line 1: @@
 [[Category:Lua]]
 '''Form Class''' (Inheritance ''[[Lua:Class:ScrollingWinControl|ScrollingWinControl]]''-&gt;''[[Lua:Class:CustomControl|CustomControl]]''-&gt;''[[Lua:Class:WinControl|WinControl]]''-&gt;''[[Lua:Class:Control|Control]]''-&gt;''[[Lua:Class:Component|Component]]''-&gt;''[[Lua:Class:Object|Object]]'')
 '''createForm'''(visible OPT)
-  Creates a Form class object(window) and returns the pointer for it. Visible is default true but can be changed
+Creates a Form class object(window) and returns the pointer for it. Visible is default true but can be changed
 == Properties ==
@@ Line 18: / Line 17: @@
 == Methods ==
 '''saveToFile'''(filename)
-  Saves a userdefined form. (DOES NOT WORK ON NORMAL FORMS LIKE MAINFORM)
+Saves a userdefined form. (DOES NOT WORK ON NORMAL FORMS LIKE MAINFORM)
 '''centerScreen'''()
-  Places the form at the center of the screen
+Places the form at the center of the screen
 '''hide'''()
-  Hide the form
+Hide the form
 '''show'''()
-  Show the form
+Show the form
 '''showModal'''()
-  Show the form and wait for it to close and get the close result
+Show the form and wait for it to close and get the close result
 '''isForegroundWindow'''()
-  returns true if the specified form has focus
+returns true if the specified form has focus
 '''onClose'''(function)
-  function (sender)  Return a CloseAction to determine how to close the window
+function (sender) Return a CloseAction to determine how to close the window
 '''getMenu'''(form)
-  Returns the mainmenu object of this form
+Returns the mainmenu object of this form
 '''setMenu'''(mainmenu)
-  Sets a menu for the form
+Sets a menu for the form

@@ Line 1: / Line 1: @@
 [[Category:Lua]]
-'''Form Class''' (Inheritance ScrollingWinControl->CustomControl->WinControl->Control->Component->Object)
+'''Form Class''' (Inheritance ''[[Lua:Class:ScrollingWinControl|ScrollingWinControl]]''-&gt;''[[Lua:Class:CustomControl|CustomControl]]''-&gt;''[[Lua:Class:WinControl|WinControl]]''-&gt;''[[Lua:Class:Control|Control]]''-&gt;''[[Lua:Class:Component|Component]]''-&gt;''[[Lua:Class:Object|Object]]'')
    The Form class is a window
@@ Line 16: / Line 17: @@
 == Methods ==
 '''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
-Example:
 <pre>
 function goodbyeMessage(sender)

← Older revision		Revision as of 21:53, 19 March 2017
Line 73:		Line 73:


−	~~----~~	+	{{LuaSeeAlso}}
−
−	* [[Lua\|Lua Functions and Classes]]

← Older revision	Revision as of 00:19, 25 January 2018
(No difference)

@@ Line 11: / Line 11: @@
    It returns the generated form
-'''form_saveToFile'''(form, filename)
    Saves a userdefined form. (DOES NOT WORK ON NORMAL FORMS LIKE MAINFORM)
-'''form_centerScreen'''(form)
+'''centerScreen'''()
    Places the form at the center of the screen
-'''form_hide'''(form)
+'''hide'''()
    Hide the form
-'''form_show'''(form)
+'''show'''()
    Show the form
-'''form_showModal'''(form)
+'''showModal'''()
    Show the form and wait for it to close and get the close result
-'''form_isForegroundWindow'''(form)
+'''isForegroundWindow'''()
    returns true if the specified form has focus
-'''form_onClose'''(form, function)
+'''onClose'''(function)
    function (sender)  Return a CloseAction to determine how to close the window
-'''form_getMenu'''(form)
+'''getMenu'''(form)
    Returns the mainmenu object of this form
-'''form_setMenu'''(form, mainmenu)
+'''setMenu'''(mainmenu)
    Sets a menu for the form
@@ Line 55: / Line 60: @@
 local forms = createForm(true) -- true = visible(optional), false = not visible when created.
-form_hide(forms)               -- hides the form
+forms.hide()               -- hides the form
 sleep(3000)
-form_show(forms)                -- again makes the form visible
+forms.show()                -- again makes the form visible
 sleep(3000)
-form_centerScreen(forms)       -- Places the form at the center of the screen
+forms.centerScreen()       -- Places the form at the center of the screen
-if form_isForegroundWindow(forms)  then
+if forms.isForegroundWindow(forms)  then
    print "form in focus"
 end
-form_onClose(forms, goodbyeMessage)   -- delegates goodbyeMessage function. goodbyeMessage should have the prototype "goodbyeMessage(oneArgument)"
+forms.onClose(goodbyeMessage)   -- delegates goodbyeMessage function. goodbyeMessage should have the prototype "goodbyeMessage(oneArgument)"
 </pre>

← Older revision		Revision as of 06:49, 14 April 2012
Line 46:		Line 46:
	'''form_setMenu'''(form, mainmenu)		'''form_setMenu'''(form, mainmenu)
	Sets a menu for the form		Sets a menu for the form
		+
		+	Example:
		+	<pre>
		+	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.
		+	form_hide(forms) -- hides the form
		+	sleep(3000)
		+	form_show(forms) -- again makes the form visible
		+	sleep(3000)
		+	form_centerScreen(forms) -- Places the form at the center of the screen
		+	if form_isForegroundWindow(forms) then
		+	print "form in focus"
		+	end
		+	form_onClose(forms, goodbyeMessage) -- delegates goodbyeMessage function. goodbyeMessage should have the prototype "goodbyeMessage(oneArgument)"
		+	</pre>