annotate Libs/AceGUI-3.0/widgets/AceGUIContainer-Frame.lua @ 59:8a4c1438dbdf

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