annotate modules/ReAction_Action/ReAction_Action.lua @ 51:c964fb84560c

added anchor controls
author Flick <flickerstreak@gmail.com>
date Tue, 22 Apr 2008 21:33:37 +0000
parents c3c64e2def50
children c9df7866ff31
rev   line source
flickerstreak@24 1 --[[
flickerstreak@24 2 ReAction Action-button module.
flickerstreak@24 3
flickerstreak@24 4 The button module implements standard action button functionality by wrapping Blizzard's
flickerstreak@24 5 ActionButton frame and associated functions. It also provides some button layout
flickerstreak@24 6 modification tools.
flickerstreak@24 7
flickerstreak@24 8 --]]
flickerstreak@24 9
flickerstreak@24 10 -- local imports
flickerstreak@24 11 local ReAction = ReAction
flickerstreak@24 12 local L = ReAction.L
flickerstreak@24 13 local _G = _G
flickerstreak@24 14 local CreateFrame = CreateFrame
flickerstreak@24 15 local print = ReAction.print
flickerstreak@24 16
flickerstreak@24 17 -- module declaration
flickerstreak@24 18 local moduleID = "Action"
flickerstreak@28 19 local module = ReAction:NewModule( moduleID )
flickerstreak@24 20
flickerstreak@24 21 -- module methods
flickerstreak@24 22 function module:OnInitialize()
flickerstreak@28 23 self.db = ReAction.db:RegisterNamespace( moduleID,
flickerstreak@24 24 {
flickerstreak@28 25 profile = {
flickerstreak@28 26 buttons = { }
flickerstreak@28 27 }
flickerstreak@24 28 }
flickerstreak@24 29 )
flickerstreak@24 30 self.buttons = { }
flickerstreak@49 31
flickerstreak@49 32 ReAction:RegisterOptions("global", self, {
flickerstreak@49 33 hideEmpty = {
flickerstreak@49 34 type = "toggle",
flickerstreak@49 35 name = L["Hide Empty Buttons"],
flickerstreak@49 36 get = function() return self.db.profile.hideEmptyButtons end,
flickerstreak@49 37 set = function(info, val) module:SetHideEmptyButtons(val) end,
flickerstreak@49 38 }
flickerstreak@49 39 })
flickerstreak@24 40 end
flickerstreak@24 41
flickerstreak@24 42 function module:OnEnable()
flickerstreak@48 43 ReAction:RegisterDefaultBarConfig(L["Action Bar"], { type = "actionbar" }, true)
flickerstreak@24 44 end
flickerstreak@24 45
flickerstreak@24 46 function module:OnDisable()
flickerstreak@48 47 ReAction:UnregisterDefaultBarConfig(L["Action Bar"])
flickerstreak@24 48 end
flickerstreak@24 49
flickerstreak@24 50 function module:ApplyToBar(bar)
flickerstreak@48 51 if bar.config.type == "actionbar" then
flickerstreak@48 52 self:RefreshBar(bar)
flickerstreak@48 53 end
flickerstreak@24 54 end
flickerstreak@24 55
flickerstreak@24 56 function module:RefreshBar(bar)
flickerstreak@48 57 if bar.config.type == "actionbar" then
flickerstreak@48 58 if self.buttons[bar] == nil then
flickerstreak@48 59 self.buttons[bar] = { }
flickerstreak@48 60 end
flickerstreak@48 61 local btns = self.buttons[bar]
flickerstreak@48 62 local profile = self.db.profile
flickerstreak@48 63 local barName = bar:GetName()
flickerstreak@48 64 if profile.buttons[barName] == nil then
flickerstreak@48 65 profile.buttons[barName] = {}
flickerstreak@48 66 end
flickerstreak@48 67 local btnCfg = profile.buttons[barName]
flickerstreak@24 68
flickerstreak@48 69 local r, c = bar:GetButtonGrid()
flickerstreak@48 70 local n = r*c
flickerstreak@48 71 for i = 1, n do
flickerstreak@48 72 if btnCfg[i] == nil then
flickerstreak@48 73 btnCfg[i] = {}
flickerstreak@48 74 end
flickerstreak@48 75 if btns[i] == nil then
flickerstreak@48 76 btns[i] = self.BtnClass:new(bar,i,btnCfg[i])
flickerstreak@48 77 else
flickerstreak@48 78 btns[i]:Refresh(bar,i)
flickerstreak@48 79 end
flickerstreak@24 80 end
flickerstreak@48 81 for i = n+1, #btns do
flickerstreak@48 82 btns[i] = btns[i]:Destroy()
flickerstreak@48 83 if btnCfg[i] then
flickerstreak@48 84 btnCfg[i] = nil
flickerstreak@48 85 end
flickerstreak@24 86 end
flickerstreak@24 87 end
flickerstreak@24 88 end
flickerstreak@24 89
flickerstreak@24 90 function module:RemoveFromBar(bar)
flickerstreak@24 91 if self.buttons[bar] then
flickerstreak@24 92 local btns = self.buttons[bar]
flickerstreak@24 93 for _,b in pairs(btns) do
flickerstreak@24 94 if b then
flickerstreak@24 95 b:Destroy()
flickerstreak@24 96 end
flickerstreak@24 97 end
flickerstreak@24 98 self.buttons[bar] = nil
flickerstreak@24 99 end
flickerstreak@24 100 end
flickerstreak@24 101
flickerstreak@24 102 function module:EraseBarConfig(barName)
flickerstreak@24 103 self.db.profile.buttons[barName] = nil
flickerstreak@24 104 end
flickerstreak@24 105
flickerstreak@48 106 function module:RenameBarConfig(oldname, newname)
flickerstreak@48 107 local b = self.db.profile.buttons
flickerstreak@48 108 b[newname], b[oldname] = b[oldname], nil
flickerstreak@48 109 end
flickerstreak@48 110
flickerstreak@49 111 function module:SetHideEmptyButtons(hide)
flickerstreak@49 112 if hide ~= self.db.profile.hideEmptyButtons then
flickerstreak@49 113 for _, bar in pairs(self.buttons) do
flickerstreak@49 114 for _, b in pairs(bar) do
flickerstreak@49 115 if hide then
flickerstreak@49 116 ActionButton_HideGrid(b.frame)
flickerstreak@49 117 else
flickerstreak@49 118 ActionButton_ShowGrid(b.frame)
flickerstreak@49 119 end
flickerstreak@49 120 end
flickerstreak@49 121 end
flickerstreak@49 122 self.db.profile.hideEmptyButtons = hide
flickerstreak@49 123 end
flickerstreak@49 124 end
flickerstreak@49 125
flickerstreak@24 126 function module:ApplyConfigMode(mode,bars)
flickerstreak@49 127 for _, bar in pairs(bars) do
flickerstreak@49 128 if bar and self.buttons[bar] then
flickerstreak@49 129 for _, b in pairs(self.buttons[bar]) do
flickerstreak@24 130 if b then
flickerstreak@24 131 if mode then
flickerstreak@49 132 ActionButton_ShowGrid(b.frame)
flickerstreak@50 133 self:showActionIDLabel(b)
flickerstreak@49 134 else
flickerstreak@49 135 ActionButton_HideGrid(b.frame)
flickerstreak@50 136 self:hideActionIDLabel(b)
flickerstreak@24 137 end
flickerstreak@24 138 end
flickerstreak@24 139 end
flickerstreak@24 140 end
flickerstreak@24 141 end
flickerstreak@24 142 end
flickerstreak@24 143
flickerstreak@50 144 function module:showActionIDLabel(button)
flickerstreak@50 145 if not button.actionIDLabel then
flickerstreak@50 146 local label = button:GetFrame():CreateFontString(nil,"OVERLAY","GameFontNormalLarge")
flickerstreak@50 147 label:SetAllPoints()
flickerstreak@50 148 label:SetJustifyH("CENTER")
flickerstreak@50 149 label:SetShadowColor(0,0,0,1)
flickerstreak@50 150 label:SetShadowOffset(2,-2)
flickerstreak@50 151 label:SetText(tostring(button:GetActionID()))
flickerstreak@50 152 button.actionIDLabel = label
flickerstreak@50 153 end
flickerstreak@50 154 button.actionIDLabel:Show()
flickerstreak@50 155 end
flickerstreak@50 156
flickerstreak@50 157 function module:hideActionIDLabel(button)
flickerstreak@50 158 if button.actionIDLabel then
flickerstreak@50 159 button.actionIDLabel:Hide()
flickerstreak@50 160 end
flickerstreak@50 161 end
flickerstreak@50 162
flickerstreak@50 163
flickerstreak@50 164
flickerstreak@24 165 -- use-count of action IDs
flickerstreak@24 166 local ActionIDList = setmetatable( {}, {
flickerstreak@24 167 __index = function(self, idx)
flickerstreak@24 168 if idx == nil then
flickerstreak@24 169 for i = 1, 120 do
flickerstreak@24 170 if rawget(self,i) == nil then
flickerstreak@24 171 rawset(self,i,1)
flickerstreak@24 172 return i
flickerstreak@24 173 end
flickerstreak@24 174 end
flickerstreak@24 175 else
flickerstreak@24 176 local c = rawget(self,idx) or 0
flickerstreak@24 177 rawset(self,idx,c+1)
flickerstreak@24 178 return idx
flickerstreak@24 179 end
flickerstreak@24 180 end,
flickerstreak@24 181 __newindex = function(self,idx,value)
flickerstreak@24 182 if value == nil then
flickerstreak@24 183 value = rawget(self,idx)
flickerstreak@24 184 if value == 1 then
flickerstreak@24 185 value = nil
flickerstreak@24 186 elseif value then
flickerstreak@24 187 value = value - 1
flickerstreak@24 188 end
flickerstreak@24 189 end
flickerstreak@24 190 rawset(self,idx,value)
flickerstreak@24 191 end
flickerstreak@24 192 })
flickerstreak@24 193
flickerstreak@24 194
flickerstreak@24 195
flickerstreak@28 196
flickerstreak@28 197 ------ Button class ------
flickerstreak@28 198 local Button = { }
flickerstreak@28 199
flickerstreak@28 200 local function Constructor( self, bar, idx, config )
flickerstreak@24 201 self.bar, self.idx, self.config = bar, idx, config
flickerstreak@24 202
flickerstreak@24 203 local barFrame = bar:GetFrame()
flickerstreak@24 204
flickerstreak@49 205 config.name = config.name or "ReAction_"..bar:GetName().."_"..idx
flickerstreak@49 206 self.name = config.name
flickerstreak@24 207 config.actionID = ActionIDList[config.actionID] -- gets a free one if none configured
flickerstreak@24 208
flickerstreak@24 209 local f = CreateFrame("CheckButton", self.name, barFrame, "ActionBarButtonTemplate")
flickerstreak@49 210
flickerstreak@24 211 -- TODO: re-implement ActionButton event handlers that don't do secure stuff
flickerstreak@24 212
flickerstreak@24 213 -- this will probably cause taint, using right now for display/debugging purposes
flickerstreak@30 214 f:SetScript("OnAttributeChanged", ActionButton_UpdateAction)
flickerstreak@24 215 f:SetAttribute("action", config.actionID)
flickerstreak@49 216
flickerstreak@24 217 barFrame:SetAttribute("addchild",f)
flickerstreak@49 218
flickerstreak@24 219 self.frame = f
flickerstreak@24 220 self:Refresh(bar,idx)
flickerstreak@49 221
flickerstreak@49 222 if not module.db.profile.hideEmptyButtons then
flickerstreak@49 223 ActionButton_ShowGrid(self.frame)
flickerstreak@49 224 end
flickerstreak@50 225
flickerstreak@50 226 if ReAction.configMode then
flickerstreak@50 227 ActionButton_ShowGrid(self.frame)
flickerstreak@50 228 module:showActionIDLabel(self)
flickerstreak@50 229 end
flickerstreak@24 230 end
flickerstreak@24 231
flickerstreak@24 232 function Button:Destroy()
flickerstreak@24 233 local f = self.frame
flickerstreak@24 234 f:UnregisterAllEvents()
flickerstreak@24 235 f:Hide()
flickerstreak@24 236 f:SetParent(UIParent)
flickerstreak@24 237 f:ClearAllPoints()
flickerstreak@28 238 if self.name then
flickerstreak@28 239 _G[self.name] = nil
flickerstreak@24 240 end
flickerstreak@24 241 ActionIDList[self.config.actionID] = nil
flickerstreak@24 242 self.frame = nil
flickerstreak@24 243 self.config = nil
flickerstreak@24 244 self.bar = nil
flickerstreak@24 245 end
flickerstreak@24 246
flickerstreak@24 247 function Button:Refresh(bar,idx)
flickerstreak@24 248 bar:PlaceButton(self.frame, idx, 36, 36)
flickerstreak@24 249 end
flickerstreak@24 250
flickerstreak@24 251 function Button:GetFrame()
flickerstreak@24 252 return self.frame
flickerstreak@24 253 end
flickerstreak@24 254
flickerstreak@24 255 function Button:GetName()
flickerstreak@24 256 return self.name
flickerstreak@24 257 end
flickerstreak@24 258
flickerstreak@24 259 function Button:GetActionID()
flickerstreak@24 260 return self.config.actionID
flickerstreak@24 261 end
flickerstreak@28 262
flickerstreak@28 263
flickerstreak@28 264 -- export as a class-factory to module
flickerstreak@28 265 module.BtnClass = {
flickerstreak@28 266 new = function(self, ...)
flickerstreak@28 267 local x = { }
flickerstreak@28 268 for k,v in pairs(Button) do
flickerstreak@28 269 x[k] = v
flickerstreak@28 270 end
flickerstreak@28 271 Constructor(x, ...)
flickerstreak@28 272 return x
flickerstreak@28 273 end
flickerstreak@28 274 }