WoW:API EasyMenu: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(a note about naming frames)
m (Move page script moved page API EasyMenu to API EasyMenu without leaving a redirect)
 
(7 intermediate revisions by 5 users not shown)
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},
local function onOption1()
    { text = "Option 1", func = function() print("You've chosen option 1"); end },
  -- do stuff
    { text = "Option 2", func = function() print("You've chosen option 2"); end },
end
    { text = "More Options", hasArrow = true,
local function onOption2()
        menuList = {
  -- do stuff
            { text = "Option 3", func = function() print("You've chosen option 3"); end }
end
        }
    }
local menuList = {
  { text = "Option 1", func = onOption1 },
  { text = "Option 2", func = onOption2 }
  }
  }
local menuFrame = CreateFrame("Frame", "ExampleMenuFrame", UIParent, "UIDropDownMenuTemplate")
   
   
  menu_frame:SetPoint("Center", UIParent, "Center") -- setup position of menu. Not needed if 'cursor' is used as anchor in EasyMenu
  -- Make the menu appear at the cursor:
  EasyMenu(menuList, menuFrame, "ExampleMenuFrame", 0 , 0, "MENU")
  EasyMenu(menu, menuFrame, "cursor", 0 , 0, "MENU");
 
-- Or make the menu appear at the frame:
Above example creates "MENU" type poupup menu.
  menuFrame:SetPoint("Center", UIParent, "Center")
To crate standard menu:
  EasyMenu(menu, menuFrame, menuFrame, 0 , 0, "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.
==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]]

Latest revision as of 04:45, 15 August 2023

← WoW API < EasyMenu

"I" iconThis function is implemented in Lua here FrameXML/EasyMenu.lua.

Populate a context menu with options described in a provided table. 

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

Arguments[edit]

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 UIDropDownMenu info table; as a bare minimum, each option should specify the "text" key.
menuFrame
Frame - a Frame object that will be used to store some information about the menu.
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 from the anchor.
y
Number - y offset from the anchor.
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.

Details[edit]

  • 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.

Example[edit]

The following example creates a context menu based on a table description: 

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")

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

Notes[edit]

  • You must give the frame a name (argument 2 to CreateFrame()) for menus to work.

See Also[edit]

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_EasyMenu&oldid=18738"