Framework update

This commit is contained in:
Tercio Jose
2022-09-21 16:50:17 -03:00
parent 5e847efe3c
commit e2196f64c7
3 changed files with 269 additions and 183 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
local dversion = 355
local dversion = 356
local major, minor = "DetailsFramework-1.0", dversion
local DF, oldminor = LibStub:NewLibrary (major, minor)
+255 -1
View File
@@ -80,4 +80,258 @@ DF.PayloadMixin = {
local duplicatedPayload = DF.table.duplicate({}, self.payload)
return duplicatedPayload
end,
}
}
DF.ScrollBoxFunctions = {
Refresh = function(self)
--hide all frames and tag as not in use
for index, frame in ipairs(self.Frames) do
frame:Hide()
frame._InUse = nil
end
local offset = 0
if (self.IsFauxScroll) then
self:UpdateFaux(#self.data, self.LineAmount, self.LineHeight)
offset = self:GetOffsetFaux()
end
DF:CoreDispatch((self:GetName() or "ScrollBox") .. ":Refresh()", self.refresh_func, self, self.data, offset, self.LineAmount)
for index, frame in ipairs(self.Frames) do
if (not frame._InUse) then
frame:Hide()
else
frame:Show()
end
end
self:Show()
if (self.HideScrollBar) then
local frameName = self:GetName()
if (frameName) then
local scrollBar = _G[frameName .. "ScrollBar"]
if (scrollBar) then
scrollBar:Hide()
end
end
end
return self.Frames
end,
OnVerticalScroll = function(self, offset)
self:OnVerticalScrollFaux(offset, self.LineHeight, self.Refresh)
return true
end,
CreateLine = function(self, func)
if (not func) then
func = self.CreateLineFunc
end
local okay, newLine = pcall(func, self, #self.Frames+1)
if (okay) then
tinsert(self.Frames, newLine)
newLine.Index = #self.Frames
return newLine
else
error("Details! FrameWork: CreateLine(): " .. newLine)
end
end,
GetLine = function(self, lineIndex)
local line = self.Frames[lineIndex]
if (line) then
line._InUse = true
end
return line
end,
SetData = function(self, data)
self.data = data
end,
GetData = function(self)
return self.data
end,
GetFrames = function(self)
return self.Frames
end,
GetLines = function(self) --alias of GetFrames
return self.Frames
end,
GetNumFramesCreated = function(self)
return #self.Frames
end,
GetNumFramesShown = function(self)
return self.LineAmount
end,
SetNumFramesShown = function(self, newAmount)
--hide frames which won't be used
if (newAmount < #self.Frames) then
for i = newAmount+1, #self.Frames do
self.Frames[i]:Hide()
end
end
--set the new amount
self.LineAmount = newAmount
end,
SetFramesHeight = function(self, height)
self.LineHeight = height
self:OnSizeChanged()
self:Refresh()
end,
OnSizeChanged = function(self)
if (self.ReajustNumFrames) then
--how many lines the scroll can show
local amountOfFramesToShow = floor(self:GetHeight() / self.LineHeight)
--how many lines the scroll already have
local totalFramesCreated = self:GetNumFramesCreated()
--how many lines are current shown
local totalFramesShown = self:GetNumFramesShown()
--the amount of frames increased
if (amountOfFramesToShow > totalFramesShown) then
for i = totalFramesShown+1, amountOfFramesToShow do
--check if need to create a new line
if (i > totalFramesCreated) then
self:CreateLine(self.CreateLineFunc)
end
end
--the amount of frames decreased
elseif (amountOfFramesToShow < totalFramesShown) then
--hide all frames above the new amount to show
for i = totalFramesCreated, amountOfFramesToShow, -1 do
if (self.Frames[i]) then
self.Frames[i]:Hide()
end
end
end
--set the new amount of frames
self:SetNumFramesShown(amountOfFramesToShow)
--refresh lines
self:Refresh()
end
end,
--moved functions from blizzard faux scroll that are called from insecure code environment
--this reduces the amount of taints while using the faux scroll frame
GetOffsetFaux = function(self)
return self.offset or 0
end,
OnVerticalScrollFaux = function(self, value, itemHeight, updateFunction)
local scrollbar = self:GetChildFramesFaux();
scrollbar:SetValue(value);
self.offset = math.floor((value / itemHeight) + 0.5);
if (updateFunction) then
updateFunction(self)
end
end,
GetChildFramesFaux = function(frame)
local frameName = frame:GetName();
if frameName then
return _G[ frameName.."ScrollBar" ], _G[ frameName.."ScrollChildFrame" ], _G[ frameName.."ScrollBarScrollUpButton" ], _G[ frameName.."ScrollBarScrollDownButton" ];
else
return frame.ScrollBar, frame.ScrollChildFrame, frame.ScrollBar.ScrollUpButton, frame.ScrollBar.ScrollDownButton;
end
end,
UpdateFaux = function(frame, numItems, numToDisplay, buttonHeight, button, smallWidth, bigWidth, highlightFrame, smallHighlightWidth, bigHighlightWidth, alwaysShowScrollBar)
local scrollBar, scrollChildFrame, scrollUpButton, scrollDownButton = frame:GetChildFramesFaux();
-- If more than one screen full of items then show the scrollbar
local showScrollBar;
if ( numItems > numToDisplay or alwaysShowScrollBar ) then
frame:Show();
showScrollBar = 1;
else
scrollBar:SetValue(0);
frame:Hide();
end
if ( frame:IsShown() ) then
local scrollFrameHeight = 0;
local scrollChildHeight = 0;
if ( numItems > 0 ) then
scrollFrameHeight = (numItems - numToDisplay) * buttonHeight;
scrollChildHeight = numItems * buttonHeight;
if ( scrollFrameHeight < 0 ) then
scrollFrameHeight = 0;
end
scrollChildFrame:Show();
else
scrollChildFrame:Hide();
end
local maxRange = (numItems - numToDisplay) * buttonHeight;
if (maxRange < 0) then
maxRange = 0;
end
scrollBar:SetMinMaxValues(0, maxRange);
scrollBar:SetValueStep(buttonHeight);
scrollBar:SetStepsPerPage(numToDisplay-1);
scrollChildFrame:SetHeight(scrollChildHeight);
-- Arrow button handling
if ( scrollBar:GetValue() == 0 ) then
scrollUpButton:Disable();
else
scrollUpButton:Enable();
end
if ((scrollBar:GetValue() - scrollFrameHeight) == 0) then
scrollDownButton:Disable();
else
scrollDownButton:Enable();
end
-- Shrink because scrollbar is shown
if ( highlightFrame ) then
highlightFrame:SetWidth(smallHighlightWidth);
end
if ( button ) then
for i=1, numToDisplay do
_G[button..i]:SetWidth(smallWidth);
end
end
else
-- Widen because scrollbar is hidden
if ( highlightFrame ) then
highlightFrame:SetWidth(bigHighlightWidth);
end
if ( button ) then
for i=1, numToDisplay do
_G[button..i]:SetWidth(bigWidth);
end
end
end
return showScrollBar;
end,
}
local SortMember = ""
local SortByMember = function (t1, t2)
return t1[SortMember] > t2[SortMember]
end
local SortByMemberReverse = function (t1, t2)
return t1[SortMember] < t2[SortMember]
end
DF.SortFunctions = {
Sort = function(self, thisTable, memberName, isReverse)
SortMember = memberName
if (not isReverse) then
table.sort(thisTable, SortByMember)
else
table.sort(thisTable, SortByMemberReverse)
end
end
}
+13 -181
View File
@@ -4231,196 +4231,28 @@ end
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-- ~scrollbox
DF.SortFunctions = {}
local SortMember = ""
local SortByMember = function (t1, t2)
return t1[SortMember] > t2[SortMember]
end
local SortByMemberReverse = function (t1, t2)
return t1[SortMember] < t2[SortMember]
end
DF.SortFunctions.Sort = function (self, t, by, is_reverse)
SortMember = by
if (not is_reverse) then
table.sort (t, SortByMember)
else
table.sort (t, SortByMemberReverse)
end
end
DF.ScrollBoxFunctions = {}
DF.ScrollBoxFunctions.Refresh = function (self)
for _, frame in ipairs (self.Frames) do
frame:Hide()
frame._InUse = nil
end
function DF:CreateScrollBox (parent, name, refreshFunc, data, width, height, lineAmount, lineHeight, createLineFunc, autoAmount, noScroll)
local scroll = CreateFrame("scrollframe", name, parent, "FauxScrollFrameTemplate, BackdropTemplate")
local offset = 0
if (self.IsFauxScroll) then
FauxScrollFrame_Update (self, #self.data, self.LineAmount, self.LineHeight)
offset = FauxScrollFrame_GetOffset (self)
end
DF:CoreDispatch ((self:GetName() or "ScrollBox") .. ":Refresh()", self.refresh_func, self, self.data, offset, self.LineAmount)
for _, frame in ipairs (self.Frames) do
if (not frame._InUse) then
frame:Hide()
else
frame:Show()
end
end
self:Show()
if (self.HideScrollBar) then
local frameName = self:GetName()
if (frameName) then
local scrollBar = _G [frameName .. "ScrollBar"]
if (scrollBar) then
scrollBar:Hide()
end
else
end
end
return self.Frames
end
DF.ScrollBoxFunctions.OnVerticalScroll = function (self, offset)
FauxScrollFrame_OnVerticalScroll (self, offset, self.LineHeight, self.Refresh)
return true
end
DF.ScrollBoxFunctions.CreateLine = function (self, func)
if (not func) then
func = self.CreateLineFunc
end
local okay, newLine = pcall (func, self, #self.Frames+1)
if (okay) then
tinsert (self.Frames, newLine)
newLine.Index = #self.Frames
return newLine
else
error ("Details! FrameWork: CreateLine(): " .. newLine)
end
end
DF.ScrollBoxFunctions.GetLine = function (self, line_index)
local line = self.Frames [line_index]
if (line) then
line._InUse = true
end
return line
end
DF.ScrollBoxFunctions.SetData = function (self, data)
self.data = data
end
DF.ScrollBoxFunctions.GetData = function (self)
return self.data
end
DF.ScrollBoxFunctions.GetFrames = function (self)
return self.Frames
end
DF.ScrollBoxFunctions.GetLines = function (self) --alias of GetFrames
return self.Frames
end
DF.ScrollBoxFunctions.GetNumFramesCreated = function (self)
return #self.Frames
end
DF.ScrollBoxFunctions.GetNumFramesShown = function (self)
return self.LineAmount
end
DF.ScrollBoxFunctions.SetNumFramesShown = function (self, new_amount)
--> hide frames which won't be used
if (new_amount < #self.Frames) then
for i = new_amount+1, #self.Frames do
self.Frames [i]:Hide()
end
end
--> set the new amount
self.LineAmount = new_amount
end
DF.ScrollBoxFunctions.SetFramesHeight = function (self, new_height)
self.LineHeight = new_height
self:OnSizeChanged()
self:Refresh()
end
DF.ScrollBoxFunctions.OnSizeChanged = function (self)
if (self.ReajustNumFrames) then
--> how many lines the scroll can show
local amountOfFramesToShow = floor (self:GetHeight() / self.LineHeight)
--> how many lines the scroll already have
local totalFramesCreated = self:GetNumFramesCreated()
--> how many lines are current shown
local totalFramesShown = self:GetNumFramesShown()
--> the amount of frames increased
if (amountOfFramesToShow > totalFramesShown) then
for i = totalFramesShown+1, amountOfFramesToShow do
--> check if need to create a new line
if (i > totalFramesCreated) then
self:CreateLine (self.CreateLineFunc)
end
end
--> the amount of frames decreased
elseif (amountOfFramesToShow < totalFramesShown) then
--> hide all frames above the new amount to show
for i = totalFramesCreated, amountOfFramesToShow, -1 do
if (self.Frames [i]) then
self.Frames [i]:Hide()
end
end
end
--> set the new amount of frames
self:SetNumFramesShown (amountOfFramesToShow)
--> refresh lines
self:Refresh()
end
end
function DF:CreateScrollBox (parent, name, refresh_func, data, width, height, line_amount, line_height, create_line_func, auto_amount, no_scroll)
local scroll = CreateFrame ("scrollframe", name, parent, "FauxScrollFrameTemplate,BackdropTemplate")
DF:ApplyStandardBackdrop (scroll)
DF:ApplyStandardBackdrop(scroll)
scroll:SetSize (width, height)
scroll.LineAmount = line_amount
scroll.LineHeight = line_height
scroll.LineAmount = lineAmount
scroll.LineHeight = lineHeight
scroll.IsFauxScroll = true
scroll.HideScrollBar = no_scroll
scroll.HideScrollBar = noScroll
scroll.Frames = {}
scroll.ReajustNumFrames = auto_amount
scroll.CreateLineFunc = create_line_func
scroll.ReajustNumFrames = autoAmount
scroll.CreateLineFunc = createLineFunc
DF:Mixin (scroll, DF.SortFunctions)
DF:Mixin (scroll, DF.ScrollBoxFunctions)
DF:Mixin(scroll, DF.SortFunctions)
DF:Mixin(scroll, DF.ScrollBoxFunctions)
scroll.refresh_func = refresh_func
scroll.refresh_func = refreshFunc
scroll.data = data
scroll:SetScript ("OnVerticalScroll", scroll.OnVerticalScroll)
scroll:SetScript ("OnSizeChanged", DF.ScrollBoxFunctions.OnSizeChanged)
scroll:SetScript("OnVerticalScroll", scroll.OnVerticalScroll)
scroll:SetScript("OnSizeChanged", DF.ScrollBoxFunctions.OnSizeChanged)
return scroll
end