annotate Libs/AceGUI-3.0/widgets/AceGUIContainer-Frame.lua @ 17:3000eccbf1a0 v7.3.0.017

- ToC Update.
author Tercio
date Sat, 02 Sep 2017 14:10:48 -0300
parents fc346da3afd9
children
rev   line source
tercio@0 1 --[[-----------------------------------------------------------------------------
tercio@0 2 Frame Container
tercio@0 3 -------------------------------------------------------------------------------]]
Tercio@17 4 local Type, Version = "Frame", 26
tercio@0 5 local AceGUI = LibStub and LibStub("AceGUI-3.0", true)
tercio@0 6 if not AceGUI or (AceGUI:GetWidgetVersion(Type) or 0) >= Version then return end
tercio@0 7
tercio@0 8 -- Lua APIs
tercio@0 9 local pairs, assert, type = pairs, assert, type
tercio@0 10 local wipe = table.wipe
tercio@0 11
tercio@0 12 -- WoW APIs
tercio@0 13 local PlaySound = PlaySound
tercio@0 14 local CreateFrame, UIParent = CreateFrame, UIParent
tercio@0 15
tercio@0 16 -- Global vars/functions that we don't upvalue since they might get hooked, or upgraded
tercio@0 17 -- List them here for Mikk's FindGlobals script
tercio@0 18 -- GLOBALS: CLOSE
tercio@0 19
tercio@0 20 --[[-----------------------------------------------------------------------------
tercio@0 21 Scripts
tercio@0 22 -------------------------------------------------------------------------------]]
tercio@0 23 local function Button_OnClick(frame)
Tercio@17 24 PlaySound(799) -- SOUNDKIT.GS_TITLE_OPTION_EXIT
tercio@0 25 frame.obj:Hide()
tercio@0 26 end
tercio@0 27
Tercio@17 28 local function Frame_OnShow(frame)
Tercio@17 29 frame.obj:Fire("OnShow")
Tercio@17 30 end
Tercio@17 31
tercio@0 32 local function Frame_OnClose(frame)
tercio@0 33 frame.obj:Fire("OnClose")
tercio@0 34 end
tercio@0 35
tercio@0 36 local function Frame_OnMouseDown(frame)
tercio@0 37 AceGUI:ClearFocus()
tercio@0 38 end
tercio@0 39
tercio@0 40 local function Title_OnMouseDown(frame)
tercio@0 41 frame:GetParent():StartMoving()
tercio@0 42 AceGUI:ClearFocus()
tercio@0 43 end
tercio@0 44
tercio@0 45 local function MoverSizer_OnMouseUp(mover)
tercio@0 46 local frame = mover:GetParent()
tercio@0 47 frame:StopMovingOrSizing()
tercio@0 48 local self = frame.obj
tercio@0 49 local status = self.status or self.localstatus
tercio@0 50 status.width = frame:GetWidth()
tercio@0 51 status.height = frame:GetHeight()
tercio@0 52 status.top = frame:GetTop()
tercio@0 53 status.left = frame:GetLeft()
tercio@0 54 end
tercio@0 55
tercio@0 56 local function SizerSE_OnMouseDown(frame)
tercio@0 57 frame:GetParent():StartSizing("BOTTOMRIGHT")
tercio@0 58 AceGUI:ClearFocus()
tercio@0 59 end
tercio@0 60
tercio@0 61 local function SizerS_OnMouseDown(frame)
tercio@0 62 frame:GetParent():StartSizing("BOTTOM")
tercio@0 63 AceGUI:ClearFocus()
tercio@0 64 end
tercio@0 65
tercio@0 66 local function SizerE_OnMouseDown(frame)
tercio@0 67 frame:GetParent():StartSizing("RIGHT")
tercio@0 68 AceGUI:ClearFocus()
tercio@0 69 end
tercio@0 70
tercio@0 71 local function StatusBar_OnEnter(frame)
tercio@0 72 frame.obj:Fire("OnEnterStatusBar")
tercio@0 73 end
tercio@0 74
tercio@0 75 local function StatusBar_OnLeave(frame)
tercio@0 76 frame.obj:Fire("OnLeaveStatusBar")
tercio@0 77 end
tercio@0 78
tercio@0 79 --[[-----------------------------------------------------------------------------
tercio@0 80 Methods
tercio@0 81 -------------------------------------------------------------------------------]]
tercio@0 82 local methods = {
tercio@0 83 ["OnAcquire"] = function(self)
tercio@0 84 self.frame:SetParent(UIParent)
tercio@0 85 self.frame:SetFrameStrata("FULLSCREEN_DIALOG")
tercio@0 86 self:SetTitle()
tercio@0 87 self:SetStatusText()
tercio@0 88 self:ApplyStatus()
tercio@0 89 self:Show()
tercio@0 90 self:EnableResize(true)
tercio@0 91 end,
tercio@0 92
tercio@0 93 ["OnRelease"] = function(self)
tercio@0 94 self.status = nil
tercio@0 95 wipe(self.localstatus)
tercio@0 96 end,
tercio@0 97
tercio@0 98 ["OnWidthSet"] = function(self, width)
tercio@0 99 local content = self.content
tercio@0 100 local contentwidth = width - 34
tercio@0 101 if contentwidth < 0 then
tercio@0 102 contentwidth = 0
tercio@0 103 end
tercio@0 104 content:SetWidth(contentwidth)
tercio@0 105 content.width = contentwidth
tercio@0 106 end,
tercio@0 107
tercio@0 108 ["OnHeightSet"] = function(self, height)
tercio@0 109 local content = self.content
tercio@0 110 local contentheight = height - 57
tercio@0 111 if contentheight < 0 then
tercio@0 112 contentheight = 0
tercio@0 113 end
tercio@0 114 content:SetHeight(contentheight)
tercio@0 115 content.height = contentheight
tercio@0 116 end,
tercio@0 117
tercio@0 118 ["SetTitle"] = function(self, title)
tercio@0 119 self.titletext:SetText(title)
tercio@0 120 self.titlebg:SetWidth((self.titletext:GetWidth() or 0) + 10)
tercio@0 121 end,
tercio@0 122
tercio@0 123 ["SetStatusText"] = function(self, text)
tercio@0 124 self.statustext:SetText(text)
tercio@0 125 end,
tercio@0 126
tercio@0 127 ["Hide"] = function(self)
tercio@0 128 self.frame:Hide()
tercio@0 129 end,
tercio@0 130
tercio@0 131 ["Show"] = function(self)
tercio@0 132 self.frame:Show()
tercio@0 133 end,
tercio@0 134
tercio@0 135 ["EnableResize"] = function(self, state)
tercio@0 136 local func = state and "Show" or "Hide"
tercio@0 137 self.sizer_se[func](self.sizer_se)
tercio@0 138 self.sizer_s[func](self.sizer_s)
tercio@0 139 self.sizer_e[func](self.sizer_e)
tercio@0 140 end,
tercio@0 141
tercio@0 142 -- called to set an external table to store status in
tercio@0 143 ["SetStatusTable"] = function(self, status)
tercio@0 144 assert(type(status) == "table")
tercio@0 145 self.status = status
tercio@0 146 self:ApplyStatus()
tercio@0 147 end,
tercio@0 148
tercio@0 149 ["ApplyStatus"] = function(self)
tercio@0 150 local status = self.status or self.localstatus
tercio@0 151 local frame = self.frame
tercio@0 152 self:SetWidth(status.width or 700)
tercio@0 153 self:SetHeight(status.height or 500)
tercio@0 154 frame:ClearAllPoints()
tercio@0 155 if status.top and status.left then
tercio@0 156 frame:SetPoint("TOP", UIParent, "BOTTOM", 0, status.top)
tercio@0 157 frame:SetPoint("LEFT", UIParent, "LEFT", status.left, 0)
tercio@0 158 else
tercio@0 159 frame:SetPoint("CENTER")
tercio@0 160 end
tercio@0 161 end
tercio@0 162 }
tercio@0 163
tercio@0 164 --[[-----------------------------------------------------------------------------
tercio@0 165 Constructor
tercio@0 166 -------------------------------------------------------------------------------]]
tercio@0 167 local FrameBackdrop = {
tercio@0 168 bgFile = "Interface\\DialogFrame\\UI-DialogBox-Background",
tercio@0 169 edgeFile = "Interface\\DialogFrame\\UI-DialogBox-Border",
tercio@0 170 tile = true, tileSize = 32, edgeSize = 32,
tercio@0 171 insets = { left = 8, right = 8, top = 8, bottom = 8 }
tercio@0 172 }
tercio@0 173
tercio@0 174 local PaneBackdrop = {
tercio@0 175 bgFile = "Interface\\ChatFrame\\ChatFrameBackground",
tercio@0 176 edgeFile = "Interface\\Tooltips\\UI-Tooltip-Border",
tercio@0 177 tile = true, tileSize = 16, edgeSize = 16,
tercio@0 178 insets = { left = 3, right = 3, top = 5, bottom = 3 }
tercio@0 179 }
tercio@0 180
tercio@0 181 local function Constructor()
tercio@0 182 local frame = CreateFrame("Frame", nil, UIParent)
tercio@0 183 frame:Hide()
tercio@0 184
tercio@0 185 frame:EnableMouse(true)
tercio@0 186 frame:SetMovable(true)
tercio@0 187 frame:SetResizable(true)
tercio@0 188 frame:SetFrameStrata("FULLSCREEN_DIALOG")
tercio@0 189 frame:SetBackdrop(FrameBackdrop)
tercio@0 190 frame:SetBackdropColor(0, 0, 0, 1)
tercio@0 191 frame:SetMinResize(400, 200)
tercio@0 192 frame:SetToplevel(true)
Tercio@17 193 frame:SetScript("OnShow", Frame_OnShow)
tercio@0 194 frame:SetScript("OnHide", Frame_OnClose)
tercio@0 195 frame:SetScript("OnMouseDown", Frame_OnMouseDown)
tercio@0 196
tercio@0 197 local closebutton = CreateFrame("Button", nil, frame, "UIPanelButtonTemplate")
tercio@0 198 closebutton:SetScript("OnClick", Button_OnClick)
tercio@0 199 closebutton:SetPoint("BOTTOMRIGHT", -27, 17)
tercio@0 200 closebutton:SetHeight(20)
tercio@0 201 closebutton:SetWidth(100)
tercio@0 202 closebutton:SetText(CLOSE)
tercio@0 203
tercio@0 204 local statusbg = CreateFrame("Button", nil, frame)
tercio@0 205 statusbg:SetPoint("BOTTOMLEFT", 15, 15)
tercio@0 206 statusbg:SetPoint("BOTTOMRIGHT", -132, 15)
tercio@0 207 statusbg:SetHeight(24)
tercio@0 208 statusbg:SetBackdrop(PaneBackdrop)
tercio@0 209 statusbg:SetBackdropColor(0.1,0.1,0.1)
tercio@0 210 statusbg:SetBackdropBorderColor(0.4,0.4,0.4)
tercio@0 211 statusbg:SetScript("OnEnter", StatusBar_OnEnter)
tercio@0 212 statusbg:SetScript("OnLeave", StatusBar_OnLeave)
tercio@0 213
tercio@0 214 local statustext = statusbg:CreateFontString(nil, "OVERLAY", "GameFontNormal")
tercio@0 215 statustext:SetPoint("TOPLEFT", 7, -2)
tercio@0 216 statustext:SetPoint("BOTTOMRIGHT", -7, 2)
tercio@0 217 statustext:SetHeight(20)
tercio@0 218 statustext:SetJustifyH("LEFT")
tercio@0 219 statustext:SetText("")
tercio@0 220
tercio@0 221 local titlebg = frame:CreateTexture(nil, "OVERLAY")
tercio@0 222 titlebg:SetTexture("Interface\\DialogFrame\\UI-DialogBox-Header")
tercio@0 223 titlebg:SetTexCoord(0.31, 0.67, 0, 0.63)
tercio@0 224 titlebg:SetPoint("TOP", 0, 12)
tercio@0 225 titlebg:SetWidth(100)
tercio@0 226 titlebg:SetHeight(40)
tercio@0 227
tercio@0 228 local title = CreateFrame("Frame", nil, frame)
tercio@0 229 title:EnableMouse(true)
tercio@0 230 title:SetScript("OnMouseDown", Title_OnMouseDown)
tercio@0 231 title:SetScript("OnMouseUp", MoverSizer_OnMouseUp)
tercio@0 232 title:SetAllPoints(titlebg)
tercio@0 233
tercio@0 234 local titletext = title:CreateFontString(nil, "OVERLAY", "GameFontNormal")
tercio@0 235 titletext:SetPoint("TOP", titlebg, "TOP", 0, -14)
tercio@0 236
tercio@0 237 local titlebg_l = frame:CreateTexture(nil, "OVERLAY")
tercio@0 238 titlebg_l:SetTexture("Interface\\DialogFrame\\UI-DialogBox-Header")
tercio@0 239 titlebg_l:SetTexCoord(0.21, 0.31, 0, 0.63)
tercio@0 240 titlebg_l:SetPoint("RIGHT", titlebg, "LEFT")
tercio@0 241 titlebg_l:SetWidth(30)
tercio@0 242 titlebg_l:SetHeight(40)
tercio@0 243
tercio@0 244 local titlebg_r = frame:CreateTexture(nil, "OVERLAY")
tercio@0 245 titlebg_r:SetTexture("Interface\\DialogFrame\\UI-DialogBox-Header")
tercio@0 246 titlebg_r:SetTexCoord(0.67, 0.77, 0, 0.63)
tercio@0 247 titlebg_r:SetPoint("LEFT", titlebg, "RIGHT")
tercio@0 248 titlebg_r:SetWidth(30)
tercio@0 249 titlebg_r:SetHeight(40)
tercio@0 250
tercio@0 251 local sizer_se = CreateFrame("Frame", nil, frame)
tercio@0 252 sizer_se:SetPoint("BOTTOMRIGHT")
tercio@0 253 sizer_se:SetWidth(25)
tercio@0 254 sizer_se:SetHeight(25)
tercio@0 255 sizer_se:EnableMouse()
tercio@0 256 sizer_se:SetScript("OnMouseDown",SizerSE_OnMouseDown)
tercio@0 257 sizer_se:SetScript("OnMouseUp", MoverSizer_OnMouseUp)
tercio@0 258
tercio@0 259 local line1 = sizer_se:CreateTexture(nil, "BACKGROUND")
tercio@0 260 line1:SetWidth(14)
tercio@0 261 line1:SetHeight(14)
tercio@0 262 line1:SetPoint("BOTTOMRIGHT", -8, 8)
tercio@0 263 line1:SetTexture("Interface\\Tooltips\\UI-Tooltip-Border")
tercio@0 264 local x = 0.1 * 14/17
tercio@0 265 line1:SetTexCoord(0.05 - x, 0.5, 0.05, 0.5 + x, 0.05, 0.5 - x, 0.5 + x, 0.5)
tercio@0 266
tercio@0 267 local line2 = sizer_se:CreateTexture(nil, "BACKGROUND")
tercio@0 268 line2:SetWidth(8)
tercio@0 269 line2:SetHeight(8)
tercio@0 270 line2:SetPoint("BOTTOMRIGHT", -8, 8)
tercio@0 271 line2:SetTexture("Interface\\Tooltips\\UI-Tooltip-Border")
tercio@0 272 local x = 0.1 * 8/17
tercio@0 273 line2:SetTexCoord(0.05 - x, 0.5, 0.05, 0.5 + x, 0.05, 0.5 - x, 0.5 + x, 0.5)
tercio@0 274
tercio@0 275 local sizer_s = CreateFrame("Frame", nil, frame)
tercio@0 276 sizer_s:SetPoint("BOTTOMRIGHT", -25, 0)
tercio@0 277 sizer_s:SetPoint("BOTTOMLEFT")
tercio@0 278 sizer_s:SetHeight(25)
tercio@0 279 sizer_s:EnableMouse(true)
tercio@0 280 sizer_s:SetScript("OnMouseDown", SizerS_OnMouseDown)
tercio@0 281 sizer_s:SetScript("OnMouseUp", MoverSizer_OnMouseUp)
tercio@0 282
tercio@0 283 local sizer_e = CreateFrame("Frame", nil, frame)
tercio@0 284 sizer_e:SetPoint("BOTTOMRIGHT", 0, 25)
tercio@0 285 sizer_e:SetPoint("TOPRIGHT")
tercio@0 286 sizer_e:SetWidth(25)
tercio@0 287 sizer_e:EnableMouse(true)
tercio@0 288 sizer_e:SetScript("OnMouseDown", SizerE_OnMouseDown)
tercio@0 289 sizer_e:SetScript("OnMouseUp", MoverSizer_OnMouseUp)
tercio@0 290
tercio@0 291 --Container Support
tercio@0 292 local content = CreateFrame("Frame", nil, frame)
tercio@0 293 content:SetPoint("TOPLEFT", 17, -27)
tercio@0 294 content:SetPoint("BOTTOMRIGHT", -17, 40)
tercio@0 295
tercio@0 296 local widget = {
tercio@0 297 localstatus = {},
tercio@0 298 titletext = titletext,
tercio@0 299 statustext = statustext,
tercio@0 300 titlebg = titlebg,
tercio@0 301 sizer_se = sizer_se,
tercio@0 302 sizer_s = sizer_s,
tercio@0 303 sizer_e = sizer_e,
tercio@0 304 content = content,
tercio@0 305 frame = frame,
tercio@0 306 type = Type
tercio@0 307 }
tercio@0 308 for method, func in pairs(methods) do
tercio@0 309 widget[method] = func
tercio@0 310 end
tercio@0 311 closebutton.obj, statusbg.obj = widget, widget
tercio@0 312
tercio@0 313 return AceGUI:RegisterAsContainer(widget)
tercio@0 314 end
tercio@0 315
tercio@0 316 AceGUI:RegisterWidgetType(Type, Constructor, Version)