WoW:UIHANDLER OnClick - Revision history

Move page script: Move page script moved page UIHANDLER OnClick to WoW:UIHANDLER OnClick without leaving a redirect

2023-08-15T04:49:03Z

Move page script moved page UIHANDLER OnClick to UIHANDLER OnClick without leaving a redirect

← Older revision	Revision as of 04:49, 15 August 2023
(No difference)

WoWWiki>Direddyre at 00:42, 13 October 2008

2008-10-13T00:42:10Z

← Older revision		Revision as of 00:42, 13 October 2008
Line 9:		Line 9:
	==Example==		==Example==
	local taunts = {"I'm a button.", "Quit clicking me.", "That's enough.", "Stop it!", "I'm leaving!"};		local taunts = {"I'm a button.", "Quit clicking me.", "That's enough.", "Stop it!", "I'm leaving!"};
	local widget = CreateFrame("Button", "TauntingButton", UIParent, "~~UIPanelButonTemplate~~");		local widget = CreateFrame("Button", "TauntingButton", UIParent, "UIPanelButtonTemplate");
	widget:SetWidth(200); widget:SetHeight(24); widget:SetPoint("CENTER");		widget:SetWidth(200); widget:SetHeight(24); widget:SetPoint("CENTER");
	widget:RegisterForClicks("AnyUp");		widget:RegisterForClicks("AnyUp");
	widget:~~SetHandler~~("OnClick", function (self, button, down)		widget:SetScript("OnClick", function (self, button, down)
	self:SetID((self:GetID() or 1) + 1);		self:SetID((self:GetID() or 1) + 1);
	if taunts[self:GetID()] then		if taunts[self:GetID()] then

WoWWiki>Starlightblunder: /* Example */ +XML handlers

2008-10-11T19:59:27Z

Example: +XML handlers

← Older revision		Revision as of 19:59, 11 October 2008
Line 1:		Line 1:
	{{widgethandler}}~~<br>~~		{{widgethandler}}
			The '''OnClick''' handler is called when a UI widget that supports clicking (i.e. is derived from a Button) is clicked. Region derivatives like Frame only implement OnMouseDown / OnMouseUp handlers.
	~~== Description ==~~

	The OnClick handler is called when a UI ~~element~~ is clicked ~~with the mouse~~.

	== Arguments ==		== Arguments ==
			;self : widget being clicked
			;button : [mouse] button used to click the widget. Due to widget:Click(button, down), button argument may be anything, although the following five values are common for normal mouse clicks: "LeftButton", "RightButton", "MiddleButton", "Button4", "Button5".
			;down : Boolean - 1 (true) if the trigger button is currently being held down, nil (false) otherwise.

	~~self - the button being clicked~~		==Example==
			local taunts = {"I'm a button.", "Quit clicking me.", "That's enough.", "Stop it!", "I'm leaving!"};
	~~button -~~ a ~~string representing the~~ button ~~that was clicked~~.		local widget = CreateFrame("Button", "TauntingButton", UIParent, "UIPanelButonTemplate");
	~~Can be any of the following~~:		widget:SetWidth(200); widget:SetHeight(24); widget:SetPoint("CENTER");
	*LeftButton		widget:RegisterForClicks("AnyUp");
	*RightButton		widget:SetHandler("OnClick", function (self, button, down)
	*MiddleButton		self:SetID((self:GetID() or 1) + 1);
	*Button4		if taunts[self:GetID()] then
	*Button5		self:SetText(taunts[self:GetID()]);
	~~According to how the UI element is setup with~~ [~~[API_Button_RegisterForClicks]~~]		else
			self:Hide();
			end
			end);

	~~down - whether the~~ button ~~is down (1 or nil? true or false? someone please provide more info~~)		The named arguments are also available in XML handlers:
			<Button name="foo" ...>
			...
			<Scripts>
			...
			<OnClick>self:SetText("You clicked with " .. button);</OnClick>
			</Scripts>
			</Button>

WoWWiki>Mundocani at 23:04, 13 August 2008

2008-08-13T23:04:45Z

← Older revision		Revision as of 23:04, 13 August 2008
Line 7:		Line 7:
	== Arguments ==		== Arguments ==

	~~arg1~~ - a string representing the button that was clicked.		self - the button being clicked

			button - a string representing the button that was clicked.
	Can be any of the following:		Can be any of the following:
	*LeftButton		*LeftButton
Line 15:		Line 17:
	*Button5		*Button5
	According to how the UI element is setup with [[API_Button_RegisterForClicks]]		According to how the UI element is setup with [[API_Button_RegisterForClicks]]

			down - whether the button is down (1 or nil? true or false? someone please provide more info)

WoWWiki>Charibot: catfix, Replaced: {{widgethandler}} → {{widgethandler}}

2008-07-14T23:27:49Z

catfix, Replaced: {{widgethandler}} → {{widgethandler}}<br>

← Older revision		Revision as of 23:27, 14 July 2008
Line 1:		Line 1:
	{{widgethandler}}		{{widgethandler}}<br>

	== Description ==		== Description ==

WoWWiki>WoWWiki-Shirik: returned ~= passed

2007-10-06T03:24:55Z

returned ~= passed

← Older revision		Revision as of 03:24, 6 October 2007
Line 7:		Line 7:
	== Arguments ==		== Arguments ==

	arg1 - ~~returned as~~ a string representing the button that was clicked.		arg1 - a string representing the button that was clicked.
	Can be any of the following:		Can be any of the following:
	*LeftButton		*LeftButton

WoWWiki>Mikk: {{widgethandler}}

2006-06-09T22:15:13Z

← Older revision		Revision as of 22:15, 9 June 2006
Line 1:		Line 1:
			{{widgethandler}}

	== Description ==		== Description ==

Line 13:		Line 15:
	*Button5		*Button5
	According to how the UI element is setup with [[API_Button_RegisterForClicks]]		According to how the UI element is setup with [[API_Button_RegisterForClicks]]

	~~[[Category:World of Warcraft API]]~~

WoWWiki>Neogia at 01:31, 25 May 2006

2006-05-25T01:31:46Z

New page

== Description ==

The OnClick handler is called when a UI element is clicked with the mouse.

== Arguments ==

arg1 - returned as a string representing the button that was clicked.
Can be any of the following:
*LeftButton
*RightButton
*MiddleButton
*Button4
*Button5
According to how the UI element is setup with [[API_Button_RegisterForClicks]]

[[Category:World of Warcraft API]]