WoW:XML properties - Revision history

Bear: /* Scripts */

2023-10-07T00:46:59Z

Scripts

← Older revision		Revision as of 00:46, 7 October 2023
Line 152:		Line 152:
	* OnSizeChanged		* OnSizeChanged
	* OnEvent		* OnEvent
	* OnUpdate		* OnUpdate(self, elapsed)
	* OnShow		* OnShow
	* OnHide		* OnHide

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

2023-08-15T04:49:29Z

Move page script moved page XML properties to XML properties without leaving a redirect

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

Bear: /* Scripts */

2023-01-16T06:16:13Z

Scripts

← Older revision		Revision as of 06:16, 16 January 2023
Line 146:		Line 146:

	=== [[XML/Scripts\|Scripts]] ===		=== [[XML/Scripts\|Scripts]] ===
	This element accepts specific script handler elements of a [[XML/Script\|Script]] type. See [[:Category:Widget event handlers\|~~Widget~~ event handlers]] for more detail on individual handler semantics, and [[Widget handlers]] for which element types use handlers.		This element accepts specific script handler elements of a [[XML/Script\|Script]] type. See the [[:Category:Widget event handlers\|widget event handlers category]] for more detail on individual handler semantics, and [[Widget handlers]] for which element types use handlers.
	Script types:		Script types:
	* OnLoad		* OnLoad

Bear: /* Scripts */

2023-01-16T06:15:34Z

Scripts

← Older revision		Revision as of 06:15, 16 January 2023
Line 146:		Line 146:

	=== [[XML/Scripts\|Scripts]] ===		=== [[XML/Scripts\|Scripts]] ===
	This element accepts specific script handler elements of a [[XML/Script\|Script]] type. See [[Category:Widget event handlers\|Widget event handlers]] for more detail on individual handler semantics, and [[Widget handlers]] for which element types use handlers.		This element accepts specific script handler elements of a [[XML/Script\|Script]] type. See [[:Category:Widget event handlers\|Widget event handlers]] for more detail on individual handler semantics, and [[Widget handlers]] for which element types use handlers.
	Script types:		Script types:
	* OnLoad		* OnLoad

Bear: /* Scripts */

2023-01-16T06:15:04Z

Scripts

← Older revision		Revision as of 06:15, 16 January 2023
Line 146:		Line 146:

	=== [[XML/Scripts\|Scripts]] ===		=== [[XML/Scripts\|Scripts]] ===
	This element accepts specific script handler elements of a [[XML/Script\|Script]] type. See [[:Category:Widget event handlers]] for more detail on individual handler semantics, and [[Widget handlers]] for which element types use handlers.		This element accepts specific script handler elements of a [[XML/Script\|Script]] type. See [[Category:Widget event handlers\|Widget event handlers]] for more detail on individual handler semantics, and [[Widget handlers]] for which element types use handlers.
	Script types:		Script types:
	* OnLoad		* OnLoad

Bear at 06:13, 16 January 2023

2023-01-16T06:13:37Z

← Older revision		Revision as of 06:13, 16 January 2023
Line 141:		Line 141:
	* minResize ([[XML/Dimension\|Dimension]]) - lower bounds of a frames size		* minResize ([[XML/Dimension\|Dimension]]) - lower bounds of a frames size
	* maxResize ([[XML/Dimension\|Dimension]]) - upper bounds of a frames size		* maxResize ([[XML/Dimension\|Dimension]]) - upper bounds of a frames size

			=== [[XML/Script\|Script]] ===
			Lua script handler defined inside a [[XML/Scripts\|Scripts]] element.

	=== [[XML/Scripts\|Scripts]] ===		=== [[XML/Scripts\|Scripts]] ===

Bear at 01:20, 16 May 2020

2020-05-16T01:20:07Z

@@ Line 1: / Line 1: @@
 {{uixmlprop}}
-[[XML properties]] are complex [[XML]] elements used to help define major Ui [[XML elements]], for creating WoW UI frames and widgets. See also [[XML elements]], [[XML attributes]], and [[XML types]].
+[[FrameXML]] [[XML properties]], as used here are common complex [[XML]] elements, used to help define major Ui [[XML elements]] for creating WoW UI frames and widgets. See also [[XML elements]], [[XML attributes]], and [[XML types]].
 == Summary ==
-In XML, 'attributes' are the "inline" properties of an 'element', like <element attribute="value"/>. Each 'element' may also contain its own child elements, like <element><element attribute="value"/><element attribute="value"/></element>. An element is defined by both its attributes, and by any 'child elements' it may have. The intent for this reference is to document all of the actual complex properties, like <Size> or <Anchor>, for major elements that are not regular attributes. These along with attributes, make up the definition of a major XML Ui elements like widgets.
+A particular element is defined by both its attributes, and by any 'child elements' it may have. These along with attributes, all together make up the definition major XML Ui elements, like widgets.
-Properties are usually defined in a standard order in a major element, like <Size> before <Anchors>. Major Ui elements are almost never placed directly inside another major Ui element, but inside list properties like <Frames>. Each major element only uses a subset of the properties below, like <nowiki><Font></nowiki> does not use <Scripts>.
+In XML, 'attributes' are the in-line properties of an 'element', like:
 == Reference ==

Bear: moved XML properties to XML/Attributes

2012-08-06T01:04:46Z

moved XML properties to XML/Attributes

New page

{{uixmlprop}}
[[XML properties]] are complex [[XML]] elements used to help define major Ui [[XML elements]], for creating WoW UI frames and widgets. See also [[XML elements]], [[XML attributes]], and [[XML types]].

== Summary ==
In XML, 'attributes' are the "inline" properties of an 'element', like <element attribute="value"/>. Each 'element' may also contain its own child elements, like <element><element attribute="value"/><element attribute="value"/></element>. An element is defined by both its attributes, and by any 'child elements' it may have. The intent for this reference is to document all of the actual complex properties, like <Size> or <Anchor>, for major elements that are not regular attributes. These along with attributes, make up the definition of a major XML Ui elements like widgets.

Properties are usually defined in a standard order in a major element, like <Size> before <Anchors>. Major Ui elements are almost never placed directly inside another major Ui element, but inside list properties like <Frames>. Each major element only uses a subset of the properties below, like <nowiki><Font></nowiki> does not use <Scripts>.

== Reference ==
Below lists in alphabetical order the common complex property definitions, as used by the major Ui [[XML elements]].

''Key for attributes types (see [[XML types]]):''
* string - String, just some text
* int - Integer, number (0,1,2,3,4,5...)
* float - Single, number with point (0.3 or 1.65 etc)
* bool - Boolean, one of '0', '1', 'true', 'false' to indicate enable or disable, or on or off, etc...
* enum - List, an enumeration, or one of a set of predefined values
* [Element] - Element Type, name of element

=== [[XML/Anchors|Anchors]] ===
A list of [[XML/Anchor|Anchor]]s that defines position of element relative to its parent position.

=== [[XML/Animations|Animations]] ===
A list of [[XML/AnimationGroup|AnimationGroup]]s that define arbitrary animations for a target element.

=== [[XML/Attribute|Attribute]] ===
Elements of the [[XML/Attributes|Attributes]] property that add internal flags to UI objects, often used to denote secure frames.
* name (string) - Lua name for the member
* type ([[XML/ATTRIBUTETYPE|ATTRIBUTETYPE]]) - the Lua type for the member. Default is 'string'.
* value - value to set for the member

=== [[XML/Attributes|Attributes]] ===
A list of [[XML/Attribute|Attribute]]s that define internal options for elements, often used for secure frames.

=== [[XML/Backdrop|Backdrop]] ===
Provides a background for a frame.

=== BarColor ===

=== BarTexture ===

=== ButtonText ===

=== CheckedTexture ===

=== [[XML/Color|Color]] ===
Generally represents a font text, foreground, or fill color

=== ColorValueTexture ===

=== ColorValueThumbTexture ===

=== ColorWheelTexture ===

=== ColorWheelThumbTexture ===

=== DisabledCheckedTexture ===
Define the texture to use when a check button is checked.

=== DisabledFont ===
Define the font to use when a button is disabled.

=== DisabledTexture ===
Define the texture to use when a button is disabled.

=== FontHeight ===
([[XML/Value|Value]]) -

=== FontString ===
([[XML/FontString|FontString]]) -

=== [[XML/Frames|Frames]] ===
Contains the set of child frames of a [[XML/Frame|Frame]] type. If you want button inside a frame you need put it inside this tag of frame.

=== Gradient ===
([[XML/Gradient|Gradient]]) - defines gradation of color blended with Color or texture File. currenly is only a property of Texture.

=== HighlightFont ===
Mouseover font.

=== HighlightTexture ===
Mouseover texture.

=== HitRectInsets ===
([[XML/Inset|Inset]]) - Alters the user input hit box for a frame.

=== [[XML/KeyValue|KeyValue]] ===
Contained by the [[XML/KeyValues|KeyValues]] property, and set Lua values at run time.
* key - Lua key, usually a name, for the member
* value - value to set for the member
* keyType ([[XML/KEYVALUETYPE|KEYVALUETYPE]]) - the Lua type for the member key. Default is 'string'.
* type ([[XML/KEYVALUETYPE|KEYVALUETYPE]]) - the Lua type for the member value. Default is 'string'.

=== [[XML/KeyValues|KeyValues]] ===
* [[XML/KeyValue|KeyValue]] ...

=== [[XML/Layer|Layer]] ===
Placed inside the [[XML/Layers|Layers]] property, and contains a list of <FontString> and <Texture> elements, which define what will actually be drawn on screen. Only <FontString> and <Texture> elements are allowed inside Layer element.

=== [[XML/Layers|Layers]] ===
Contains a [[XML/Layer|Layer]] list. Layers and Layer define what will actually be drawn on screen. Only '[[XML/Layer|Layer]]' elements can be inside this tag, each have 'level' property to define the order they will be drawn. Only <FontString> and <Texture> elements are allowed inside Layer element.

=== NormalFont ===

=== NormalTexture ===

=== PushedTextOffset ===
Text moves when clicked (and held), this defines how far it moves. Text moves back to its previous location when the mouse button is released.

=== PushedTexture ===
Change the texture to this when clicked (and held). The texture changes back to its texture when the mouse button is released.

=== [[XML/ResizeBounds|ResizeBounds]] ===
Defines how big or small this frame can possibly be.
* minResize ([[XML/Dimension|Dimension]]) - lower bounds of a frames size
* maxResize ([[XML/Dimension|Dimension]]) - upper bounds of a frames size

=== [[XML/Scripts|Scripts]] ===
This element accepts specific script handler elements of a [[XML/Script|Script]] type. See [[:Category:Widget event handlers]] for more detail on individual handler semantics, and [[Widget handlers]] for which element types use handlers.
Script types:
* OnLoad
* OnAttributeChanged
* OnSizeChanged
* OnEvent
* OnUpdate
* OnShow
* OnHide
* OnEnter
* OnLeave
* OnMouseDown
* OnMouseUp
* OnMouseWheel
* OnJoystickStickMotion
* OnJoystickAxisMotion
* OnJoystickButtonDown
* OnJoystickButtonUp
* OnJoystickHatMotion
* OnDragStart
* OnDragStop
* OnReceiveDrag
* PreClick
* OnClick
* PostClick
* OnDoubleClick
* OnValueChanged
* OnMinMaxChanged
* OnUpdateModel
* OnAnimFinished
* OnEnterPressed
* OnEscapePressed
* OnSpacePressed
* OnTabPressed
* OnTextChanged
* OnTextSet
* OnCursorChanged
* OnInputLanguageChanged
* OnEditFocusGained
* OnEditFocusLost
* OnHorizontalScroll
* OnVerticalScroll
* OnScrollRangeChanged
* OnCharComposition
* OnChar
* OnKeyDown
* OnKeyUp
* OnColorSelect
* OnHyperlinkEnter
* OnHyperlinkLeave
* OnHyperlinkClick
* OnMessageScrollChanged
* OnMovieFinished
* OnMovieShowSubtitle
* OnMovieHideSubtitle
* OnTooltipSetDefaultAnchor
* OnTooltipCleared
* OnTooltipAddMoney
* OnTooltipSetUnit
* OnTooltipSetItem
* OnTooltipSetSpell
* OnTooltipSetQuest
* OnTooltipSetAchievement
* OnEnable
* OnDisable
* OnArrowPressed
* OnExternalLink
* OnButtonUpdate
* OnError

=== ScrollChild ===

=== Shadow ===
([[XML/Shadow|Shadow]]) - Puts a shadow behind an element.

=== Size ===
([[XML/Dimension|Dimension]]) - Defines a size of an element. Normally this is done by putting "AbsDimension" tag inside with "x" and "y" attributes, but sometimes this is done by just giving "x" and "y" attributes to "Size" tag itself. Last one is probably old way of defining and left for a backward compatibility.

=== ThumbTexture ===

=== [[XML/TexCoords|TexCoords]] ===
Determines how much of the specified texture is to be shown.

=== TitleRegion ===
([[XML/LayoutFrame|LayoutFrame]]) - Adds a region used for automatically dragging a frame.

== See also ==
* [[XML elements]]
* [[XML attributes]]
* [[XML types]]