XML/Button

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

<Button> constructs a Button widget that responds to clicks, displays a label, and displays textures whether it is pushed, depressed (normal) or hovered (highlight).

Inheritance

• <LayoutFrame>
  • <Frame>
    • <Button>
      • <CheckButton>
      • <ItemButton>

Elements

<Button> resides in the same places as a <Frame> and can use all of its structure, plus the following:

<UI>
  <Button>
    <NormalTexture />
    <PushedTexture />
    <DisabledTexture />
    <HighlightTexture />
    <ButtonText />
    <NormalFont />
    <HighlightFont />
    <DisabledFont />
    <NormalColor />
    <HighlightColor />
    <DisabledColor />
    <PushedTextOffset />
    <Scripts>
      <OnClick />
      <OnDoubleClick />
      <PostClick />
      <PreClick />
    </Scripts>
  </Button>
  <Frame>
    <Frames>
      <Button />
    </Frames>
  </Frame>
</UI>

Attributes

<Button> has all the attributes of <Frame> plus the following:

XML attribute	Type	Default	Lua equivalent
text	xs:string		Button:SetText(text)
registerForClicks	xs:string		Button:RegisterForClicks(registerForClicks)
motionScriptsWhileDisabled	xs:boolean	false	Button:SetMotionScriptsWhileDisabled(motionScriptsWhileDisabled)

Example

Included in Backdrop

<Button name="$parentButtonClose" inherits="OptionsButtonTemplate" text="Close">
	<Anchors>
		<Anchor point="BOTTOMRIGHT">
			<Offset>
				<AbsDimension x="-12" y="16"/>
			</Offset>
		</Anchor>
	</Anchors>
	<Scripts>
		<OnClick> autoInviteMainConfigFrame:Hide(); </OnClick>
	</Scripts>
</Button>

Patch changes

• Patch 3.3.0 (2009-12-08): Attribute motionScriptsWhileDisabled added.
  
• Patch 3.2.2 (2009-09-22): Attribute registerForClicks added.
  
• Patch 1.11.0 (2006-06-19): Element <ButtonText> added.
  
• Patch 1.1.0 (2004-11-07): Included in the original World of Warcraft release