Hiding Secure Frames

corveroth · 04-03-10, 03:51 AM

I've recently turned up a bug in my addon CRAP. CRAP functions as a replacement for Blizzard's companions UI (the Companions and Mounts tabs of the Pets frame), and to get my setup into place, I found it most convenient to simply hide Blizzard's bits and pieces (the PetPaperDollFrameCompanionFrame) and hook the OnClick scripts for the Mounts/Pets tab buttons.

The PetPaperDollFrameCompanionFrame is implicitly protected by the twelve CompanionButtonNs. In order to keep those and the PPDFCF hidden, I (along with the help of some kind folks over at WowAce) came up with this snippet, which seemed to keep everything hidden nicely.

Code:

for i=1,12 do
    SecureHandlerWrapScript(_G["CompanionButton"..i], "OnShow", _G["CompanionButton"..i],
        [[ self:Hide() self:GetParent():Hide() ]])
end

And I just recently discovered that it's not quite working perfectly. First, this is the snippet that manages hooking the tab buttons:

Code:

-- "Pet" button
PetPaperDollFrameTab1:HookScript("OnClick", function(self)
    FUR:Hide(); -- FUR is the frame that I use for listing companions/mounts
end)

-- "Companions" button
PetPaperDollFrameTab2:HookScript("OnClick", function(self)
    COMPANIONTYPE = "CRITTER"
    sortbutton:Disable()
    scrollbar:SetMinMaxValues(0, math.max(0, GetNumCompanions(COMPANIONTYPE) - NUMROWS))
    scrollbar:SetValue(0)
    Show(); -- This just does a bit of background work before calling FUR:Show()
end)

-- "Mounts" button
PetPaperDollFrameTab3:HookScript("OnClick", function(self)
    COMPANIONTYPE = "MOUNT"
    sortbutton:Enable()
    scrollbar:SetMinMaxValues(0, math.max(0, GetNumCompanions(COMPANIONTYPE) - NUMROWS))
    scrollbar:SetValue(0)
    Show();
end)

When my frame first shows, the script on CompanionButton1 fires. However, it seems to die at that point - if you click on Tab2 or Tab3, the script on Button2 (and only Button2) will fire. So on and so forth until after twelve clicks on Tab2 and/or Tab3, there are no more CompanionButtons firing their script and the Blizzard UI shows up underneath mine. Interestingly, only the PPDFCF shows up - the CompanionButtons remain hidden.

So, what the hell am I doing wrong, what have I missed? I've got a hunch this has something to do with tainting issues, simply because secure frames are involved, and quite honestly, I'm lost when it comes to secure handlers/headers (and I'm not really sure what those terms are or mean). I'd appreciate any guidance.

nightcracker · 04-03-10, 06:45 AM

Fairly simple: use the same handler script for the blizzard companion UI frame.

corveroth · 04-03-10, 11:15 AM

That was my initial approach, but the PPDFCF isn't itself secure, so I can't use SecureHandlerWrapScript on it. It's implicitly protected by its children, which is why the script I was wrapping on them calls self:GetParent():Hide().

Slakah · 04-03-10, 01:07 PM

try replacing:

Code:

for i=1,12 do
    SecureHandlerWrapScript(_G["CompanionButton"..i], "OnShow", _G["CompanionButton"..i],
        [[ self:Hide() self:GetParent():Hide() ]])
end

with just

Code:

CompanionButton1:WrapScript("OnShow", [[self:GetParent():Hide()]])

corveroth · 04-04-10, 01:32 AM

Originally Posted by Slakah

try replacing:

Code:

for i=1,12 do
    SecureHandlerWrapScript(_G["CompanionButton"..i], "OnShow", _G["CompanionButton"..i],
        [[ self:Hide() self:GetParent():Hide() ]])
end

with just

Code:

CompanionButton1:WrapScript("OnShow", [[self:GetParent():Hide()]])

*blink* Well, that works. And from a bit of tinkering, the problem was that I was hiding the button and then its parent... how did that even work in the first place?

Thank you regardless =) If I could ask one more favor, could you describe "headers" and "handlers" in your own terms? I've read over Iriel's guide several times, but some fresh wording might help me wrap my mind around matters better.

Foxlit · 04-04-10, 04:41 AM

Originally Posted by corveroth

Thank you regardless =) If I could ask one more favor, could you describe "headers" and "handlers" in your own terms? I've read over Iriel's guide several times, but some fresh wording might help me wrap my mind around matters better.

http://www.wowwiki.com/SecureHandlers should work.

Personally, I think the easier way to hide a protected frame is to reparent it to a hidden frame rather than mucking about with secure handlers:

Code:

local jail = CreateFrame("Frame"); jail:Hide();
for i=1,12 do
 _G["CompanionButton"..i]:SetParent(jail);
end

As long as nothing attempts to change the parent again (and, in most cases, nothing will), your frame will remain hidden without any incurring additional per-Show() costs.

corveroth · 04-04-10, 02:19 PM

Originally Posted by Foxlit

As long as nothing attempts to change the parent again (and, in most cases, nothing will), your frame will remain hidden without any incurring additional per-Show() costs.

But, won't that taint the CompanionButtons?

Grimsin · 04-04-10, 05:15 PM

What i would like to know is how to go about making a button to hide/show a secure frame like the bag bar or an action button bar.

Foxlit · 04-04-10, 05:22 PM

Originally Posted by corveroth

But, won't that taint the CompanionButtons?

Nope, it should be fine -- changing a frame's parent does not taint the frame. The only limitation is that you would have to call SetParent out of combat, but you can easily achieve that while your addon is loading.

Originally Posted by Grimsin

What i would like to know is how to go about making a button to hide/show a secure frame like the bag bar or an action button bar.

That matches the example on http://www.wowwiki.com/SecureHandlerClickTemplate almost exactly. Summarized, the answer is: you use a securehandler snippet to do it.

Grimsin · 04-04-10, 07:21 PM

yea except who ever wrote that assumed you knew a lot more then i do about how that works.......

i need it more simple then what was posted there.

corveroth · 04-04-10, 07:41 PM

I know how you feel; much of the literature on secure frames is a bit more technical than much of the rest of the WoW-related documentation lying around. Not that technical is bad, but it's less friendly to relative beginners. I think I can explain this, though.

First, a frame is created, pretty standard stuff - fourth argument signifies that it inherits the SecureHandlerClickTemplate. The next command sets a script to execute when the frame is clicked on. That script is provided as a string (using the [=[ and ]=] delimiters here, so that quotation marks can be used inside without having to escape them). Presumably, the reason that the "onclick" function is provided as a string (instead of, say, an anonymous function) is to prevent it from violating any of the restrictions on secure frames - some part of the UI will go through the string and check to make sure it doesn't contain any banned keywords, etc. The script provided is mostly straightforward.

SetFrameRef appears to take two arguments, a name (string) and a reference to a frame. The reason it's necessary is that normally, within the onclick script, "MyClickButton" can't just access other frames at will. SetFrameRef essentially gives them aliases ("frame1" and "frame2") by which they can be referred to via GetFrameRef within the script.

That's the explanation I can give, and I wish I understood why parts of this architecture are there. Someone more knowledgeable is welcome to correct me.

Code:

local frame = CreateFrame("BUTTON", "MyClickButton", UIParent, "SecureHandlerClickTemplate");
frame:SetAttribute("_onclick", [=[
 local show, i, ref = button == "LeftButton", 2, self:GetFrameRef("frame1");
 while ref do
  if show then ref:Show(); else ref:Hide(); end
  i, ref = i + 1, self:GetFrameRef("frame" .. i);
 end
]=]); 
frame:RegisterForClicks("AnyUp");
frame:SetFrameRef("frame1", PlayerFrame);
frame:SetFrameRef("frame2", TargetFrame);
-- ...

Grimsin · 04-04-10, 07:54 PM

So what would i do to the wow wiki method to seperate the clicks? so that i have toggle with both left button for one frame and right button for the other?

im confused. I got it to work for the most part just not sure how to separate the clicks now...

I tried to do the right button in secure code and the left buton with a setscript lol i take it you can not do setattrib onclick and setscript onclicks on the same frame?

th is is what i have so far

lua Code:

BackpackButton:SetAttribute("_onclick", [=[
 local show, i, ref = button == "RightButton", 2, self:GetFrameRef("frame1");
 while ref do
  if show and ref:IsVisible() then ref:Hide(); else ref:Show(); end
  i, ref = i + 1, self:GetFrameRef("frame" .. i);
 end
]=]); 
BackpackButton:RegisterForClicks('LeftButtonUp', 'RightButtonUp');
BackpackButton:SetFrameRef("frame1", GrimBackpackBar);
 
--BackpackButton:SetScript("OnClick", function(self, button)
--  if button == 'LeftButton' then
--      Baggins:ToggleBackpack()
--  end
--end)

Slakah · 04-04-10, 08:20 PM

I'm guessing it's because when you call :SetScript("OnClick", <blah>) your overwriting the secure _onclick which uses the :SetScript("OnClick") thing.

lua Code:

BackpackButton:SetFrameRef("GrimBackpackBar", GrimBackpackBar)
BackpackButton:Execute([[GrimBackpackBar = self:GetFrameRef("GrimBackpackBar")]])
BackpackButton:SetAttribute("_onclick", [=[
    if button == "RightButton" then
        if GrimBackpackBar:IsShown() then
            GrimBackpackBar:Hide()
        else
            GrimBackpackBar:Show()
        end
    end
]=])
BackpackButton:RegisterForClicks('LeftButtonUp', 'RightButtonUp')
 
 
BackpackButton:HookScript("OnClick", function(self, button) --Hook script because we don't want to overwrite _onclick
    if button == "LeftButton" then
        Baggins:ToggleBackpack()
    end
end)

I could be wrong as it's been a while since I read the code in FrameXML.

Grimsin · 04-04-10, 09:04 PM

i have gotten this to work save for one flaw. On left click the bagbar toggles as well as the baggins frame. No idea why. Right click toggles it to.

lua Code:

BackpackButton:SetAttribute("_onclick", [=[
    local ref = self:GetFrameRef("frame1");
    if button == "RightButton" and ref:IsVisible() then ref:Hide(); else ref:Show(); end
]=]); 
BackpackButton:RegisterForClicks('LeftButtonUp', 'RightButtonUp');
BackpackButton:SetFrameRef("frame1", GrimBackpackBar);
 
 
BackpackButton:HookScript("OnClick", function(self, button) --Hook script because we don't want to overwrite _onclick
    if button == "LeftButton" then
        Baggins:ToggleBackpack()
    end
end)

Grimsin · 04-04-10, 09:19 PM

figured it out

thanks everyone!