Mercurial > wow > reaction

annotate Button.lua @ 260:ce583f4c0d33

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
TOC bump 4.1
author Flick
date Fri, 06 May 2011 15:28:29 -0700
parents c918ff9ac787
children 36a29870bf34
rev   line source
flickerstreak@122 1 --[[
flickerstreak@122 2 ReAction Button base class
flickerstreak@122 3 --]]
flickerstreak@122 4
flickerstreak@122 5 -- local imports
flickerstreak@175 6 local addonName, addonTable = ...
flickerstreak@175 7 local ReAction = addonTable.ReAction
flickerstreak@122 8 local L = ReAction.L
flickerstreak@183 9 local LKB = ReAction.LKB
flickerstreak@122 10 local _G = _G
flickerstreak@122 11 local CreateFrame = CreateFrame
flickerstreak@122 12 local GetBindingKey = GetBindingKey
flickerstreak@122 13 local format = string.format
flickerstreak@122 14
flickerstreak@122 15 -- private
flickerstreak@122 16 local trash = CreateFrame("Frame")
flickerstreak@122 17 local frameList = { }
flickerstreak@122 18 local idPools = { }
flickerstreak@122 19
flickerstreak@122 20 local function kb_onEnter( frame )
flickerstreak@183 21 LKB:Set(frame)
flickerstreak@122 22 end
flickerstreak@122 23
flickerstreak@122 24 -- Button class
flickerstreak@218 25 local buttonTypeID = "Button"
flickerstreak@218 26 local Button = {
flickerstreak@218 27 defaultBarConfig = {
flickerstreak@218 28 type = buttonTypeID,
flickerstreak@218 29 btnWidth = 36,
flickerstreak@218 30 btnHeight = 36,
flickerstreak@218 31 btnRows = 1,
flickerstreak@218 32 btnColumns = 12,
flickerstreak@218 33 spacing = 3
flickerstreak@218 34 },
flickerstreak@218 35 barType = L["Button Bar"]
flickerstreak@218 36 }
flickerstreak@122 37
flickerstreak@122 38 ReAction.Button = Button -- export to ReAction
flickerstreak@122 39
flickerstreak@129 40 function Button:New( name, config, bar, idx, inherits, buttonType )
flickerstreak@122 41 buttonType = buttonType or "CheckButton"
flickerstreak@122 42
flickerstreak@122 43 -- create new self
flickerstreak@122 44 self = setmetatable(
flickerstreak@122 45 {
flickerstreak@122 46 bar = bar,
flickerstreak@122 47 idx = idx,
flickerstreak@129 48 config = config,
flickerstreak@122 49 name = name,
flickerstreak@122 50 },
flickerstreak@122 51 { __index = self } )
flickerstreak@122 52
flickerstreak@122 53 -- have to recycle frames with the same name: CreateFrame() doesn't overwrite
flickerstreak@122 54 -- existing globals. Can't set to nil in the global because it's then tainted.
flickerstreak@122 55 -- Caller is responsible for ensuring global uniqueness of names.
flickerstreak@122 56 local f = name and frameList[name]
flickerstreak@122 57 if f then
flickerstreak@122 58 f:SetParent(bar:GetFrame())
flickerstreak@122 59 else
flickerstreak@122 60 f = CreateFrame(buttonType, name, bar:GetFrame(), inherits)
flickerstreak@122 61 if name then
flickerstreak@122 62 frameList[name] = f
flickerstreak@122 63 end
flickerstreak@122 64 end
flickerstreak@122 65
flickerstreak@122 66 self.frame = f
flickerstreak@122 67
flickerstreak@131 68 local frames = { }
flickerstreak@131 69 self.frames = frames
flickerstreak@131 70 frames.icon = _G[name.."Icon"]
flickerstreak@131 71 frames.flash = _G[name.."Flash"]
flickerstreak@131 72 frames.hotkey = _G[name.."HotKey"]
flickerstreak@131 73 frames.count = _G[name.."Count"]
flickerstreak@131 74 frames.name = _G[name.."Name"]
flickerstreak@131 75 frames.border = _G[name.."Border"]
flickerstreak@131 76 frames.cooldown = _G[name.."Cooldown"]
flickerstreak@131 77 frames.normalTexture = _G[name.."NormalTexture"]
flickerstreak@131 78
flickerstreak@122 79 if config then
flickerstreak@122 80 config.name = name
flickerstreak@122 81 end
flickerstreak@122 82
flickerstreak@122 83 -- install LibKeyBound handlers onto frame
flickerstreak@122 84 function f:GetActionName()
flickerstreak@122 85 return format("%s:%s", bar:GetName(), idx)
flickerstreak@122 86 end
flickerstreak@122 87
Flick@259 88 -- mouse and clicking
Flick@259 89 -- set click handlers in subclasses
Flick@259 90 f:EnableMouse(true)
Flick@259 91 f:RegisterForClicks( bar:GetConfig().clickDown and "AnyDown" or "AnyUp" )
flickerstreak@122 92 local clickBinding = format("CLICK %s:LeftButton", name)
flickerstreak@122 93 function f:GetHotkey()
flickerstreak@183 94 return LKB:ToShortKey(GetBindingKey(clickBinding))
flickerstreak@122 95 end
flickerstreak@122 96
flickerstreak@122 97 return self
flickerstreak@122 98 end
flickerstreak@122 99
flickerstreak@122 100 function Button:Destroy()
flickerstreak@126 101 local f = self:GetFrame()
flickerstreak@132 102 f:UnregisterAllEvents()
flickerstreak@132 103 self:ReleaseActionID(self:GetActionID())
flickerstreak@126 104 if f then
flickerstreak@126 105 f:Hide()
flickerstreak@126 106 f:SetParent(trash)
flickerstreak@126 107 f:ClearAllPoints()
flickerstreak@126 108 end
flickerstreak@122 109 end
flickerstreak@122 110
flickerstreak@128 111 function Button:GetBar()
flickerstreak@128 112 return self.bar
flickerstreak@128 113 end
flickerstreak@128 114
flickerstreak@122 115 function Button:GetFrame()
flickerstreak@122 116 return self.frame
flickerstreak@122 117 end
flickerstreak@122 118
Flick@234 119 function Button:GetIndex()
Flick@234 120 return self.idx
Flick@234 121 end
Flick@234 122
flickerstreak@122 123 function Button:GetName()
flickerstreak@122 124 return self.name
flickerstreak@122 125 end
flickerstreak@122 126
flickerstreak@218 127 function Button:GetDefaultBarConfig()
flickerstreak@218 128 return self.defaultBarConfig
flickerstreak@218 129 end
flickerstreak@218 130
flickerstreak@218 131 function Button:GetBarType()
flickerstreak@218 132 return self.barType
flickerstreak@218 133 end
flickerstreak@218 134
Flick@231 135 function Button:GetButtonTypeID()
Flick@231 136 return self.buttonTypeID
Flick@231 137 end
Flick@231 138
flickerstreak@122 139 function Button:GetConfig()
flickerstreak@122 140 return self.config
flickerstreak@122 141 end
flickerstreak@122 142
flickerstreak@122 143 function Button:GetActionID()
flickerstreak@122 144 -- derived classes should override this
flickerstreak@122 145 return nil
flickerstreak@122 146 end
flickerstreak@122 147
flickerstreak@122 148 function Button:SetActionIDPool( poolID, maxID )
flickerstreak@122 149 self.actionPoolID = poolID
flickerstreak@122 150 self.actionMaxID = maxID
flickerstreak@122 151 end
flickerstreak@122 152
Flick@234 153 function Button:SetupBar( bar )
Flick@234 154 local config = bar:GetConfig()
Flick@234 155 if not config.buttons then
Flick@234 156 config.buttons = { }
Flick@234 157 end
Flick@234 158 local btnCfg = config.buttons
Flick@234 159
Flick@234 160 local r, c = bar:GetButtonGrid()
Flick@234 161 local n = r*c
Flick@235 162 local cfgN = n
Flick@234 163
Flick@234 164 local hint = nil
Flick@234 165 local i = 1
Flick@234 166 repeat
Flick@234 167 local b = bar:GetButton(i)
Flick@234 168 if b then
Flick@234 169 if i > n then
Flick@234 170 bar:RemoveButton(b)
Flick@234 171 b:Destroy()
Flick@235 172 if i > cfgN then
Flick@235 173 btnCfg[i] = nil
Flick@235 174 end
Flick@234 175 else
Flick@234 176 b:Refresh()
Flick@234 177 hint = b:GetActionID()
Flick@234 178 end
Flick@234 179 elseif i <= n then
Flick@234 180 local cfg = btnCfg[i] or { }
Flick@234 181 local success, r = pcall(self.New, self, cfg, bar, i, hint) -- note call semantics for derived class constructors
Flick@234 182 if success and r then
Flick@234 183 b = r
Flick@234 184 bar:AddButton(i,b)
Flick@234 185 btnCfg[i] = cfg
Flick@234 186 b:Refresh()
Flick@234 187 hint = b:GetActionID()
Flick@234 188 else
Flick@234 189 n = i - 1
Flick@234 190 if not success then
Flick@236 191 bar:ClipNButtons(n)
Flick@236 192 cfgN = n
Flick@234 193 geterrorhandler()(r)
Flick@234 194 end
Flick@234 195 end
Flick@234 196 end
Flick@234 197 i = i + 1
Flick@234 198 until b == nil
Flick@234 199 end
Flick@234 200
flickerstreak@122 201 function Button:AcquireActionID( id, hint, unique )
flickerstreak@122 202 local poolID = self.actionPoolID
flickerstreak@122 203 local maxID = self.actionMaxID
flickerstreak@122 204 if not poolID or not maxID then
flickerstreak@122 205 error("AcquireActionID: must setup pool first with SetActionIDPool")
flickerstreak@122 206 end
flickerstreak@123 207 local pool = idPools[poolID]
flickerstreak@122 208 if not pool then
flickerstreak@122 209 pool = { nWraps = 0, useCount = { } }
flickerstreak@122 210 for i = 1, maxID do
flickerstreak@122 211 pool.useCount[i] = 0
flickerstreak@122 212 end
flickerstreak@123 213 idPools[poolID] = pool
flickerstreak@122 214 end
flickerstreak@122 215 local useCount = pool.useCount
flickerstreak@122 216 if id == nil then
flickerstreak@122 217 repeat
flickerstreak@126 218 local nWraps = pool.nWraps or 0
flickerstreak@126 219 if hint and (useCount[hint] == nil or useCount[hint] == nWraps) then
flickerstreak@122 220 id = hint
flickerstreak@122 221 else
flickerstreak@122 222 local start = hint or 1
flickerstreak@122 223 for i = start, maxID do
flickerstreak@122 224 if useCount[i] == nil or useCount[i] == nWraps then
flickerstreak@122 225 id = i
flickerstreak@122 226 break
flickerstreak@122 227 end
flickerstreak@122 228 end
flickerstreak@122 229 if not id then
flickerstreak@122 230 for i = 1, start do
flickerstreak@122 231 if useCount[i] == nil or useCount[i] == nWraps then
flickerstreak@122 232 id = i
flickerstreak@122 233 break
flickerstreak@122 234 end
flickerstreak@122 235 end
flickerstreak@122 236 end
flickerstreak@122 237 end
flickerstreak@122 238 if id == nil then
flickerstreak@122 239 if unique then
Flick@249 240 error(("All action IDs for bars of type '%s' are in use, cannot create any more buttons"):format(self.config.barType))
flickerstreak@122 241 end
flickerstreak@122 242 pool.nWraps = nWraps + 1
flickerstreak@122 243 end
flickerstreak@126 244 until id ~= nil
flickerstreak@122 245 end
flickerstreak@122 246 useCount[id] = (useCount[id] or 0) + 1
flickerstreak@122 247 return id
flickerstreak@122 248 end
flickerstreak@122 249
flickerstreak@122 250 function Button:ReleaseActionID( id )
flickerstreak@122 251 local poolID = self.actionPoolID
flickerstreak@122 252 if not poolID then
flickerstreak@122 253 error("ReleaseActionID: must setup pool first with SetActionIDPool")
flickerstreak@122 254 end
flickerstreak@123 255 local pool = idPools[poolID]
flickerstreak@122 256 if pool and id and pool.useCount[id] then
flickerstreak@122 257 pool.useCount[id] = pool.useCount[id] - 1
flickerstreak@122 258 pool.nWraps = min(pool.useCount[id], pool.nWraps)
flickerstreak@122 259 end
flickerstreak@122 260 end
flickerstreak@122 261
flickerstreak@122 262 function Button:Refresh()
flickerstreak@129 263 local f = self:GetFrame()
flickerstreak@129 264 self.bar:PlaceButton( self, f:GetWidth(), f:GetHeight() )
flickerstreak@122 265 end
flickerstreak@122 266
flickerstreak@122 267 function Button:SetKeybindMode( mode )
flickerstreak@122 268 local f = self.frame
flickerstreak@122 269 if mode then
flickerstreak@122 270 self.oldOnEnter = f:GetScript("OnEnter")
flickerstreak@122 271 f:SetScript("OnEnter", kb_onEnter)
flickerstreak@124 272 elseif self.oldOnEnter then
flickerstreak@122 273 f:SetScript("OnEnter", self.oldOnEnter)
flickerstreak@122 274 self.oldOnEnter = nil
flickerstreak@122 275 end
flickerstreak@128 276 self:ShowGridTemp(mode)
flickerstreak@122 277 self:UpdateKeybindModeDisplay( mode )
flickerstreak@122 278 end
flickerstreak@122 279
flickerstreak@122 280 function Button:UpdateKeybindModeDisplay( mode )
flickerstreak@131 281 local border = self.frames.border or _G[format("%sBorder",tostring(self:GetName()))]
flickerstreak@131 282 if border then
flickerstreak@122 283 if mode then
flickerstreak@183 284 border:SetVertexColor(LKB:GetColorKeyBoundMode())
flickerstreak@131 285 border:Show()
flickerstreak@122 286 else
flickerstreak@131 287 border:Hide()
flickerstreak@122 288 end
flickerstreak@122 289 end
flickerstreak@122 290 end
flickerstreak@122 291
flickerstreak@122 292 function Button:UpdateHotkey( hotkey )
flickerstreak@131 293 hotkey = hotkey or self.frames.hotkey
flickerstreak@122 294 if not hotkey then
flickerstreak@129 295 hotkey = _G[self:GetName().."HotKey"]
flickerstreak@131 296 self.frames.hotkey = hotkey
flickerstreak@122 297 end
flickerstreak@122 298 if hotkey then
flickerstreak@122 299 local txt = self.frame:GetHotkey()
flickerstreak@122 300 hotkey:SetText( txt )
flickerstreak@122 301 if txt == nil or txt == "" then
flickerstreak@122 302 hotkey:Hide()
flickerstreak@122 303 else
flickerstreak@122 304 hotkey:Show()
flickerstreak@122 305 end
flickerstreak@122 306 end
flickerstreak@122 307 end
flickerstreak@122 308
flickerstreak@122 309 function Button:GetActionIDLabel( create )
flickerstreak@129 310 local f = self:GetFrame()
flickerstreak@122 311 if not f.actionIDLabel and create then
flickerstreak@122 312 local label = f:CreateFontString(nil,"OVERLAY","GameFontNormalLarge")
flickerstreak@122 313 label:SetAllPoints()
flickerstreak@122 314 label:SetJustifyH("CENTER")
flickerstreak@122 315 label:SetShadowColor(0,0,0,1)
flickerstreak@122 316 label:SetShadowOffset(2,-2)
flickerstreak@122 317 f.actionIDLabel = label -- store the label with the frame for recycling
flickerstreak@122 318 end
flickerstreak@122 319 return f.actionIDLabel
flickerstreak@122 320 end
flickerstreak@122 321
flickerstreak@122 322 function Button:UpdateActionIDLabel( show )
flickerstreak@122 323 local label = self:GetActionIDLabel( show )
flickerstreak@122 324 if label then
flickerstreak@122 325 if show then
flickerstreak@122 326 local id = self:GetActionID()
flickerstreak@122 327 if id then
flickerstreak@122 328 label:SetText(tostring(id))
flickerstreak@122 329 label:Show()
flickerstreak@122 330 return
flickerstreak@122 331 end
flickerstreak@122 332 end
flickerstreak@122 333 label:Hide()
flickerstreak@122 334 end
flickerstreak@122 335 end
flickerstreak@122 336
flickerstreak@122 337 function Button:SetNormalVertexColor( r, g, b, a )
flickerstreak@213 338 if ReAction.LBF then
flickerstreak@213 339 ReAction.LBF:SetNormalVertexColor(self:GetFrame(), r, g, b, a)
flickerstreak@122 340 else
flickerstreak@129 341 self:GetFrame():GetNormalTexture():SetVertexColor(r,g,b,a)
flickerstreak@122 342 end
flickerstreak@122 343 end
flickerstreak@122 344
flickerstreak@122 345 function Button:GetNormalVertexColor()
flickerstreak@213 346 if ReAction.LBF then
flickerstreak@213 347 return ReAction.LBF:GetNormalVertexColor(self:GetFrame())
flickerstreak@122 348 else
flickerstreak@129 349 return self:GetFrame():GetNormalTexture():GetVertexColor()
flickerstreak@122 350 end
flickerstreak@122 351 end
flickerstreak@122 352
flickerstreak@122 353 function Button:UpdateShowGrid()
flickerstreak@122 354 -- does nothing by default
flickerstreak@122 355 end
flickerstreak@128 356
flickerstreak@128 357 function Button:ShowGridTemp(show)
flickerstreak@128 358 -- does nothing by default
flickerstreak@128 359 end
flickerstreak@128 360
flickerstreak@128 361 function Button:ShowGrid(show)
flickerstreak@128 362 -- does nothing by default
flickerstreak@128 363 end