WoW:API Region IsShown: Difference between revisions

← Older edit

WoW:API Region IsShown (source)

Revision as of 04:47, 15 August 2023

88 bytes added , 15 August 2023

m

Move page script moved page API Region IsShown to WoW:API Region IsShown without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
- <center>'''IsShown'''</center>
+{{widgetmethod}}
+Determine if the object would be visible if its parent was visible.
-Determine if the object is shown (would be visible if its parent was visible).
+ shown = MyObject:IsShown();
- LayoutFrame:IsShown();
+== Returns ==
-----
+:;shown: [[boolean]] - true if the object will be visible when its parent is visible.
-;''Arguments''
-:;nil
+== Example ==
-----
-;''Returns''
-: Boolean
-----
-;''Example''
   if MyFrame:IsShown() and not MyFrame:IsVisible() then
-      -- Frame is shown, but not visible (one or more of its parents isn't shown)
+      -- Frame is "shown", but not visible (one or more of its parents isn't shown)
   elseif MyFrame:IsVisible() then
-      -- Frame is both shown and all it's parents are shown aswell
+      -- Frame is visible on-screen!
   end
-----
+== Details ==
-;''Description''
+Calling [[API Region Show|:Show]]() on an object will make subsequent calls to IsShown() return ''true''. Likewise, calling [[API Region Hide|:Hide]]() will make subsequent calls to IsShown() return ''nil''.
+When an object is initialized, the return value of IsShown() is determined by the XML-attribute "hidden" for the object.
-: Gets the shown state of an object.
+Objects created via [[API CreateFrame|CreateFrame]](), [[API Frame CreateFontString|Frame:CreateFontString]]() or [[API Frame CreateTexture|Frame:CreateTexture]]() are initially created shown.
-:Calling Show() will make subsequent calls to IsShown() return true, likewise, calling Hide() will make subsequent calls to IsShown() return false.
+== Notes ==
-:When the frame is initialized, the return value of IsShown() is determined by the XML-attribute "hidden" for the object.
+* Prior to patch 1.9, FontStrings did not have an :IsShown(). They did have an :IsVisible() method with the behaviour of :IsShown().
-:Note: in patch 1.9 this method was added to FontStrings aswell, which previously only had an IsVisible() method with the behaviour of IsShown(). The patch changed the behavior of FontString:IsVisible() to be the same as [[API LayoutFrame IsVisible|LayoutFrame:IsVisible()]].
+== See also ==
-----
+* {{api|Region:IsVisible|t=w}}
-{{Template:WoW API}}