WoW:API Region IsShown: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
|||
| Line 1: | Line 1: | ||
{{widgetmethod}} | {{widgetmethod}} | ||
Determine if the object | Determine if the object would be visible if its parent was visible. | ||
shown = MyObject:IsShown(); | shown = MyObject:IsShown(); | ||
| Line 6: | Line 6: | ||
== Returns == | == Returns == | ||
:;shown: [[ | :;shown: [[boolean]] - true if the object will be visible when its parent is visible. | ||
== Example == | == Example == | ||
| Line 17: | Line 17: | ||
== Details == | == Details == | ||
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. | |||
Objects created via [[API CreateFrame|CreateFrame]](), [[API Frame CreateFontString|Frame:CreateFontString]]() or [[API Frame CreateTexture|Frame:CreateTexture]]() are initially created shown. | |||
== Notes == | == Notes == | ||
* Prior to patch 1.9, FontStrings did not have an :IsShown(). They did have an :IsVisible() method with the behaviour of :IsShown(). | |||
* | == See also == | ||
* {{api|Region:IsVisible|t=w}} | |||
Revision as of 18:24, 17 January 2015
← Widget API ← Region < IsShown
Determine if the object would be visible if its parent was visible.
shown = MyObject:IsShown();
Returns
- shown
- boolean - true if the object will be visible when its parent is visible.
Example
if MyFrame:IsShown() and not MyFrame:IsVisible() then
-- Frame is "shown", but not visible (one or more of its parents isn't shown)
elseif MyFrame:IsVisible() then
-- Frame is visible on-screen!
end
Details
Calling :Show() on an object will make subsequent calls to IsShown() return true. Likewise, calling :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.
Objects created via CreateFrame(), Frame:CreateFontString() or Frame:CreateTexture() are initially created shown.
Notes
- Prior to patch 1.9, FontStrings did not have an :IsShown(). They did have an :IsVisible() method with the behaviour of :IsShown().