XML/Frame

Main Menu
WoW API Lua API FrameXML util Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

FrameXML/UI.xsd

<Frame> (inherits from <LayoutFrame>, creates a Frame widget) handles events and user interaction, and may contain other widgets.

<Frame>
	<ResizeBounds />
	<HitRectInsets />
	<Layers />
	<Frames />
	<Scripts />
</Frame>

Attributes

alpha (xs:float?Optional. Could be nil.) - Sets the alpha.

scale (xs:float?Optional. Could be nil.) - Sets the scale.

parent (xs:string?Optional. Could be nil.) - Parents another frame to this one.

toplevel (xs:boolean?Optional. Could be nil.) - Renders in front.

flattenRenderLayers (xs:boolean?Optional. Could be nil.) - Flattens child regions.

useParentLevel (xs:boolean?Optional. Could be nil.) - Prevents incrementing the frame level above its parent.

movable (xs:boolean?Optional. Could be nil.) - Enables dragging.

resizable (xs:boolean?Optional. Could be nil.) - Enables resizing.

frameStrata (ui:FRAMESTRATA) - Sequences overlapping frames.

frameLevel (xs:int?Optional. Could be nil.) - Further sequences overlapping frames in the same frameStrata.

id (xs:int?Optional. Could be nil.) - Assigns an id.

enableMouse (xs:boolean?Optional. Could be nil.) - Enables all mouse input.

enableMouseClicks (xs:boolean?Optional. Could be nil.) - Enables mouse clicks only.

enableMouseMotion (xs:boolean?Optional. Could be nil.) - Enables mouse motion only.

enableKeyboard (xs:boolean?Optional. Could be nil.) - Enables keyboard input.

clampedToScreen (xs:boolean?Optional. Could be nil.) - Prevents dragging off screen.

protected (xs:boolean?Optional. Could be nil.) - Declares the frame protected for secure code execution.

depth (xs:float?Optional. Could be nil.) - Frame:SetDepth(depth)

dontSavePosition (xs:boolean?Optional. Could be nil.) - Prevents saving the position of a movable frame.

propagateKeyboardInput (xs:boolean?Optional. Could be nil.) - Propagates keyboard input to the parent frame.

ignoreParentAlpha (xs:boolean?Optional. Could be nil.) - Controls alpha directly or as a fraction of its parent's alpha.

ignoreParentScale (xs:boolean?Optional. Could be nil.) - Controls alpha directly or as a fraction of its parent's scale.

intrinsic (xs:boolean?Optional. Could be nil.) - Creates an intrinsic frame.

clipChildren (xs:boolean?Optional. Could be nil.) - Clips overflowing children.

propagateHyperlinksToParent (xs:boolean?Optional. Could be nil.) - Propagates hyperlink interaction to the parent frame.

hyperlinksEnabled (xs:boolean?Optional. Could be nil.) - Enables interactive hyperlinks.

Child elements

<ResizeBounds> limits resizing with <minResize> and <maxResize> child tags that inherit from <Dimension>.

<HitRectInsets> (inherits from <Inset>) shrinks (+) or expands (-) mouse focus from the frame's edges.

<Inset> defines padding or overflow from a region's edges.

left (xs:float?Optional. Could be nil.) - (+) padding or (-) overflow from the left edge, scaling dependent.

right (xs:float?Optional. Could be nil.) - (+) padding or (-) overflow from the right edge, scaling dependent.

bottom (xs:float?Optional. Could be nil.) - (+) padding or (-) overflow from the bottom edge, scaling dependent.

top (xs:float?Optional. Could be nil.) - (+) padding or (-) overflow from the top edge, scaling dependent.

<Layers> encloses <Layer> tags to sequence overlapping graphical regions parented by the same frame.

<Layer> encloses regions (<Texture>, <FontString>, etc.) in a single draw layer.

level (ui:DRAWLAYER) - Sequences graphical regions as "BACKGROUND", "BORDER", "ARTWORK", etc..

textureSubLevel (xs:int?Optional. Could be nil.) - Further sequences overlapping <Texture> widgets inside the same level.

<Frames> encloses other <Frame> tags with a parent/child relationship.

<Scripts> contains widget script handlers such as <OnLoad> or <OnUpdate>.

Each widget script may enclose Lua code between the tags.

function (xs:string?Optional. Could be nil.) - Name of a function instead of Lua code between the XML tags.

method (xs:string?Optional. Could be nil.) - Name of a widget method instead of Lua code between the XML tags.

inherit (xs:string?Optional. Could be nil.) - Hooks (prepend, append) other scripts inherited through an XML virtual template.

intrinsicOrder (xs:string?Optional. Could be nil.) - Hooks (precall, postcall) other scripts when copied as an intrinsic frame.

autoEnableInput (xs:boolean?Optional. Could be nil.)

Patch changes

• Patch 7.1.0 (2016-10-25): Added intrinsic attribute, removed <TitleRegion>.
  
• Patch 1.1.0 (2004-11-07): Included in the original World of Warcraft release
  

See also

• Inherited by <Button>, <Cooldown>, <ColorSelect>, <EditBox>, <GameTooltip>, <MessageFrame>, <Minimap>, <Model>, <ScrollFrame>, <ScrollingMessageFrame>, <SimpleHTML>, <Slider>, and <StatusBar>
• CreateFrame(frameType [, frameName, parentFrame, inheritsFrame, id]) - Lua alternative.