GuiGetProperties - Revision history

LordHenry: /* See Also */

2018-11-21T17:17:06Z

StrixG: OOP syntax

2018-11-07T16:00:08Z

OOP syntax

← Older revision		Revision as of 16:00, 7 November 2018
Line 7:		Line 7:
	table guiGetProperties ( element guiElement )		table guiGetProperties ( element guiElement )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[GUI widgets\|GuiElement]]:getProperties\|properties\|}}

	===Required Arguments===		===Required Arguments===

Zver-CR at 12:18, 26 July 2017

2017-07-26T12:18:14Z

← Older revision		Revision as of 12:18, 26 July 2017
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function gets a list of the CEGUI property names and values of a GUI element. To find out what the different properties mean, check out the [http://~~www~~.cegui.org.uk/~~wiki~~/~~index~~.~~php/SetProperty_(WindowsLook)~~ CEGUI properties ~~wiki~~ page].		This function gets a list of the CEGUI property names and values of a GUI element. To find out what the different properties mean, check out the [http://static.cegui.org.uk/static/WindowsLookProperties.html CEGUI properties page].

	==Syntax==		==Syntax==

Arc at 19:05, 18 January 2008

2008-01-18T19:05:51Z

← Older revision		Revision as of 19:05, 18 January 2008
Line 12:		Line 12:

	===Returns===		===Returns===
	If the function succeeds, the return value is a table. Its keys are property names, the corresponding values are the values of the properties. If the function fails, it returns ''false''.		If the function succeeds, the return value is a table. Its keys are property names, the corresponding values are the values of the properties (both names and values are always strings). If the function fails, it returns ''false''.

	==Example==		==Example==

Arc at 19:01, 18 January 2008

2008-01-18T19:01:59Z

← Older revision		Revision as of 19:01, 18 January 2008
Line 28:		Line 28:
	)		)
	</syntaxhighlight>		</syntaxhighlight>

			==See Also==
			{{GUI functions}}

Arc: New page: {{Client function}} NOTOC This function gets a list of the CEGUI property names and values of a GUI element. To find out what the different properties mean, check out the [http://www.c...

2008-01-18T18:46:58Z

New page: {{Client function}} __NOTOC__ This function gets a list of the CEGUI property names and values of a GUI element. To find out what the different properties mean, check out the [http://www.c...

New page

{{Client function}}
__NOTOC__
This function gets a list of the CEGUI property names and values of a GUI element. To find out what the different properties mean, check out the [http://www.cegui.org.uk/wiki/index.php/SetProperty_(WindowsLook) CEGUI properties wiki page].

==Syntax==
<syntaxhighlight lang="lua">
table guiGetProperties ( element guiElement )
</syntaxhighlight>

===Required Arguments===
*'''guiElement:''' the GUI element you wish to get the properties of.

===Returns===
If the function succeeds, the return value is a table. Its keys are property names, the corresponding values are the values of the properties. If the function fails, it returns ''false''.

==Example==
The following example code will create a button and lists its properties in the console if the /btn command is entered.

<syntaxhighlight lang="lua">
addCommandHandler("btn",
function()
local btn = guiCreateButton(20, 200, 150, 30, "Test", false)
local props = guiGetProperties(btn)
for propName,propVal in pairs(props) do
outputConsole(propName .. " = " .. propVal)
end
end
)
</syntaxhighlight>

← Older revision		Revision as of 17:17, 21 November 2018
Line 32:		Line 32:
	==See Also==		==See Also==
	{{GUI functions}}		{{GUI functions}}
			{{GUI_events}}