WoW:API Region Hide: Difference between revisions

Revision as of 15:36, 29 July 2006

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

This function makes an object, and all its children, invisible.

MyObject:Hide()

none

nil

Makes an object invisible. If it is a Frame derivate, and has children, they will be hidden as well.

The OnHide event handler will be called for the object and all its children.

Future calls to :IsShown() as well as :IsVisible() will return false for the object.
Child objects will return false from :IsVisible(), but will return true from :IsShown unless :Hide() is called on them explicitly.

@@ Line 1: / Line 1: @@
-  <center>'''Hide''' ''-Documentation by [[user:The_Nerd_Wonder|The Nerd Wonder]]-''</center>
+{{widgetmethod}}  __NOTOC__
-This function makes a frame invisible.
+This function makes an object, and all its children, invisible.
-  object:Hide()
+  MyObject:Hide()
-----
+== Parameters ==
-;''Arguments''
+=== Arguments ===
+:''none''
-:''none''
+=== Returns ===
+:''nil''
-----
+== Notes ==
-;''Returns''
-:''none''
+: Makes an object invisible. If it is a [[UIOBJECT Frame|Frame]] derivate, and has children, they will be hidden as well.
-----
+: The [[UIHANDLER OnHide|OnHide]] event handler will be called for the object and all its children.
-;''Description''
-: Makes a frame invisible. Note that if this frame has children, they will be hidden as well.
-----
+* Future calls to [[API Region IsShown|:IsShown]]() as well as [[API Region IsShown|:IsVisible]]() will return ''false'' for the object.
-{{Template:WoW API}}
+* Child objects will return false from [[API Region IsVisible|:IsVisible]](), but will return ''true'' from [[API Region IsShown|:IsShown]] unless :Hide() is called on them explicitly.