WoW:API Region IsVisible - Revision history

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

2023-08-15T04:47:08Z

Move page script moved page API Region IsVisible to API Region IsVisible without leaving a redirect

← Older revision	Revision as of 04:47, 15 August 2023
(No difference)

Bear: /* Details */

2015-01-17T18:29:02Z

Details

← Older revision		Revision as of 18:29, 17 January 2015
Line 1:		Line 1:
	{{widgetmethod}}		{{widgetmethod}}

	Return whether or not an object is actually visible on-screen (ignoring the possibility that the object could be dragged off the edge of the screen).		Return whether or not an object would actually be visible on-screen, ignoring the possibility that the object could be dragged off the edge of the screen.

	visible = MyObject:IsVisible();		visible = MyObject:IsVisible();
Line 7:		Line 7:
	== Returns ==		== Returns ==

	:;visible: [[~~Boolean~~]] - ~~1 (~~true) if the object is visible~~, nil (false) if not.~~		:;visible: [[boolean]] - true if the object is visible

	== Example ==		== Example ==

	if(MyFrame:IsVisible()) then		if MyFrame:IsVisible() then
	MyAddon_UpdateSomeText(MyFrame);		MyAddon_UpdateSomeText(MyFrame)
	end		end

	== Details ==		== Details ==
			Gets the visible state of an object, meaning if it's shown and all it's parents are shown aswell.

	: ~~Gets the visible state of an object~~, ~~meaning if it's shown and~~ all it's ~~parents~~ are shown ~~aswell~~.		If {{api\|Region:Hide\|t=w}}() is called on a frame, then all of it's children are hidden also. In this case, its children are shown if they were prior to the Hide() call, but not visible.

	~~: If [[API Region Hide\|:Hide]]() is called on a frame, then all of it's children are hidden also. In this case, its children are "shown" (if they were prior to the Hide() call), but not "visible".~~		[[FrameXML]] uses this in a couple of places to tell whether or not the entire UI has been hidden for screenshot purposes (visible is false while shown is true)
	: [[FrameXML]] uses this in a couple of places to tell whether or not the entire UI has been hidden for screenshot purposes (visible is false while shown is true)
			== See also ==
			* {{api\|Region:IsShown\|t=w}}

WoWWiki>Mikk: Reformat, expand.

2006-07-29T15:48:25Z

Reformat, expand.

← Older revision		Revision as of 15:48, 29 July 2006
Line 1:		Line 1:
	~~<center>'''IsVisible''' ''-Documentation by [[Kisk]]-''</center>~~		{{widgetmethod}}

	~~Gets~~ the ~~visible state~~ of ~~an object~~.		Return whether or not an object is actually visible on-screen (ignoring the possibility that the object could be dragged off the edge of the screen).

	~~obj~~:IsVisible();		visible = MyObject:IsVisible();

	~~----~~		== Returns ==
	~~;''Arguments''~~

	:;nil		:;visible: [[Boolean]] - 1 (true) if the object is visible, nil (false) if not.

	~~----~~		== Example ==
	~~;''Returns''~~

	~~: Boolean~~		if(MyFrame:IsVisible()) then
			MyAddon_UpdateSomeText(MyFrame);
	~~----~~
	~~;''Example''~~
	if (MyFrame:IsVisible()) then
	~~-- Frame is visible~~
	~~elseif~~ (~~not~~ MyFrame~~:IsVisible(~~)~~) then~~
	~~-- Frame is not visible~~
	end		end

	~~;''Result''~~		== Details ==
	~~: The if function fires the corresponding statements based on the boolean value returned by MyFrame:IsVisible()~~

	~~----~~
	~~;''Description''~~

	: Gets the visible state of an object, meaning if it's shown and all it's parents are shown aswell.		: Gets the visible state of an object, meaning if it's shown and all it's parents are shown aswell.

	:If ~~a frame calls~~ Hide(), then all of it's children are hidden. In this case, its children are "shown" (if they were prior to the Hide() call), but not "visible".		: If [[API Region Hide\|:Hide]]() is called on a frame, then all of it's children are hidden also. In this case, its children are "shown" (if they were prior to the Hide() call), but not "visible".
	:~~The default UI~~ uses this in a couple of places to tell whether or not the entire UI has been hidden for screenshot purposes (visible is false while shown is true)		: [[FrameXML]] uses this in a couple of places to tell whether or not the entire UI has been hidden for screenshot purposes (visible is false while shown is true)
	~~----~~
	~~{{Template:WoW API}}~~

WoWWiki>Maldivia at 04:25, 31 January 2006

2006-01-31T04:25:00Z

← Older revision		Revision as of 04:25, 31 January 2006
Line 29:		Line 29:
	;''Description''		;''Description''

	: Gets the visible state of an object.		: Gets the visible state of an object, meaning if it's shown and all it's parents are shown aswell.

	:If ~~a parent of~~ a frame calls Hide(), then all of it's children are hidden. In this case, ~~it's~~ children are "~~visible~~", but not "~~shown~~".		:If a frame calls Hide(), then all of it's children are hidden. In this case, its children are "shown" (if they were prior to the Hide() call), but not "visible".
	:The default UI uses this in a couple of places to tell whether or not the entire UI has been hidden for screenshot purposes (visible is true~~, but shown isn't~~)		:The default UI uses this in a couple of places to tell whether or not the entire UI has been hidden for screenshot purposes (visible is false while shown is true)
	----		----
	{{Template:WoW API}}		{{Template:WoW API}}

WoWWiki>Futrtrubl at 20:02, 23 September 2005

2005-09-23T20:02:01Z

← Older revision		Revision as of 20:02, 23 September 2005
Line 31:		Line 31:
	: Gets the visible state of an object.		: Gets the visible state of an object.

			:If a parent of a frame calls Hide(), then all of it's children are hidden. In this case, it's children are "visible", but not "shown".
			:The default UI uses this in a couple of places to tell whether or not the entire UI has been hidden for screenshot purposes (visible is true, but shown isn't)
	----		----
	{{Template:WoW API}}		{{Template:WoW API}}

WoWWiki>Kisk at 08:50, 19 January 2005

2005-01-19T08:50:48Z

New page

<center>'''IsVisible''' ''-Documentation by [[Kisk]]-''</center>

Gets the visible state of an object.

obj:IsVisible();

----
;''Arguments''

:;nil

----
;''Returns''

: Boolean

----
;''Example''
if (MyFrame:IsVisible()) then
-- Frame is visible
elseif (not MyFrame:IsVisible()) then
-- Frame is not visible
end

;''Result''
: The if function fires the corresponding statements based on the boolean value returned by MyFrame:IsVisible()

----
;''Description''

: Gets the visible state of an object.

----
{{Template:WoW API}}