1 --[[ $Id: AceGUIWidget-DropDown.lua 1161 2017-08-12 14:30:16Z funkydude $ ]]--
2 local AceGUI = LibStub("AceGUI-3.0")
5 local min, max, floor = math.min, math.max, math.floor
6 local select, pairs, ipairs, type = select, pairs, ipairs, type
7 local tsort = table.sort
10 local PlaySound = PlaySound
11 local UIParent, CreateFrame = UIParent, CreateFrame
14 -- Global vars/functions that we don't upvalue since they might get hooked, or upgraded
15 -- List them here for Mikk's FindGlobals script
18 local function fixlevels(parent,...)
20 local child = select(i, ...)
22 child:SetFrameLevel(parent:GetFrameLevel()+1)
23 fixlevels(child, child:GetChildren())
25 child = select(i, ...)
29 local function fixstrata(strata, parent, ...)
31 local child = select(i, ...)
32 parent:SetFrameStrata(strata)
34 fixstrata(strata, child, child:GetChildren())
36 child = select(i, ...)
41 local widgetType = "Dropdown-Pullout"
42 local widgetVersion = 3
47 bgFile = "Interface\\ChatFrame\\ChatFrameBackground",
48 edgeFile = "Interface\\DialogFrame\\UI-DialogBox-Border",
52 insets = { left = 11, right = 12, top = 12, bottom = 11 },
54 local sliderBackdrop = {
55 bgFile = "Interface\\Buttons\\UI-SliderBar-Background",
56 edgeFile = "Interface\\Buttons\\UI-SliderBar-Border",
57 tile = true, tileSize = 8, edgeSize = 8,
58 insets = { left = 3, right = 3, top = 3, bottom = 3 }
61 local defaultWidth = 200
62 local defaultMaxHeight = 600
64 --[[ UI Event Handlers ]]--
66 -- HACK: This should be no part of the pullout, but there
67 -- is no other 'clean' way to response to any item-OnEnter
68 -- Used to close Submenus when an other item is entered
69 local function OnEnter(item)
70 local self = item.pullout
71 for k, v in ipairs(self.items) do
72 if v.CloseMenu and v ~= item then
78 -- See the note in Constructor() for each scroll related function
79 local function OnMouseWheel(this, value)
80 this.obj:MoveScroll(value)
83 local function OnScrollValueChanged(this, value)
84 this.obj:SetScroll(value)
87 local function OnSizeChanged(this)
91 --[[ Exported methods ]]--
94 local function SetScroll(self, value)
95 local status = self.scrollStatus
96 local frame, child = self.scrollFrame, self.itemFrame
97 local height, viewheight = frame:GetHeight(), child:GetHeight()
100 if height > viewheight then
103 offset = floor((viewheight - height) / 1000 * value)
105 child:ClearAllPoints()
106 child:SetPoint("TOPLEFT", frame, "TOPLEFT", 0, offset)
107 child:SetPoint("TOPRIGHT", frame, "TOPRIGHT", self.slider:IsShown() and -12 or 0, offset)
108 status.offset = offset
109 status.scrollvalue = value
113 local function MoveScroll(self, value)
114 local status = self.scrollStatus
115 local frame, child = self.scrollFrame, self.itemFrame
116 local height, viewheight = frame:GetHeight(), child:GetHeight()
118 if height > viewheight then
122 local diff = height - viewheight
127 self.slider:SetValue(min(max(status.scrollvalue + delta*(1000/(diff/45)),0), 1000))
132 local function FixScroll(self)
133 local status = self.scrollStatus
134 local frame, child = self.scrollFrame, self.itemFrame
135 local height, viewheight = frame:GetHeight(), child:GetHeight()
136 local offset = status.offset or 0
138 if viewheight < height then
140 child:SetPoint("TOPRIGHT", frame, "TOPRIGHT", 0, offset)
141 self.slider:SetValue(0)
144 local value = (offset / (viewheight - height) * 1000)
145 if value > 1000 then value = 1000 end
146 self.slider:SetValue(value)
147 self:SetScroll(value)
149 child:ClearAllPoints()
150 child:SetPoint("TOPLEFT", frame, "TOPLEFT", 0, offset)
151 child:SetPoint("TOPRIGHT", frame, "TOPRIGHT", -12, offset)
152 status.offset = offset
157 -- exported, AceGUI callback
158 local function OnAcquire(self)
159 self.frame:SetParent(UIParent)
160 --self.itemFrame:SetToplevel(true)
163 -- exported, AceGUI callback
164 local function OnRelease(self)
166 self.frame:ClearAllPoints()
171 local function AddItem(self, item)
172 self.items[#self.items + 1] = item
174 local h = #self.items * 16
175 self.itemFrame:SetHeight(h)
176 self.frame:SetHeight(min(h + 34, self.maxHeight)) -- +34: 20 for scrollFrame placement (10 offset) and +14 for item placement
178 item.frame:SetPoint("LEFT", self.itemFrame, "LEFT")
179 item.frame:SetPoint("RIGHT", self.itemFrame, "RIGHT")
181 item:SetPullout(self)
182 item:SetOnEnter(OnEnter)
186 local function Open(self, point, relFrame, relPoint, x, y)
187 local items = self.items
188 local frame = self.frame
189 local itemFrame = self.itemFrame
191 frame:SetPoint(point, relFrame, relPoint, x, y)
195 for i, item in pairs(items) do
197 item:SetPoint("TOP", itemFrame, "TOP", 0, -2)
199 item:SetPoint("TOP", items[i-1].frame, "BOTTOM", 0, 1)
206 itemFrame:SetHeight(height)
207 fixstrata("TOOLTIP", frame, frame:GetChildren())
213 local function Close(self)
219 local function Clear(self)
220 local items = self.items
221 for i, item in pairs(items) do
228 local function IterateItems(self)
229 return ipairs(self.items)
233 local function SetHideOnLeave(self, val)
234 self.hideOnLeave = val
238 local function SetMaxHeight(self, height)
239 self.maxHeight = height or defaultMaxHeight
240 if self.frame:GetHeight() > height then
241 self.frame:SetHeight(height)
242 elseif (self.itemFrame:GetHeight() + 34) < height then
243 self.frame:SetHeight(self.itemFrame:GetHeight() + 34) -- see :AddItem
248 local function GetRightBorderWidth(self)
249 return 6 + (self.slider:IsShown() and 12 or 0)
253 local function GetLeftBorderWidth(self)
257 --[[ Constructor ]]--
259 local function Constructor()
260 local count = AceGUI:GetNextWidgetNum(widgetType)
261 local frame = CreateFrame("Frame", "AceGUI30Pullout"..count, UIParent)
264 self.type = widgetType
268 self.OnAcquire = OnAcquire
269 self.OnRelease = OnRelease
271 self.AddItem = AddItem
275 self.IterateItems = IterateItems
276 self.SetHideOnLeave = SetHideOnLeave
278 self.SetScroll = SetScroll
279 self.MoveScroll = MoveScroll
280 self.FixScroll = FixScroll
282 self.SetMaxHeight = SetMaxHeight
283 self.GetRightBorderWidth = GetRightBorderWidth
284 self.GetLeftBorderWidth = GetLeftBorderWidth
288 self.scrollStatus = {
292 self.maxHeight = defaultMaxHeight
294 frame:SetBackdrop(backdrop)
295 frame:SetBackdropColor(0, 0, 0)
296 frame:SetFrameStrata("FULLSCREEN_DIALOG")
297 frame:SetClampedToScreen(true)
298 frame:SetWidth(defaultWidth)
299 frame:SetHeight(self.maxHeight)
300 --frame:SetToplevel(true)
302 -- NOTE: The whole scroll frame code is copied from the AceGUI-3.0 widget ScrollFrame
303 local scrollFrame = CreateFrame("ScrollFrame", nil, frame)
304 local itemFrame = CreateFrame("Frame", nil, scrollFrame)
306 self.scrollFrame = scrollFrame
307 self.itemFrame = itemFrame
309 scrollFrame.obj = self
312 local slider = CreateFrame("Slider", "AceGUI30PulloutScrollbar"..count, scrollFrame)
313 slider:SetOrientation("VERTICAL")
314 slider:SetHitRectInsets(0, 0, -10, 0)
315 slider:SetBackdrop(sliderBackdrop)
317 slider:SetThumbTexture("Interface\\Buttons\\UI-SliderBar-Button-Vertical")
318 slider:SetFrameStrata("FULLSCREEN_DIALOG")
322 scrollFrame:SetScrollChild(itemFrame)
323 scrollFrame:SetPoint("TOPLEFT", frame, "TOPLEFT", 6, -12)
324 scrollFrame:SetPoint("BOTTOMRIGHT", frame, "BOTTOMRIGHT", -6, 12)
325 scrollFrame:EnableMouseWheel(true)
326 scrollFrame:SetScript("OnMouseWheel", OnMouseWheel)
327 scrollFrame:SetScript("OnSizeChanged", OnSizeChanged)
328 scrollFrame:SetToplevel(true)
329 scrollFrame:SetFrameStrata("FULLSCREEN_DIALOG")
331 itemFrame:SetPoint("TOPLEFT", scrollFrame, "TOPLEFT", 0, 0)
332 itemFrame:SetPoint("TOPRIGHT", scrollFrame, "TOPRIGHT", -12, 0)
333 itemFrame:SetHeight(400)
334 itemFrame:SetToplevel(true)
335 itemFrame:SetFrameStrata("FULLSCREEN_DIALOG")
337 slider:SetPoint("TOPLEFT", scrollFrame, "TOPRIGHT", -16, 0)
338 slider:SetPoint("BOTTOMLEFT", scrollFrame, "BOTTOMRIGHT", -16, 0)
339 slider:SetScript("OnValueChanged", OnScrollValueChanged)
340 slider:SetMinMaxValues(0, 1000)
341 slider:SetValueStep(1)
350 AceGUI:RegisterAsWidget(self)
354 AceGUI:RegisterWidgetType(widgetType, Constructor, widgetVersion)
358 local widgetType = "Dropdown"
359 local widgetVersion = 31
361 --[[ Static data ]]--
363 --[[ UI event handler ]]--
365 local function Control_OnEnter(this)
366 this.obj.button:LockHighlight()
367 this.obj:Fire("OnEnter")
370 local function Control_OnLeave(this)
371 this.obj.button:UnlockHighlight()
372 this.obj:Fire("OnLeave")
375 local function Dropdown_OnHide(this)
376 local self = this.obj
382 local function Dropdown_TogglePullout(this)
383 local self = this.obj
384 PlaySound(PlaySoundKitID and "igMainMenuOptionCheckBoxOn" or 856) -- SOUNDKIT.IG_MAINMENU_OPTION_CHECKBOX_ON
391 self.pullout:SetWidth(self.pulloutWidth or self.frame:GetWidth())
392 self.pullout:Open("TOPLEFT", self.frame, "BOTTOMLEFT", 0, self.label:IsShown() and -2 or 0)
393 AceGUI:SetFocus(self)
397 local function OnPulloutOpen(this)
398 local self = this.userdata.obj
399 local value = self.value
401 if not self.multiselect then
402 for i, item in this:IterateItems() do
403 item:SetValue(item.userdata.value == value)
408 self:Fire("OnOpened")
411 local function OnPulloutClose(this)
412 local self = this.userdata.obj
414 self:Fire("OnClosed")
417 local function ShowMultiText(self)
419 for i, widget in self.pullout:IterateItems() do
420 if widget.type == "Dropdown-Item-Toggle" then
421 if widget:GetValue() then
423 text = text..", "..widget:GetText()
425 text = widget:GetText()
433 local function OnItemValueChanged(this, event, checked)
434 local self = this.userdata.obj
436 if self.multiselect then
437 self:Fire("OnValueChanged", this.userdata.value, checked)
441 self:SetValue(this.userdata.value)
442 self:Fire("OnValueChanged", this.userdata.value)
452 --[[ Exported methods ]]--
454 -- exported, AceGUI callback
455 local function OnAcquire(self)
456 local pullout = AceGUI:Create("Dropdown-Pullout")
457 self.pullout = pullout
458 pullout.userdata.obj = self
459 pullout:SetCallback("OnClose", OnPulloutClose)
460 pullout:SetCallback("OnOpen", OnPulloutOpen)
461 self.pullout.frame:SetFrameLevel(self.frame:GetFrameLevel() + 1)
462 fixlevels(self.pullout.frame, self.pullout.frame:GetChildren())
467 self:SetPulloutWidth(nil)
470 -- exported, AceGUI callback
471 local function OnRelease(self)
475 AceGUI:Release(self.pullout)
479 self:SetDisabled(false)
480 self:SetMultiselect(false)
487 self.frame:ClearAllPoints()
492 local function SetDisabled(self, disabled)
493 self.disabled = disabled
495 self.text:SetTextColor(0.5,0.5,0.5)
496 self.button:Disable()
497 self.button_cover:Disable()
498 self.label:SetTextColor(0.5,0.5,0.5)
501 self.button_cover:Enable()
502 self.label:SetTextColor(1,.82,0)
503 self.text:SetTextColor(1,1,1)
508 local function ClearFocus(self)
515 local function SetText(self, text)
516 self.text:SetText(text or "")
520 local function SetLabel(self, text)
521 if text and text ~= "" then
522 self.label:SetText(text)
524 self.dropdown:SetPoint("TOPLEFT",self.frame,"TOPLEFT",-15,-14)
526 self.alignoffset = 26
528 self.label:SetText("")
530 self.dropdown:SetPoint("TOPLEFT",self.frame,"TOPLEFT",-15,0)
532 self.alignoffset = 12
537 local function SetValue(self, value)
539 self:SetText(self.list[value] or "")
545 local function GetValue(self)
550 local function SetItemValue(self, item, value)
551 if not self.multiselect then return end
552 for i, widget in self.pullout:IterateItems() do
553 if widget.userdata.value == item then
554 if widget.SetValue then
555 widget:SetValue(value)
563 local function SetItemDisabled(self, item, disabled)
564 for i, widget in self.pullout:IterateItems() do
565 if widget.userdata.value == item then
566 widget:SetDisabled(disabled)
571 local function AddListItem(self, value, text, itemType)
572 if not itemType then itemType = "Dropdown-Item-Toggle" end
573 local exists = AceGUI:GetWidgetVersion(itemType)
574 if not exists then error(("The given item type, %q, does not exist within AceGUI-3.0"):format(tostring(itemType)), 2) end
576 local item = AceGUI:Create(itemType)
578 item.userdata.obj = self
579 item.userdata.value = value
580 item:SetCallback("OnValueChanged", OnItemValueChanged)
581 self.pullout:AddItem(item)
584 local function AddCloseButton(self)
585 if not self.hasClose then
586 local close = AceGUI:Create("Dropdown-Item-Execute")
588 self.pullout:AddItem(close)
595 local function SetList(self, list, order, itemType)
599 if not list then return end
601 if type(order) ~= "table" then
602 for v in pairs(list) do
603 sortlist[#sortlist + 1] = v
607 for i, key in ipairs(sortlist) do
608 AddListItem(self, key, list[key], itemType)
612 for i, key in ipairs(order) do
613 AddListItem(self, key, list[key], itemType)
616 if self.multiselect then
623 local function AddItem(self, value, text, itemType)
625 self.list[value] = text
626 AddListItem(self, value, text, itemType)
631 local function SetMultiselect(self, multi)
632 self.multiselect = multi
640 local function GetMultiselect(self)
641 return self.multiselect
644 local function SetPulloutWidth(self, width)
645 self.pulloutWidth = width
648 --[[ Constructor ]]--
650 local function Constructor()
651 local count = AceGUI:GetNextWidgetNum(widgetType)
652 local frame = CreateFrame("Frame", nil, UIParent)
653 local dropdown = CreateFrame("Frame", "AceGUI30DropDown"..count, frame, "UIDropDownMenuTemplate")
656 self.type = widgetType
658 self.dropdown = dropdown
663 self.OnRelease = OnRelease
664 self.OnAcquire = OnAcquire
666 self.ClearFocus = ClearFocus
668 self.SetText = SetText
669 self.SetValue = SetValue
670 self.GetValue = GetValue
671 self.SetList = SetList
672 self.SetLabel = SetLabel
673 self.SetDisabled = SetDisabled
674 self.AddItem = AddItem
675 self.SetMultiselect = SetMultiselect
676 self.GetMultiselect = GetMultiselect
677 self.SetItemValue = SetItemValue
678 self.SetItemDisabled = SetItemDisabled
679 self.SetPulloutWidth = SetPulloutWidth
681 self.alignoffset = 26
683 frame:SetScript("OnHide",Dropdown_OnHide)
685 dropdown:ClearAllPoints()
686 dropdown:SetPoint("TOPLEFT",frame,"TOPLEFT",-15,0)
687 dropdown:SetPoint("BOTTOMRIGHT",frame,"BOTTOMRIGHT",17,0)
688 dropdown:SetScript("OnHide", nil)
690 local left = _G[dropdown:GetName() .. "Left"]
691 local middle = _G[dropdown:GetName() .. "Middle"]
692 local right = _G[dropdown:GetName() .. "Right"]
694 middle:ClearAllPoints()
695 right:ClearAllPoints()
697 middle:SetPoint("LEFT", left, "RIGHT", 0, 0)
698 middle:SetPoint("RIGHT", right, "LEFT", 0, 0)
699 right:SetPoint("TOPRIGHT", dropdown, "TOPRIGHT", 0, 17)
701 local button = _G[dropdown:GetName() .. "Button"]
704 button:SetScript("OnEnter",Control_OnEnter)
705 button:SetScript("OnLeave",Control_OnLeave)
706 button:SetScript("OnClick",Dropdown_TogglePullout)
708 local button_cover = CreateFrame("BUTTON",nil,self.frame)
709 self.button_cover = button_cover
710 button_cover.obj = self
711 button_cover:SetPoint("TOPLEFT",self.frame,"BOTTOMLEFT",0,25)
712 button_cover:SetPoint("BOTTOMRIGHT",self.frame,"BOTTOMRIGHT")
713 button_cover:SetScript("OnEnter",Control_OnEnter)
714 button_cover:SetScript("OnLeave",Control_OnLeave)
715 button_cover:SetScript("OnClick",Dropdown_TogglePullout)
717 local text = _G[dropdown:GetName() .. "Text"]
720 text:ClearAllPoints()
721 text:SetPoint("RIGHT", right, "RIGHT" ,-43, 2)
722 text:SetPoint("LEFT", left, "LEFT", 25, 2)
724 local label = frame:CreateFontString(nil,"OVERLAY","GameFontNormalSmall")
725 label:SetPoint("TOPLEFT",frame,"TOPLEFT",0,0)
726 label:SetPoint("TOPRIGHT",frame,"TOPRIGHT",0,0)
727 label:SetJustifyH("LEFT")
732 AceGUI:RegisterAsWidget(self)
736 AceGUI:RegisterWidgetType(widgetType, Constructor, widgetVersion)