Mercurial > wow > icu

annotate Libs/AceGUI-3.0/widgets/AceGUIContainer-ScrollFrame.lua @ 15:21cefa363c73 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Last modification to ready checking broke something ... Now its fixed and ready checking is working as intended.
author Xiiph
date Fri, 25 Feb 2011 01:21:13 +0100
parents 98c6f55e6619
children
rev   line source
Xiiph@0 1 --[[-----------------------------------------------------------------------------
Xiiph@0 2 ScrollFrame Container
Xiiph@0 3 Plain container that scrolls its content and doesn't grow in height.
Xiiph@0 4 -------------------------------------------------------------------------------]]
Xiiph@0 5 local Type, Version = "ScrollFrame", 21
Xiiph@0 6 local AceGUI = LibStub and LibStub("AceGUI-3.0", true)
Xiiph@0 7 if not AceGUI or (AceGUI:GetWidgetVersion(Type) or 0) >= Version then return end
Xiiph@0 8
Xiiph@0 9 -- Lua APIs
Xiiph@0 10 local pairs, assert, type = pairs, assert, type
Xiiph@0 11 local min, max, floor, abs = math.min, math.max, math.floor, math.abs
Xiiph@0 12
Xiiph@0 13 -- WoW APIs
Xiiph@0 14 local CreateFrame, UIParent = CreateFrame, UIParent
Xiiph@0 15
Xiiph@0 16 --[[-----------------------------------------------------------------------------
Xiiph@0 17 Support functions
Xiiph@0 18 -------------------------------------------------------------------------------]]
Xiiph@0 19 local function FixScrollOnUpdate(frame)
Xiiph@0 20 frame:SetScript("OnUpdate", nil)
Xiiph@0 21 frame.obj:FixScroll()
Xiiph@0 22 end
Xiiph@0 23
Xiiph@0 24 --[[-----------------------------------------------------------------------------
Xiiph@0 25 Scripts
Xiiph@0 26 -------------------------------------------------------------------------------]]
Xiiph@0 27 local function ScrollFrame_OnMouseWheel(frame, value)
Xiiph@0 28 frame.obj:MoveScroll(value)
Xiiph@0 29 end
Xiiph@0 30
Xiiph@0 31 local function ScrollFrame_OnSizeChanged(frame)
Xiiph@0 32 frame:SetScript("OnUpdate", FixScrollOnUpdate)
Xiiph@0 33 end
Xiiph@0 34
Xiiph@0 35 local function ScrollBar_OnScrollValueChanged(frame, value)
Xiiph@0 36 frame.obj:SetScroll(value)
Xiiph@0 37 end
Xiiph@0 38
Xiiph@0 39 --[[-----------------------------------------------------------------------------
Xiiph@0 40 Methods
Xiiph@0 41 -------------------------------------------------------------------------------]]
Xiiph@0 42 local methods = {
Xiiph@0 43 ["OnAcquire"] = function(self)
Xiiph@0 44 self:SetScroll(0)
Xiiph@0 45 end,
Xiiph@0 46
Xiiph@0 47 ["OnRelease"] = function(self)
Xiiph@0 48 self.status = nil
Xiiph@0 49 for k in pairs(self.localstatus) do
Xiiph@0 50 self.localstatus[k] = nil
Xiiph@0 51 end
Xiiph@0 52 self.scrollframe:SetPoint("BOTTOMRIGHT")
Xiiph@0 53 self.scrollbar:Hide()
Xiiph@0 54 self.scrollBarShown = nil
Xiiph@0 55 self.content.height, self.content.width = nil, nil
Xiiph@0 56 end,
Xiiph@0 57
Xiiph@0 58 ["SetScroll"] = function(self, value)
Xiiph@0 59 local status = self.status or self.localstatus
Xiiph@0 60 local viewheight = self.scrollframe:GetHeight()
Xiiph@0 61 local height = self.content:GetHeight()
Xiiph@0 62 local offset
Xiiph@0 63
Xiiph@0 64 if viewheight > height then
Xiiph@0 65 offset = 0
Xiiph@0 66 else
Xiiph@0 67 offset = floor((height - viewheight) / 1000.0 * value)
Xiiph@0 68 end
Xiiph@0 69 self.content:ClearAllPoints()
Xiiph@0 70 self.content:SetPoint("TOPLEFT", 0, offset)
Xiiph@0 71 self.content:SetPoint("TOPRIGHT", 0, offset)
Xiiph@0 72 status.offset = offset
Xiiph@0 73 status.scrollvalue = value
Xiiph@0 74 end,
Xiiph@0 75
Xiiph@0 76 ["MoveScroll"] = function(self, value)
Xiiph@0 77 local status = self.status or self.localstatus
Xiiph@0 78 local height, viewheight = self.scrollframe:GetHeight(), self.content:GetHeight()
Xiiph@0 79
Xiiph@0 80 if self.scrollBarShown then
Xiiph@0 81 local diff = height - viewheight
Xiiph@0 82 local delta = 1
Xiiph@0 83 if value < 0 then
Xiiph@0 84 delta = -1
Xiiph@0 85 end
Xiiph@0 86 self.scrollbar:SetValue(min(max(status.scrollvalue + delta*(1000/(diff/45)),0), 1000))
Xiiph@0 87 end
Xiiph@0 88 end,
Xiiph@0 89
Xiiph@0 90 ["FixScroll"] = function(self)
Xiiph@0 91 if self.updateLock then return end
Xiiph@0 92 self.updateLock = true
Xiiph@0 93 local status = self.status or self.localstatus
Xiiph@0 94 local height, viewheight = self.scrollframe:GetHeight(), self.content:GetHeight()
Xiiph@0 95 local offset = status.offset or 0
Xiiph@0 96 local curvalue = self.scrollbar:GetValue()
Xiiph@0 97 -- Give us a margin of error of 2 pixels to stop some conditions that i would blame on floating point inaccuracys
Xiiph@0 98 -- No-one is going to miss 2 pixels at the bottom of the frame, anyhow!
Xiiph@0 99 if viewheight < height + 2 then
Xiiph@0 100 if self.scrollBarShown then
Xiiph@0 101 self.scrollBarShown = nil
Xiiph@0 102 self.scrollbar:Hide()
Xiiph@0 103 self.scrollbar:SetValue(0)
Xiiph@0 104 self.scrollframe:SetPoint("BOTTOMRIGHT")
Xiiph@0 105 self:DoLayout()
Xiiph@0 106 end
Xiiph@0 107 else
Xiiph@0 108 if not self.scrollBarShown then
Xiiph@0 109 self.scrollBarShown = true
Xiiph@0 110 self.scrollbar:Show()
Xiiph@0 111 self.scrollframe:SetPoint("BOTTOMRIGHT", -20, 0)
Xiiph@0 112 self:DoLayout()
Xiiph@0 113 end
Xiiph@0 114 local value = (offset / (viewheight - height) * 1000)
Xiiph@0 115 if value > 1000 then value = 1000 end
Xiiph@0 116 self.scrollbar:SetValue(value)
Xiiph@0 117 self:SetScroll(value)
Xiiph@0 118 if value < 1000 then
Xiiph@0 119 self.content:ClearAllPoints()
Xiiph@0 120 self.content:SetPoint("TOPLEFT", 0, offset)
Xiiph@0 121 self.content:SetPoint("TOPRIGHT", 0, offset)
Xiiph@0 122 status.offset = offset
Xiiph@0 123 end
Xiiph@0 124 end
Xiiph@0 125 self.updateLock = nil
Xiiph@0 126 end,
Xiiph@0 127
Xiiph@0 128 ["LayoutFinished"] = function(self, width, height)
Xiiph@0 129 self.content:SetHeight(height or 0 + 20)
Xiiph@0 130 self.scrollframe:SetScript("OnUpdate", FixScrollOnUpdate)
Xiiph@0 131 end,
Xiiph@0 132
Xiiph@0 133 ["SetStatusTable"] = function(self, status)
Xiiph@0 134 assert(type(status) == "table")
Xiiph@0 135 self.status = status
Xiiph@0 136 if not status.scrollvalue then
Xiiph@0 137 status.scrollvalue = 0
Xiiph@0 138 end
Xiiph@0 139 end,
Xiiph@0 140
Xiiph@0 141 ["OnWidthSet"] = function(self, width)
Xiiph@0 142 local content = self.content
Xiiph@0 143 content.width = width
Xiiph@0 144 end,
Xiiph@0 145
Xiiph@0 146 ["OnHeightSet"] = function(self, height)
Xiiph@0 147 local content = self.content
Xiiph@0 148 content.height = height
Xiiph@0 149 end
Xiiph@0 150 }
Xiiph@0 151 --[[-----------------------------------------------------------------------------
Xiiph@0 152 Constructor
Xiiph@0 153 -------------------------------------------------------------------------------]]
Xiiph@0 154 local function Constructor()
Xiiph@0 155 local frame = CreateFrame("Frame", nil, UIParent)
Xiiph@0 156 local num = AceGUI:GetNextWidgetNum(Type)
Xiiph@0 157
Xiiph@0 158 local scrollframe = CreateFrame("ScrollFrame", nil, frame)
Xiiph@0 159 scrollframe:SetPoint("TOPLEFT")
Xiiph@0 160 scrollframe:SetPoint("BOTTOMRIGHT")
Xiiph@0 161 scrollframe:EnableMouseWheel(true)
Xiiph@0 162 scrollframe:SetScript("OnMouseWheel", ScrollFrame_OnMouseWheel)
Xiiph@0 163 scrollframe:SetScript("OnSizeChanged", ScrollFrame_OnSizeChanged)
Xiiph@0 164
Xiiph@0 165 local scrollbar = CreateFrame("Slider", ("AceConfigDialogScrollFrame%dScrollBar"):format(num), scrollframe, "UIPanelScrollBarTemplate")
Xiiph@0 166 scrollbar:SetPoint("TOPLEFT", scrollframe, "TOPRIGHT", 4, -16)
Xiiph@0 167 scrollbar:SetPoint("BOTTOMLEFT", scrollframe, "BOTTOMRIGHT", 4, 16)
Xiiph@0 168 scrollbar:SetMinMaxValues(0, 1000)
Xiiph@0 169 scrollbar:SetValueStep(1)
Xiiph@0 170 scrollbar:SetValue(0)
Xiiph@0 171 scrollbar:SetWidth(16)
Xiiph@0 172 scrollbar:Hide()
Xiiph@0 173 -- set the script as the last step, so it doesn't fire yet
Xiiph@0 174 scrollbar:SetScript("OnValueChanged", ScrollBar_OnScrollValueChanged)
Xiiph@0 175
Xiiph@0 176 local scrollbg = scrollbar:CreateTexture(nil, "BACKGROUND")
Xiiph@0 177 scrollbg:SetAllPoints(scrollbar)
Xiiph@0 178 scrollbg:SetTexture(0, 0, 0, 0.4)
Xiiph@0 179
Xiiph@0 180 --Container Support
Xiiph@0 181 local content = CreateFrame("Frame", nil, scrollframe)
Xiiph@0 182 content:SetPoint("TOPLEFT")
Xiiph@0 183 content:SetPoint("TOPRIGHT")
Xiiph@0 184 content:SetHeight(400)
Xiiph@0 185 scrollframe:SetScrollChild(content)
Xiiph@0 186
Xiiph@0 187 local widget = {
Xiiph@0 188 localstatus = { scrollvalue = 0 },
Xiiph@0 189 scrollframe = scrollframe,
Xiiph@0 190 scrollbar = scrollbar,
Xiiph@0 191 content = content,
Xiiph@0 192 frame = frame,
Xiiph@0 193 type = Type
Xiiph@0 194 }
Xiiph@0 195 for method, func in pairs(methods) do
Xiiph@0 196 widget[method] = func
Xiiph@0 197 end
Xiiph@0 198 scrollframe.obj, scrollbar.obj = widget, widget
Xiiph@0 199
Xiiph@0 200 return AceGUI:RegisterAsContainer(widget)
Xiiph@0 201 end
Xiiph@0 202
Xiiph@0 203 AceGUI:RegisterWidgetType(Type, Constructor, Version)