Mercurial > wow > ouroloot

annotate AceGUIWidget-Keybinding.lua @ 112:ccf90050cdc1 beta-mhg-1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Work around acegui bugs, revert when tickets fixed.
author Farmbuyer of US-Kilrogg <farmbuyer@gmail.com>
date Thu, 09 Aug 2012 23:58:30 -0400
parents
children
rev   line source
farmbuyer@112 1 --[[-----------------------------------------------------------------------------
farmbuyer@112 2 Keybinding Widget
farmbuyer@112 3 Set Keybindings in the Config UI.
farmbuyer@112 4 -------------------------------------------------------------------------------]]
farmbuyer@112 5 local Type, Version = "Keybinding", 24
farmbuyer@112 6 local AceGUI = LibStub and LibStub("AceGUI-3.0", true)
farmbuyer@112 7 if not AceGUI or (AceGUI:GetWidgetVersion(Type) or 0) >= Version then return end
farmbuyer@112 8
farmbuyer@112 9 -- Lua APIs
farmbuyer@112 10 local pairs = pairs
farmbuyer@112 11
farmbuyer@112 12 -- WoW APIs
farmbuyer@112 13 local IsShiftKeyDown, IsControlKeyDown, IsAltKeyDown = IsShiftKeyDown, IsControlKeyDown, IsAltKeyDown
farmbuyer@112 14 local CreateFrame, UIParent = CreateFrame, UIParent
farmbuyer@112 15
farmbuyer@112 16 -- Global vars/functions that we don't upvalue since they might get hooked, or upgraded
farmbuyer@112 17 -- List them here for Mikk's FindGlobals script
farmbuyer@112 18 -- GLOBALS: NOT_BOUND
farmbuyer@112 19
farmbuyer@112 20 local wowMoP
farmbuyer@112 21 do
farmbuyer@112 22 local _, _, _, interface = GetBuildInfo()
farmbuyer@112 23 wowMoP = (interface >= 50000)
farmbuyer@112 24 end
farmbuyer@112 25
farmbuyer@112 26 --[[-----------------------------------------------------------------------------
farmbuyer@112 27 Scripts
farmbuyer@112 28 -------------------------------------------------------------------------------]]
farmbuyer@112 29
farmbuyer@112 30 local function Control_OnEnter(frame)
farmbuyer@112 31 frame.obj:Fire("OnEnter")
farmbuyer@112 32 end
farmbuyer@112 33
farmbuyer@112 34 local function Control_OnLeave(frame)
farmbuyer@112 35 frame.obj:Fire("OnLeave")
farmbuyer@112 36 end
farmbuyer@112 37
farmbuyer@112 38 local function Keybinding_OnClick(frame, button)
farmbuyer@112 39 if button == "LeftButton" or button == "RightButton" then
farmbuyer@112 40 local self = frame.obj
farmbuyer@112 41 if self.waitingForKey then
farmbuyer@112 42 frame:EnableKeyboard(false)
farmbuyer@112 43 self.msgframe:Hide()
farmbuyer@112 44 frame:UnlockHighlight()
farmbuyer@112 45 self.waitingForKey = nil
farmbuyer@112 46 else
farmbuyer@112 47 frame:EnableKeyboard(true)
farmbuyer@112 48 self.msgframe:Show()
farmbuyer@112 49 frame:LockHighlight()
farmbuyer@112 50 self.waitingForKey = true
farmbuyer@112 51 end
farmbuyer@112 52 end
farmbuyer@112 53 AceGUI:ClearFocus()
farmbuyer@112 54 end
farmbuyer@112 55
farmbuyer@112 56 local ignoreKeys = {
farmbuyer@112 57 ["BUTTON1"] = true, ["BUTTON2"] = true,
farmbuyer@112 58 ["UNKNOWN"] = true,
farmbuyer@112 59 ["LSHIFT"] = true, ["LCTRL"] = true, ["LALT"] = true,
farmbuyer@112 60 ["RSHIFT"] = true, ["RCTRL"] = true, ["RALT"] = true,
farmbuyer@112 61 }
farmbuyer@112 62 local function Keybinding_OnKeyDown(frame, key)
farmbuyer@112 63 local self = frame.obj
farmbuyer@112 64 if self.waitingForKey then
farmbuyer@112 65 local keyPressed = key
farmbuyer@112 66 if keyPressed == "ESCAPE" then
farmbuyer@112 67 keyPressed = ""
farmbuyer@112 68 else
farmbuyer@112 69 if ignoreKeys[keyPressed] then return end
farmbuyer@112 70 if IsShiftKeyDown() then
farmbuyer@112 71 keyPressed = "SHIFT-"..keyPressed
farmbuyer@112 72 end
farmbuyer@112 73 if IsControlKeyDown() then
farmbuyer@112 74 keyPressed = "CTRL-"..keyPressed
farmbuyer@112 75 end
farmbuyer@112 76 if IsAltKeyDown() then
farmbuyer@112 77 keyPressed = "ALT-"..keyPressed
farmbuyer@112 78 end
farmbuyer@112 79 end
farmbuyer@112 80
farmbuyer@112 81 frame:EnableKeyboard(false)
farmbuyer@112 82 self.msgframe:Hide()
farmbuyer@112 83 frame:UnlockHighlight()
farmbuyer@112 84 self.waitingForKey = nil
farmbuyer@112 85
farmbuyer@112 86 if not self.disabled then
farmbuyer@112 87 self:SetKey(keyPressed)
farmbuyer@112 88 self:Fire("OnKeyChanged", keyPressed)
farmbuyer@112 89 end
farmbuyer@112 90 end
farmbuyer@112 91 end
farmbuyer@112 92
farmbuyer@112 93 local function Keybinding_OnMouseDown(frame, button)
farmbuyer@112 94 if button == "LeftButton" or button == "RightButton" then
farmbuyer@112 95 return
farmbuyer@112 96 elseif button == "MiddleButton" then
farmbuyer@112 97 button = "BUTTON3"
farmbuyer@112 98 elseif button == "Button4" then
farmbuyer@112 99 button = "BUTTON4"
farmbuyer@112 100 elseif button == "Button5" then
farmbuyer@112 101 button = "BUTTON5"
farmbuyer@112 102 end
farmbuyer@112 103 Keybinding_OnKeyDown(frame, button)
farmbuyer@112 104 end
farmbuyer@112 105
farmbuyer@112 106 --[[-----------------------------------------------------------------------------
farmbuyer@112 107 Methods
farmbuyer@112 108 -------------------------------------------------------------------------------]]
farmbuyer@112 109 local methods = {
farmbuyer@112 110 ["OnAcquire"] = function(self)
farmbuyer@112 111 self:SetWidth(200)
farmbuyer@112 112 self:SetLabel("")
farmbuyer@112 113 self:SetKey("")
farmbuyer@112 114 self.waitingForKey = nil
farmbuyer@112 115 self.msgframe:Hide()
farmbuyer@112 116 self:SetDisabled(false)
farmbuyer@112 117 self.button:EnableKeyboard(false)
farmbuyer@112 118 end,
farmbuyer@112 119
farmbuyer@112 120 -- ["OnRelease"] = nil,
farmbuyer@112 121
farmbuyer@112 122 ["SetDisabled"] = function(self, disabled)
farmbuyer@112 123 self.disabled = disabled
farmbuyer@112 124 if disabled then
farmbuyer@112 125 self.button:Disable()
farmbuyer@112 126 self.label:SetTextColor(0.5,0.5,0.5)
farmbuyer@112 127 else
farmbuyer@112 128 self.button:Enable()
farmbuyer@112 129 self.label:SetTextColor(1,1,1)
farmbuyer@112 130 end
farmbuyer@112 131 end,
farmbuyer@112 132
farmbuyer@112 133 ["SetKey"] = function(self, key)
farmbuyer@112 134 if (key or "") == "" then
farmbuyer@112 135 self.button:SetText(NOT_BOUND)
farmbuyer@112 136 self.button:SetNormalFontObject("GameFontNormal")
farmbuyer@112 137 else
farmbuyer@112 138 self.button:SetText(key)
farmbuyer@112 139 self.button:SetNormalFontObject("GameFontHighlight")
farmbuyer@112 140 end
farmbuyer@112 141 end,
farmbuyer@112 142
farmbuyer@112 143 ["GetKey"] = function(self)
farmbuyer@112 144 local key = self.button:GetText()
farmbuyer@112 145 if key == NOT_BOUND then
farmbuyer@112 146 key = nil
farmbuyer@112 147 end
farmbuyer@112 148 return key
farmbuyer@112 149 end,
farmbuyer@112 150
farmbuyer@112 151 ["SetLabel"] = function(self, label)
farmbuyer@112 152 self.label:SetText(label or "")
farmbuyer@112 153 if (label or "") == "" then
farmbuyer@112 154 self.alignoffset = nil
farmbuyer@112 155 self:SetHeight(24)
farmbuyer@112 156 else
farmbuyer@112 157 self.alignoffset = 30
farmbuyer@112 158 self:SetHeight(44)
farmbuyer@112 159 end
farmbuyer@112 160 end,
farmbuyer@112 161 }
farmbuyer@112 162
farmbuyer@112 163 --[[-----------------------------------------------------------------------------
farmbuyer@112 164 Constructor
farmbuyer@112 165 -------------------------------------------------------------------------------]]
farmbuyer@112 166
farmbuyer@112 167 local ControlBackdrop = {
farmbuyer@112 168 bgFile = "Interface\\Tooltips\\UI-Tooltip-Background",
farmbuyer@112 169 edgeFile = "Interface\\Tooltips\\UI-Tooltip-Border",
farmbuyer@112 170 tile = true, tileSize = 16, edgeSize = 16,
farmbuyer@112 171 insets = { left = 3, right = 3, top = 3, bottom = 3 }
farmbuyer@112 172 }
farmbuyer@112 173
farmbuyer@112 174 local function keybindingMsgFixWidth(frame)
farmbuyer@112 175 frame:SetWidth(frame.msg:GetWidth() + 10)
farmbuyer@112 176 frame:SetScript("OnUpdate", nil)
farmbuyer@112 177 end
farmbuyer@112 178
farmbuyer@112 179 local function Constructor()
farmbuyer@112 180 local name = "AceGUI30KeybindingButton" .. AceGUI:GetNextWidgetNum(Type)
farmbuyer@112 181
farmbuyer@112 182 local frame = CreateFrame("Frame", nil, UIParent)
farmbuyer@112 183 local button = CreateFrame("Button", name, frame, wowMoP and "UIPanelButtonTemplate" or "UIPanelButtonTemplate2")
farmbuyer@112 184
farmbuyer@112 185 button:EnableMouse(true)
farmbuyer@112 186 button:RegisterForClicks("AnyDown")
farmbuyer@112 187 button:SetScript("OnEnter", Control_OnEnter)
farmbuyer@112 188 button:SetScript("OnLeave", Control_OnLeave)
farmbuyer@112 189 button:SetScript("OnClick", Keybinding_OnClick)
farmbuyer@112 190 button:SetScript("OnKeyDown", Keybinding_OnKeyDown)
farmbuyer@112 191 button:SetScript("OnMouseDown", Keybinding_OnMouseDown)
farmbuyer@112 192 button:SetPoint("BOTTOMLEFT")
farmbuyer@112 193 button:SetPoint("BOTTOMRIGHT")
farmbuyer@112 194 button:SetHeight(24)
farmbuyer@112 195 button:EnableKeyboard(false)
farmbuyer@112 196
farmbuyer@112 197 local text = button:GetFontString()
farmbuyer@112 198 text:SetPoint("LEFT", 7, 0)
farmbuyer@112 199 text:SetPoint("RIGHT", -7, 0)
farmbuyer@112 200
farmbuyer@112 201 local label = frame:CreateFontString(nil, "OVERLAY", "GameFontHighlight")
farmbuyer@112 202 label:SetPoint("TOPLEFT")
farmbuyer@112 203 label:SetPoint("TOPRIGHT")
farmbuyer@112 204 label:SetJustifyH("CENTER")
farmbuyer@112 205 label:SetHeight(18)
farmbuyer@112 206
farmbuyer@112 207 local msgframe = CreateFrame("Frame", nil, UIParent)
farmbuyer@112 208 msgframe:SetHeight(30)
farmbuyer@112 209 msgframe:SetBackdrop(ControlBackdrop)
farmbuyer@112 210 msgframe:SetBackdropColor(0,0,0)
farmbuyer@112 211 msgframe:SetFrameStrata("FULLSCREEN_DIALOG")
farmbuyer@112 212 msgframe:SetFrameLevel(1000)
farmbuyer@112 213 msgframe:SetToplevel(true)
farmbuyer@112 214
farmbuyer@112 215 local msg = msgframe:CreateFontString(nil, "OVERLAY", "GameFontNormal")
farmbuyer@112 216 msg:SetText("Press a key to bind, ESC to clear the binding or click the button again to cancel.")
farmbuyer@112 217 msgframe.msg = msg
farmbuyer@112 218 msg:SetPoint("TOPLEFT", 5, -5)
farmbuyer@112 219 msgframe:SetScript("OnUpdate", keybindingMsgFixWidth)
farmbuyer@112 220 msgframe:SetPoint("BOTTOM", button, "TOP")
farmbuyer@112 221 msgframe:Hide()
farmbuyer@112 222
farmbuyer@112 223 local widget = {
farmbuyer@112 224 button = button,
farmbuyer@112 225 label = label,
farmbuyer@112 226 msgframe = msgframe,
farmbuyer@112 227 frame = frame,
farmbuyer@112 228 alignoffset = 30,
farmbuyer@112 229 type = Type
farmbuyer@112 230 }
farmbuyer@112 231 for method, func in pairs(methods) do
farmbuyer@112 232 widget[method] = func
farmbuyer@112 233 end
farmbuyer@112 234 button.obj = widget
farmbuyer@112 235
farmbuyer@112 236 return AceGUI:RegisterAsWidget(widget)
farmbuyer@112 237 end
farmbuyer@112 238
farmbuyer@112 239 AceGUI:RegisterWidgetType(Type, Constructor, Version)