WoW:XML/Frame - Revision history

Move page script: Move page script moved page XML/Frame to WoW:XML/Frame without leaving a redirect

2023-08-15T04:49:24Z

Move page script moved page XML/Frame to XML/Frame without leaving a redirect

← Older revision

Revision as of 04:49, 15 August 2023

Bear: /* Parents */

2022-09-07T21:48:34Z

Parents

← Older revision		Revision as of 21:48, 7 September 2022
Line 122:		Line 122:

	; Notes		; Notes
	~~A complex~~ visual ~~element is~~ formed ~~of multiple Frames, and it~~'s considered good design to have a related parent frame amongst them~~. And have the rest use that (or its children) as their parent~~. By default, all child frames already use the ~~parent~~ they are defined in as their parent. Well behaved UI AddOns will normally want their top-level parent frame, the highest-level frame that is not defined in another frame, to be set expressly to 'UIParent'. Failure to do so means, amongst other things, that the AddOn's frame won't vanish when the Hide UI key is pressed.		Complex visual elements are usually formed using many frames. It's considered good design to have a single related parent frame amongst them. By default, all child frames already use the frame they are defined in as their parent. If some of the frames are defined separately, they can still explicitly set their parent to a common frame, using the 'parent' attribute, and have the rest use that (or its children) as their parent.

			Well behaved UI AddOns will normally want their top-level parent frame, the highest-level frame that is not defined in another frame, to be set expressly to 'UIParent'. Failure to do so means, amongst other things, that the AddOn's frame won't vanish when the Hide UI key is pressed.

	=== Frame Levels ===		=== Frame Levels ===

Bear: /* Parents */

2022-09-07T21:43:43Z

Parents

← Older revision		Revision as of 21:43, 7 September 2022
Line 104:		Line 104:

	=== Parents ===		=== Parents ===
	Frames ~~can~~ have a parent frame. By default, the parent of any child frame is the frame the child is defined in.		Frames have a parent frame. By default, the parent of any child frame is the frame the child is defined in.

	<pre>		<pre>

Bear: /* Parents */

2022-09-07T21:43:18Z

Parents

← Older revision		Revision as of 21:43, 7 September 2022
Line 109:		Line 109:
	<Frame name="Fame1">		<Frame name="Fame1">
	<Frames>		<Frames>
	<Frame name="Fame2"><!-- Frame2 'parent' is automatically Frame1 -->		<Frame name="Fame2"><!-- Frame2's 'parent' is automatically Frame1 -->
	</Frame>		</Frame>
	</Frames>		</Frames>

Bear: /* Parents */

2022-09-07T21:42:58Z

Parents

← Older revision		Revision as of 21:42, 7 September 2022
Line 104:		Line 104:

	=== Parents ===		=== Parents ===
	Frames can have a parent frame. By default, the parent of any child frame is the frame it is defined in.		Frames can have a parent frame. By default, the parent of any child frame is the frame the child is defined in.

	<pre>		<pre>

Bear: /* Parents */

2022-09-07T21:42:19Z

Parents

← Older revision		Revision as of 21:42, 7 September 2022
Line 104:		Line 104:

	=== Parents ===		=== Parents ===
	Frames have a parent frame. ~~A complex visual element is likely formed of multiple Frames~~, ~~and it's considered good design to designate a common parent Frame amongst them, and have~~ the ~~rest use that (or its children) as their~~ parent~~. Well behaved UI AddOns will normally want their top level parent frames set expressly to 'UIParent'. Failure to do so means, amongst other things, that~~ the ~~AddOn's~~ frame ~~won't vanish when the Hide UI key~~ is ~~pressed~~.		Frames can have a parent frame. By default, the parent of any child frame is the frame it is defined in.

	==~~== Visibility ====~~		<pre>
	~~Each~~ Frame ~~can be shown and hidden, if a~~ Frame is Hidden, then it and all of its children cease to be visible. It's far simpler to show and hide the parent frame of a complex set, than to try and manage the visibility of many elements independently.		<Frame name="Fame1">
			<Frames>
			<Frame name="Fame2"><!-- Frame2 'parent' is automatically Frame1 -->
			</Frame>
			</Frames>
			</Frame>
			</pre>

	~~====~~ Scaling ~~====~~		; Visibility
			Each Frame can be shown and hidden. If a Frame is Hidden, then it and all of its children cease to be visible. It's far simpler to show and hide the parent frame of a complex set, than to try and manage the visibility of many elements independently.

			; Scaling
	The UI engine is built to perform automatic scaling of UI elements, the entire UI (actually, the UIParent frame, which most frames are children of), or any component of it can be enlarged or shrunk to fit on a screen appropriately. Frames are scaled and located relative to their parent rather than the whole screen, which means that you only need to worry about how your subcomponents relate to each other, and then your component can be placed and sized any way necessary.		The UI engine is built to perform automatic scaling of UI elements, the entire UI (actually, the UIParent frame, which most frames are children of), or any component of it can be enlarged or shrunk to fit on a screen appropriately. Frames are scaled and located relative to their parent rather than the whole screen, which means that you only need to worry about how your subcomponents relate to each other, and then your component can be placed and sized any way necessary.

			; Notes
			A complex visual element is formed of multiple Frames, and it's considered good design to have a related parent frame amongst them. And have the rest use that (or its children) as their parent. By default, all child frames already use the parent they are defined in as their parent. Well behaved UI AddOns will normally want their top-level parent frame, the highest-level frame that is not defined in another frame, to be set expressly to 'UIParent'. Failure to do so means, amongst other things, that the AddOn's frame won't vanish when the Hide UI key is pressed.

	=== Frame Levels ===		=== Frame Levels ===

Bear at 04:13, 17 December 2020

2020-12-17T04:13:52Z

← Older revision		Revision as of 04:13, 17 December 2020
Line 1:		Line 1:
	{{~~uixmltype~~}}		{{uixmlelem}}

	[[XML/Frame\|Frame]] is a base type used as a fundamental UI building block for defining 'active' visible screen elements. The Frame type can be used for '''Layout''' due to [[XML/LayoutFrame\|LayoutFrame]], and a full set of '''Appearance''' and '''Behaviour''' facilities. Provides a base type for [[XML/Button\|Button]], [[XML/EditBox\|EditBox]], [[XML/ScrollingMessageFrame\|ScrollingMessageFrame]], and many others.		[[XML/Frame\|Frame]] is a base type used as a fundamental UI building block for defining 'active' visible screen elements. The Frame type can be used for '''Layout''' due to [[XML/LayoutFrame\|LayoutFrame]], and a full set of '''Appearance''' and '''Behaviour''' facilities. Provides a base type for [[XML/Button\|Button]], [[XML/EditBox\|EditBox]], [[XML/ScrollingMessageFrame\|ScrollingMessageFrame]], and many others.

	== Inheritance ==		== Inheritance ==
	Inherited by: [[XML/Button\|Button]] ..., Inherits: [[XML/LayoutFrame\|LayoutFrame]], Defined in: [[XML/Frames\|Frames]], [[XML/Ui\|Ui~~]],~~		: Inherited by: [[XML/Button\|Button]] ..., Inherits: [[XML/LayoutFrame\|LayoutFrame]], Runtime object: [[UIOBJECT_Frame\|Frame]]
	~~Runtime object: [[UIOBJECT_Frame~~]]		: Defined in: [[XML/Frames\|Frames]], [[XML/Ui\|Ui]]

	== Elements ==		== Elements ==
Line 49:		Line 48:
	* jumpNavigateEnabled {{attrtype\|boolean}}		* jumpNavigateEnabled {{attrtype\|boolean}}
	* jumpNavigateStart {{attrtype\|boolean}}		* jumpNavigateStart {{attrtype\|boolean}}
			* intrinsic {{attrtype\|boolean}} - marks frame as an intrinsic frame type

	=== Inherited from [[XML/LayoutFrame\|LayoutFrame]]: ===		=== Inherited from [[XML/LayoutFrame\|LayoutFrame]]: ===
Line 89:		Line 89:

	=== Events ===		=== Events ===
	In addition to Frames being the things that you can see, Frames are also the things which UI and game events are delivered to. If you're writing code that needs to know about something, it will need a Frame (though not necessarily a visible one) to receive the event. There are many types of events, though often in AddOn development it refers to a [[API ~~Events\|Game Event~~]] rather than other UI events.		In addition to Frames being the things that you can see, Frames are also the things which UI and game events are delivered to. If you're writing code that needs to know about something, it will need a Frame (though not necessarily a visible one) to receive the event. There are many types of events, though often in AddOn development it refers to an [[API event]] game event. rather than other UI events.

	A frame indicates its interest in events in a number of ways:		A frame indicates its interest in events in a number of ways:
Line 117:		Line 117:
	Instead of going around and specifying that frame A should have frame level 12, and frame B frame level 15, Blizzard uses a set of predefined "groups" of frame levels called frameStrata. The valid values for frameStrata are "PARENT", "BACKGROUND", "LOW", "MEDIUM", "HIGH", "DIALOG", "FULLSCREEN_DIALOG" and "TOOLTIP" (there may be more). For the values "BACKGROUND" through "TOOLTIP" the values are listed in their assumed ascendancy (i.e. it is assumed that "BACKGROUND" will be below "LOW"). The default value is "PARENT" if no frameStrata is specified.		Instead of going around and specifying that frame A should have frame level 12, and frame B frame level 15, Blizzard uses a set of predefined "groups" of frame levels called frameStrata. The valid values for frameStrata are "PARENT", "BACKGROUND", "LOW", "MEDIUM", "HIGH", "DIALOG", "FULLSCREEN_DIALOG" and "TOOLTIP" (there may be more). For the values "BACKGROUND" through "TOOLTIP" the values are listed in their assumed ascendancy (i.e. it is assumed that "BACKGROUND" will be below "LOW"). The default value is "PARENT" if no frameStrata is specified.

	There is also a special attribute called toplevel - this means (hopefully) that the frame should be on top of any other frame (or, possibly, on top of any other frame in the same [[frameStrata]]).		There is also a special attribute called toplevel - this means (hopefully) that the frame should be on top of any other frame (or, possibly, on top of any other frame in the same [[XML/Frame\|frameStrata]]).

	=== frameLevel and frameStrata ===		=== frameLevel and frameStrata ===

91.155.249.66: Fixed typo "inherts"

2018-01-28T18:24:01Z

Fixed typo "inherts"

← Older revision		Revision as of 18:24, 28 January 2018
Line 65:		Line 65:
	=== Example ===		=== Example ===
	<[[XML/Frame\|Frame]] name="MyFrameTemplate" hidden="true" virtual="true"/>		<[[XML/Frame\|Frame]] name="MyFrameTemplate" hidden="true" virtual="true"/>
	<[[XML/Frame\|Frame]] name="MyFrame" ~~inherts~~="MyFrameTemplate">		<[[XML/Frame\|Frame]] name="MyFrame" inherits="MyFrameTemplate">
	<[[XML/Dimension\|Size]] x="400" y="400"/>		<[[XML/Dimension\|Size]] x="400" y="400"/>
	<[[XML/Frames\|Frames]]>		<[[XML/Frames\|Frames]]>

Bear at 00:15, 27 February 2015

2015-02-27T00:15:42Z

Show changes

WoWWiki>Ning7112000: /* Elements */

2010-08-31T01:47:11Z

Elements

← Older revision		Revision as of 01:47, 31 August 2010
Line 13:		Line 13:
	** <[[XML/Dimension\|maxResize]]>		** <[[XML/Dimension\|maxResize]]>
	* </ResizeBounds>		* </ResizeBounds>
	* <[[XML/~~BackDrop~~\|~~BackDrop~~]]>		* <[[XML/Backdrop\|Backdrop]]>
	* <[[XML/Types/Inset\|BackgroundInsets]]>		* <[[XML/Types/Inset\|BackgroundInsets]]>
	* <[[XML/Types/Inset\|HitRectInsets]]>		* <[[XML/Types/Inset\|HitRectInsets]]>

← Older revision		Revision as of 18:24, 28 January 2018
Line 65:		Line 65:
	=== Example ===		=== Example ===
	<[[XML/Frame\|Frame]] name="MyFrameTemplate" hidden="true" virtual="true"/>		<[[XML/Frame\|Frame]] name="MyFrameTemplate" hidden="true" virtual="true"/>
	<[[XML/Frame\|Frame]] name="MyFrame" ~~inherts~~="MyFrameTemplate">		<[[XML/Frame\|Frame]] name="MyFrame" inherits="MyFrameTemplate">
	<[[XML/Dimension\|Size]] x="400" y="400"/>		<[[XML/Dimension\|Size]] x="400" y="400"/>
	<[[XML/Frames\|Frames]]>		<[[XML/Frames\|Frames]]>

← Older revision		Revision as of 01:47, 31 August 2010
Line 13:		Line 13:
	** <[[XML/Dimension\|maxResize]]>		** <[[XML/Dimension\|maxResize]]>
	* </ResizeBounds>		* </ResizeBounds>
	* <[[XML/~~BackDrop~~\|~~BackDrop~~]]>		* <[[XML/Backdrop\|Backdrop]]>
	* <[[XML/Types/Inset\|BackgroundInsets]]>		* <[[XML/Types/Inset\|BackgroundInsets]]>
	* <[[XML/Types/Inset\|HitRectInsets]]>		* <[[XML/Types/Inset\|HitRectInsets]]>