Mercurial > wow > reaction

annotate classes/Button.lua @ 218:e63aefb8a555

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Demodularization of buttons - register class instead of config
author Flick <flickerstreak@gmail.com>
date Fri, 19 Nov 2010 23:06:24 -0800
parents 8ba8ab8bf6dd
children 158c9299185b
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
flickerstreak@122 88 local clickBinding = format("CLICK %s:LeftButton", name)
flickerstreak@122 89 function f:GetHotkey()
flickerstreak@183 90 return LKB:ToShortKey(GetBindingKey(clickBinding))
flickerstreak@122 91 end
flickerstreak@122 92
flickerstreak@122 93 return self
flickerstreak@122 94 end
flickerstreak@122 95
flickerstreak@122 96 function Button:Destroy()
flickerstreak@126 97 local f = self:GetFrame()
flickerstreak@132 98 f:UnregisterAllEvents()
flickerstreak@132 99 self:ReleaseActionID(self:GetActionID())
flickerstreak@126 100 if f then
flickerstreak@126 101 f:Hide()
flickerstreak@126 102 f:SetParent(trash)
flickerstreak@126 103 f:ClearAllPoints()
flickerstreak@126 104 end
flickerstreak@122 105 end
flickerstreak@122 106
flickerstreak@128 107 function Button:GetBar()
flickerstreak@128 108 return self.bar
flickerstreak@128 109 end
flickerstreak@128 110
flickerstreak@122 111 function Button:GetFrame()
flickerstreak@122 112 return self.frame
flickerstreak@122 113 end
flickerstreak@122 114
flickerstreak@122 115 function Button:GetName()
flickerstreak@122 116 return self.name
flickerstreak@122 117 end
flickerstreak@122 118
flickerstreak@218 119 function Button:GetDefaultBarConfig()
flickerstreak@218 120 return self.defaultBarConfig
flickerstreak@218 121 end
flickerstreak@218 122
flickerstreak@218 123 function Button:GetBarType()
flickerstreak@218 124 return self.barType
flickerstreak@218 125 end
flickerstreak@218 126
flickerstreak@122 127 function Button:GetConfig()
flickerstreak@122 128 return self.config
flickerstreak@122 129 end
flickerstreak@122 130
flickerstreak@122 131 function Button:GetActionID()
flickerstreak@122 132 -- derived classes should override this
flickerstreak@122 133 return nil
flickerstreak@122 134 end
flickerstreak@122 135
flickerstreak@122 136 function Button:SetActionIDPool( poolID, maxID )
flickerstreak@122 137 self.actionPoolID = poolID
flickerstreak@122 138 self.actionMaxID = maxID
flickerstreak@122 139 end
flickerstreak@122 140
flickerstreak@122 141 function Button:AcquireActionID( id, hint, unique )
flickerstreak@122 142 local poolID = self.actionPoolID
flickerstreak@122 143 local maxID = self.actionMaxID
flickerstreak@122 144 if not poolID or not maxID then
flickerstreak@122 145 error("AcquireActionID: must setup pool first with SetActionIDPool")
flickerstreak@122 146 end
flickerstreak@123 147 local pool = idPools[poolID]
flickerstreak@122 148 if not pool then
flickerstreak@122 149 pool = { nWraps = 0, useCount = { } }
flickerstreak@122 150 for i = 1, maxID do
flickerstreak@122 151 pool.useCount[i] = 0
flickerstreak@122 152 end
flickerstreak@123 153 idPools[poolID] = pool
flickerstreak@122 154 end
flickerstreak@122 155 local useCount = pool.useCount
flickerstreak@122 156 if id == nil then
flickerstreak@122 157 repeat
flickerstreak@126 158 local nWraps = pool.nWraps or 0
flickerstreak@126 159 if hint and (useCount[hint] == nil or useCount[hint] == nWraps) then
flickerstreak@122 160 id = hint
flickerstreak@122 161 else
flickerstreak@122 162 local start = hint or 1
flickerstreak@122 163 for i = start, maxID do
flickerstreak@122 164 if useCount[i] == nil or useCount[i] == nWraps then
flickerstreak@122 165 id = i
flickerstreak@122 166 break
flickerstreak@122 167 end
flickerstreak@122 168 end
flickerstreak@122 169 if not id then
flickerstreak@122 170 for i = 1, start do
flickerstreak@122 171 if useCount[i] == nil or useCount[i] == nWraps then
flickerstreak@122 172 id = i
flickerstreak@122 173 break
flickerstreak@122 174 end
flickerstreak@122 175 end
flickerstreak@122 176 end
flickerstreak@122 177 end
flickerstreak@122 178 if id == nil then
flickerstreak@122 179 if unique then
flickerstreak@122 180 return nil
flickerstreak@122 181 end
flickerstreak@122 182 pool.nWraps = nWraps + 1
flickerstreak@122 183 end
flickerstreak@126 184 until id ~= nil
flickerstreak@122 185 end
flickerstreak@122 186 useCount[id] = (useCount[id] or 0) + 1
flickerstreak@122 187 return id
flickerstreak@122 188 end
flickerstreak@122 189
flickerstreak@122 190 function Button:ReleaseActionID( id )
flickerstreak@122 191 local poolID = self.actionPoolID
flickerstreak@122 192 if not poolID then
flickerstreak@122 193 error("ReleaseActionID: must setup pool first with SetActionIDPool")
flickerstreak@122 194 end
flickerstreak@123 195 local pool = idPools[poolID]
flickerstreak@122 196 if pool and id and pool.useCount[id] then
flickerstreak@122 197 pool.useCount[id] = pool.useCount[id] - 1
flickerstreak@122 198 pool.nWraps = min(pool.useCount[id], pool.nWraps)
flickerstreak@122 199 end
flickerstreak@122 200 end
flickerstreak@122 201
flickerstreak@122 202 function Button:Refresh()
flickerstreak@129 203 local f = self:GetFrame()
flickerstreak@129 204 self.bar:PlaceButton( self, f:GetWidth(), f:GetHeight() )
flickerstreak@122 205 end
flickerstreak@122 206
flickerstreak@122 207 function Button:SetKeybindMode( mode )
flickerstreak@122 208 local f = self.frame
flickerstreak@122 209 if mode then
flickerstreak@122 210 self.oldOnEnter = f:GetScript("OnEnter")
flickerstreak@122 211 f:SetScript("OnEnter", kb_onEnter)
flickerstreak@124 212 elseif self.oldOnEnter then
flickerstreak@122 213 f:SetScript("OnEnter", self.oldOnEnter)
flickerstreak@122 214 self.oldOnEnter = nil
flickerstreak@122 215 end
flickerstreak@128 216 self:ShowGridTemp(mode)
flickerstreak@122 217 self:UpdateKeybindModeDisplay( mode )
flickerstreak@122 218 end
flickerstreak@122 219
flickerstreak@122 220 function Button:UpdateKeybindModeDisplay( mode )
flickerstreak@131 221 local border = self.frames.border or _G[format("%sBorder",tostring(self:GetName()))]
flickerstreak@131 222 if border then
flickerstreak@122 223 if mode then
flickerstreak@183 224 border:SetVertexColor(LKB:GetColorKeyBoundMode())
flickerstreak@131 225 border:Show()
flickerstreak@122 226 else
flickerstreak@131 227 border:Hide()
flickerstreak@122 228 end
flickerstreak@122 229 end
flickerstreak@122 230 end
flickerstreak@122 231
flickerstreak@122 232 function Button:UpdateHotkey( hotkey )
flickerstreak@131 233 hotkey = hotkey or self.frames.hotkey
flickerstreak@122 234 if not hotkey then
flickerstreak@129 235 hotkey = _G[self:GetName().."HotKey"]
flickerstreak@131 236 self.frames.hotkey = hotkey
flickerstreak@122 237 end
flickerstreak@122 238 if hotkey then
flickerstreak@122 239 local txt = self.frame:GetHotkey()
flickerstreak@122 240 hotkey:SetText( txt )
flickerstreak@122 241 if txt == nil or txt == "" then
flickerstreak@122 242 hotkey:Hide()
flickerstreak@122 243 else
flickerstreak@122 244 hotkey:Show()
flickerstreak@122 245 end
flickerstreak@122 246 end
flickerstreak@122 247 end
flickerstreak@122 248
flickerstreak@122 249 function Button:GetActionIDLabel( create )
flickerstreak@129 250 local f = self:GetFrame()
flickerstreak@122 251 if not f.actionIDLabel and create then
flickerstreak@122 252 local label = f:CreateFontString(nil,"OVERLAY","GameFontNormalLarge")
flickerstreak@122 253 label:SetAllPoints()
flickerstreak@122 254 label:SetJustifyH("CENTER")
flickerstreak@122 255 label:SetShadowColor(0,0,0,1)
flickerstreak@122 256 label:SetShadowOffset(2,-2)
flickerstreak@122 257 f.actionIDLabel = label -- store the label with the frame for recycling
flickerstreak@122 258 end
flickerstreak@122 259 return f.actionIDLabel
flickerstreak@122 260 end
flickerstreak@122 261
flickerstreak@122 262 function Button:UpdateActionIDLabel( show )
flickerstreak@122 263 local label = self:GetActionIDLabel( show )
flickerstreak@122 264 if label then
flickerstreak@122 265 if show then
flickerstreak@122 266 local id = self:GetActionID()
flickerstreak@122 267 if id then
flickerstreak@122 268 label:SetText(tostring(id))
flickerstreak@122 269 label:Show()
flickerstreak@122 270 return
flickerstreak@122 271 end
flickerstreak@122 272 end
flickerstreak@122 273 label:Hide()
flickerstreak@122 274 end
flickerstreak@122 275 end
flickerstreak@122 276
flickerstreak@122 277 function Button:SetNormalVertexColor( r, g, b, a )
flickerstreak@213 278 if ReAction.LBF then
flickerstreak@213 279 ReAction.LBF:SetNormalVertexColor(self:GetFrame(), r, g, b, a)
flickerstreak@122 280 else
flickerstreak@129 281 self:GetFrame():GetNormalTexture():SetVertexColor(r,g,b,a)
flickerstreak@122 282 end
flickerstreak@122 283 end
flickerstreak@122 284
flickerstreak@122 285 function Button:GetNormalVertexColor()
flickerstreak@213 286 if ReAction.LBF then
flickerstreak@213 287 return ReAction.LBF:GetNormalVertexColor(self:GetFrame())
flickerstreak@122 288 else
flickerstreak@129 289 return self:GetFrame():GetNormalTexture():GetVertexColor()
flickerstreak@122 290 end
flickerstreak@122 291 end
flickerstreak@122 292
flickerstreak@122 293 function Button:UpdateShowGrid()
flickerstreak@122 294 -- does nothing by default
flickerstreak@122 295 end
flickerstreak@128 296
flickerstreak@128 297 function Button:ShowGridTemp(show)
flickerstreak@128 298 -- does nothing by default
flickerstreak@128 299 end
flickerstreak@128 300
flickerstreak@128 301 function Button:ShowGrid(show)
flickerstreak@128 302 -- does nothing by default
flickerstreak@128 303 end