WoW:API EasyMenu - Revision history

Move page script: Move page script moved page API EasyMenu to WoW:API EasyMenu without leaving a redirect

2023-08-15T04:45:26Z

Move page script moved page API EasyMenu to API EasyMenu without leaving a redirect

← Older revision

Revision as of 04:45, 15 August 2023

173.31.208.168: Typo in menu table: "fuction" instead of "function".

2015-07-26T05:47:45Z

Typo in menu table: "fuction" instead of "function".

← Older revision		Revision as of 05:47, 26 July 2015
Line 20:		Line 20:
	local menu = {		local menu = {
	{ text = "Select an Option", isTitle = true},		{ text = "Select an Option", isTitle = true},
	{ text = "Option 1", func = ~~fuction~~() print("You've chosen option 1"); end },		{ text = "Option 1", func = function() print("You've chosen option 1"); end },
	{ text = "Option 2", func = function() print("You've chosen option 2"); end },		{ text = "Option 2", func = function() print("You've chosen option 2"); end },
	{ text = "More Options", hasArrow = true,		{ text = "More Options", hasArrow = true,

109.188.124.5: /* Example */

2014-11-10T13:42:09Z

Example

← Older revision		Revision as of 13:42, 10 November 2014
Line 20:		Line 20:
	local menu = {		local menu = {
	{ text = "Select an Option", isTitle = true},		{ text = "Select an Option", isTitle = true},
	{ text = "Option 1", func = ~~function~~() print("You've chosen option 1"); end },		{ text = "Option 1", func = fuction() print("You've chosen option 1"); end },
	{ text = "Option 2", func = function() print("You've chosen option 2"); end },		{ text = "Option 2", func = function() print("You've chosen option 2"); end },
	{ text = "More Options", hasArrow = true,		{ text = "More Options", hasArrow = true,

WoWWiki>Egingell: /* Example */ Code looks better when it's lined up properly. Also, you missed a variable name, Starlightblunder. :)

2010-05-21T21:12:45Z

Example: Code looks better when it's lined up properly. Also, you missed a variable name, Starlightblunder. :)

← Older revision		Revision as of 21:12, 21 May 2010
Line 19:		Line 19:
	The following example creates a context menu based on a table description:		The following example creates a context menu based on a table description:
	local menu = {		local menu = {
	{ text = "Select an Option", isTitle = true},		{ text = "Select an Option", isTitle = true},
	{ text = "Option 1", func = function() print("You've chosen option 1"); end },		{ text = "Option 1", func = function() print("You've chosen option 1"); end },
	{ text = "Option 2", func = function() print("You've chosen option 2"); end },		{ text = "Option 2", func = function() print("You've chosen option 2"); end },
	{ text = "More Options", hasArrow = true,		{ text = "More Options", hasArrow = true,
	menuList = {		menuList = {
	{ text = "Option 3", func = function() print("You've chosen option 3"); end }		{ text = "Option 3", func = function() print("You've chosen option 3"); end }
	}		}
	}		}
	};		}
	local menuFrame = CreateFrame("Frame", "ExampleMenuFrame", UIParent, "UIDropDownMenuTemplate")		local menuFrame = CreateFrame("Frame", "ExampleMenuFrame", UIParent, "UIDropDownMenuTemplate")

WoWWiki>Starlightblunder: fix frame in SetPoint call

2010-05-21T21:10:00Z

fix frame in SetPoint call

← Older revision		Revision as of 21:10, 21 May 2010
Line 31:		Line 31:

	-- Make the menu appear at the cursor:		-- Make the menu appear at the cursor:
	EasyMenu(~~menuList~~, menuFrame, "cursor", 0 , 0, "MENU");		EasyMenu(menu, menuFrame, "cursor", 0 , 0, "MENU");
	-- Or make the menu appear at the frame:		-- Or make the menu appear at the frame:
	~~menu_frame~~:SetPoint("Center", UIParent, "Center")		menuFrame:SetPoint("Center", UIParent, "Center")
	EasyMenu(~~menuList~~, menuFrame, menuFrame, 0 , 0, "MENU");		EasyMenu(menu, menuFrame, menuFrame, 0 , 0, "MENU");

	==Notes==		==Notes==

WoWWiki>Egingell: /* Example */

2010-05-09T00:11:19Z

Example

← Older revision		Revision as of 00:11, 9 May 2010
Line 36:		Line 36:
	EasyMenu(menuList, menuFrame, menuFrame, 0 , 0, "MENU");		EasyMenu(menuList, menuFrame, menuFrame, 0 , 0, "MENU");

	~~<b>Note:</b>~~ You <i>must</i> give the frame a name (argument 2 to CreateFrame()) for menus to work.		==Notes==
			* You <i>must</i> give the frame a name (argument 2 to {{api\|CreateFrame}}()) for menus to work.

	== See Also ==		== See Also ==
	* [[UI Object UIDropDownMenu]]		* [[UI Object UIDropDownMenu]]
	* [[Using UIDropDownMenu]]		* [[Using UIDropDownMenu]]

WoWWiki>Iamcal: very useful note. please don't remove

2010-05-09T00:00:19Z

very useful note. please don't remove

← Older revision		Revision as of 00:00, 9 May 2010
Line 35:		Line 35:
	menu_frame:SetPoint("Center", UIParent, "Center")		menu_frame:SetPoint("Center", UIParent, "Center")
	EasyMenu(menuList, menuFrame, menuFrame, 0 , 0, "MENU");		EasyMenu(menuList, menuFrame, menuFrame, 0 , 0, "MENU");

			<b>Note:</b> You <i>must</i> give the frame a name (argument 2 to CreateFrame()) for menus to work.

	== See Also ==		== See Also ==
	* [[UI Object UIDropDownMenu]]		* [[UI Object UIDropDownMenu]]
	* [[Using UIDropDownMenu]]		* [[Using UIDropDownMenu]]

WoWWiki>Starlightblunder: /* Example */ single block of code

2010-04-08T01:06:02Z

Example: single block of code

← Older revision		Revision as of 01:06, 8 April 2010
Line 1:		Line 1:
	{{framexmlfunc\|FrameXML/EasyMenu.lua}}		{{framexmlfunc\|FrameXML/EasyMenu.lua}} __NOTOC__
	~~Easily create~~ context ~~menus on the fly~~ with ~~clickable items~~.		Populate a context menu with options described in a provided table.
	EasyMenu(menuList, menuFrame, anchor, x, y, displayMode, autoHideDelay)		EasyMenu(menuList, menuFrame, anchor, x, y, displayMode, autoHideDelay)

	==Arguments==		==Arguments==
	;menuList : Table - ~~see~~ [[#~~Details~~\|~~Details~~]] ~~for~~ key~~/value descriptions~~.		;menuList : Table - an array of tables describing the entries in the menu to be created. The descriptions may use any key-value tables used in a [[UI_Object_UIDropDownMenu#The_info_table\|UIDropDownMenu info table]]; as a bare minimum, each option should specify the "text" key.
	;menuFrame : Frame - the ~~UI frame to populate~~.		;menuFrame : Frame - a Frame object that will be used to store some information about the menu.
	;anchor : String - ~~Just like in~~ the ~~[[UIOBJECT_GameTooltip\|GameTooltip]] this is the anchor point~~.		;anchor : String/Region - Specify what to anchor the menu relative to: either "cursor", a region name, or a region (frame) reference.
	;x : Number - x offset.		;x : Number - x offset from the anchor.
	;y : Number - y offset		;y : Number - y offset from the anchor.
	;displayMode : String - "MENU" enables a tooltip-styled context menu, any other value the dropdown style.		;displayMode : String - "MENU" enables a tooltip-styled context menu, any other value the dropdown style.
	;autoHideDelay : Number - Automatically hide the menu after this many seconds.		;autoHideDelay : Number - Automatically hide the menu after this many seconds.

	==Details==		== Details ==
	~~;menuList : This needs to be a table in the following format.~~
	{
	{
	~~text = "Menu Item 1", -- string. This is the text to put on this menu item.~~
	~~func = function() DoStuff() end, -- function. This is the function that will fire when you click on this menu item.~~
	},
	{
	~~text = "Menu Item 2",~~
	~~func = function() DoOtherStuff() end,~~
	},
	~~-- ...~~
	}

	~~:See "List of button attributes" in the [[FrameXML]] file [http://wdn.wowinterface.com/code/live/FrameXML/UIDropDownMenu.lua ''UIDropDownMenu.lua''] for the full list of available table elements.~~

	~~== Notes~~ ==
	* The menu becomes visible as soon as you call the function and goes away after you click a menu item unless keepShownOnClick in '''menuList''' was set to 1.		* The menu becomes visible as soon as you call the function and goes away after you click a menu item unless keepShownOnClick in '''menuList''' was set to 1.
			* Fine-grained control over the positioning of the menu is possible by setting the menuFrame.point and menuFrame.relativePoint values to specific anchor points to use when anchoring the frame to a non-cursor region.

	==~~Examples~~==		==Example==
			The following example creates a context menu based on a table description:
	local ~~menu_frame~~ = CreateFrame("Frame", "ExampleMenuFrame", UIParent, "UIDropDownMenuTemplate")		local menu = {
			{ text = "Select an Option", isTitle = true},
			{ text = "Option 1", func = function() print("You've chosen option 1"); end },
			{ text = "Option 2", func = function() print("You've chosen option 2"); end },
			{ text = "More Options", hasArrow = true,
			menuList = {
			{ text = "Option 3", func = function() print("You've chosen option 3"); end }
			}
			}
			};
			local menuFrame = CreateFrame("Frame", "ExampleMenuFrame", UIParent, "UIDropDownMenuTemplate")

	~~local function onOption1()~~		-- Make the menu appear at the cursor:
	-- ~~do stuff~~		EasyMenu(menuList, menuFrame, "cursor", 0 , 0, "MENU");
	~~end~~		-- Or make the menu appear at the frame:
	~~local function onOption2()~~		menu_frame:SetPoint("Center", UIParent, "Center")
	~~-- do stuff~~		EasyMenu(menuList, menuFrame, menuFrame, 0 , 0, "MENU");
	~~end~~

	~~local menuList = {~~
	~~{ text = "Option 1", func = onOption1 },~~
	~~{ text = "Option 2", func = onOption2 }~~
	}

	~~menu_frame:SetPoint("Center", UIParent, "Center") -- setup position of~~ menu~~. Not needed if '~~cursor~~' is used as anchor in EasyMenu~~
	EasyMenu(menuList, menuFrame, "~~ExampleMenuFrame~~", 0 , 0, "MENU")

	~~Above example creates "MENU" type poupup menu.~~
	~~To crate standard~~ menu:
	~~local~~ menu_frame ~~= CreateFrame~~("~~Frame~~", "~~ExampleMenuFrame~~"~~, UIParent~~)
	~~...~~
	EasyMenu(menuList, menuFrame, ~~"ExampleMenuFrame"~~, 0 , 0)

	~~<b>Note:</b> You <i>must</i> give the frame a name (argument 2 to CreateFrame()) for menus to work.~~

	== See Also ==		== See Also ==
	* [[UI Object UIDropDownMenu]]		* [[UI Object UIDropDownMenu]]
	* [[Using UIDropDownMenu]]		* [[Using UIDropDownMenu]]

WoWWiki>Iamcal: a note about naming frames

2009-12-02T08:30:55Z

a note about naming frames

← Older revision		Revision as of 08:30, 2 December 2009
Line 55:		Line 55:
	...		...
	EasyMenu(menuList, menuFrame, "ExampleMenuFrame", 0 , 0)		EasyMenu(menuList, menuFrame, "ExampleMenuFrame", 0 , 0)

			<b>Note:</b> You <i>must</i> give the frame a name (argument 2 to CreateFrame()) for menus to work.

	== See Also ==		== See Also ==
	* [[UI Object UIDropDownMenu]]		* [[UI Object UIDropDownMenu]]
	* [[Using UIDropDownMenu]]		* [[Using UIDropDownMenu]]

WoWWiki>Starlightblunder: /* Examples */ yank howto link; it's also in see also

2009-11-13T16:41:29Z

Examples: yank howto link; it's also in see also

← Older revision		Revision as of 16:41, 13 November 2009
Line 1:		Line 1:
	~~<br>~~{{framexmlfunc\|FrameXML/EasyMenu.lua}}		{{framexmlfunc\|FrameXML/EasyMenu.lua}}
	Easily create context menus on the fly with clickable items.		Easily create context menus on the fly with clickable items.

	EasyMenu(menuList, menuFrame, anchor, x, y, displayMode, autoHideDelay)		EasyMenu(menuList, menuFrame, anchor, x, y, displayMode, autoHideDelay)

	==Arguments==		==Arguments==
			;menuList : Table - see [[#Details\|Details]] for key/value descriptions.
	~~:(menuList, menuFrame, anchor, x, y, displayMode, autoHideDelay)~~		;menuFrame : Frame - the UI frame to populate.
	:;menuList : Table (see [[#Details\|Details]])		;anchor : String - Just like in the [[UIOBJECT_GameTooltip\|GameTooltip]] this is the anchor point.
	:;menuFrame : the UI frame to populate.		;x : Number - x offset.
	:;anchor : Just like in the [[UIOBJECT_GameTooltip\|GameTooltip]] this is the anchor point.		;y : Number - y offset
	:;x : ~~X position~~.		;displayMode : String - "MENU" enables a tooltip-styled context menu, any other value the dropdown style.
	:;y : ~~Y position.~~		;autoHideDelay : Number - Automatically hide the menu after this many seconds.
	:;displayMode : ~~The display mode. Usually~~ "MENU".
	:;autoHideDelay : Automatically hide the menu after this many seconds.

	==Details==		==Details==
			;menuList : This needs to be a table in the following format.
	:;menuList : This needs to be a table in the following format.
	{		{
	{		{
Line 42:		Line 38:
	-- do stuff		-- do stuff
	end		end

	local function onOption2()		local function onOption2()
	-- do stuff		-- do stuff
Line 55:		Line 50:
	EasyMenu(menuList, menuFrame, "ExampleMenuFrame", 0 , 0, "MENU")		EasyMenu(menuList, menuFrame, "ExampleMenuFrame", 0 , 0, "MENU")

	Above example creates "MENU" type poupup menu ~~(see [[HOWTO: Use UIDropDownMenu]])~~.		Above example creates "MENU" type poupup menu.
	To crate standard menu:		To crate standard menu:
	local menu_frame = CreateFrame("Frame", "ExampleMenuFrame", UIParent)		local menu_frame = CreateFrame("Frame", "ExampleMenuFrame", UIParent)
Line 62:		Line 57:

	== See Also ==		== See Also ==
	*[[UI Object UIDropDownMenu]]		* [[UI Object UIDropDownMenu]]
	*[[~~HOWTO: Use~~ UIDropDownMenu]]		* [[Using UIDropDownMenu]]