Revision as of 05:42, 12 June 2006

Widget API Methods

This is a list of all of the Widget functions found by scanning the in-game environment. This derivation has been performed independently by at least two people (Lego and Flickering) so there's a high degree of confidence the list is correct.

This list is current as of patch 0.10.2-5302 (11000). -- Tarog 16:44, 2 May 2006 (PDT)

The in-progress new (0.11) version of this page can be found here, under Widget API New.

Root Widgets

UIObject

This is an abstract UI object type which cannot actually be created. It's common to all UI objects and gathers together some of common methods which have identical behaviours across all widget types. (See UIObject object information for details)

UIObject:GetObjectType() - Get the type of this object - New in 1.10

UIObject:IsObjectType("type") - Determine if this object is of the specified type, or a subclass of that type - New in 1.10.

UIObject Derivatives

Font

This object was introduced in 1.10 to replace virtual FontStrings, it allows for dynamic inheritance of font template changes. 'Font' refers to game objects such as "GameFontNormal", "GameFontHighlightSmall", etc. (See Font object information for details) Font:GetFrameType() returns 'Font'. Font has all of the methods from UIObject, plus the following:

Font:CopyFontObject(otherFont) - Set this Font's attributes to be a copy of the otherFont font object's.

Font:GetAlpha() - Return this font's alpha setting.

Font:GetFont() - Return the font file, height, and flags for this Font.

Font:GetFontObject() - Return the 'parent' Font object, or nil if none.

Font:GetJustifyH() - Return Font's horizontal justification.

Font:GetJustifyV() - Return Font's vertical justification.

Font:GetName() - Return the name of the Font object.

Font:GetShadowColor() - Returns the color of this Font's shadow (r,g,b,a).

Font:GetShadowOffset() - Returns the Font's shadow offset (x,y).

Font:GetSpacing() - Returns the Font's spacing().

Font:GetTextColor() - Returns the Font's color (r,g,b,a)

Font:SetAlpha(alpha) - Set the Font's alpha value.

Font:SetFont("path", height[, "flags"]) - Sets the font to use, returns 1 if the path was valid, nil otherwise (no change occurs).

Font:SetFontObject(fontObject) - Sets the 'parent' Font object.

Font:SetJustifyH("justifyH") - Sets horizontal justification ("LEFT","RIGHT", or "CENTER")

Font:SetJustifyV("justifyV") - Sets vertical justification ("TOP","BOTTOM", or "MIDDLE")

Font:SetShadowColor(r,g,b[,a]) - Sets the shadow color.

Font:SetShadowOffset(x,y) - Sets the shadow offset.

Font:SetSpacing(spacing) - Sets the font spacing.

Font:SetTextColor(r,g,b[,a]) - Sets the font's color.

LayoutFrame

This is an abstract frame type which cannot actually be created. It gathers together a number of common methods which have identical behaviours across all widget types. (See LayoutFrame object information for details) LayoutFrame has all of the methods from UIObject, plus the following:

LayoutFrame:ClearAllPoints() - Clear all attachment points for this object.

LayoutFrame:GetAlpha() - Get the alpha level of this frame - Moved in 1.10.

LayoutFrame:GetBottom() - Get the y location of the bottom edge of this frame - Moved in 1.10.

LayoutFrame:GetCenter() - Get the coordinates of the center of this frame - Moved in 1.10.

LayoutFrame:GetHeight() - Get the height of this object.

LayoutFrame:GetLeft() - Get the x location of the left edge of this frame - Moved in 1.10.

LayoutFrame:GetName() - Get the name of this object.

LayoutFrame:GetNumPoints() - Get the number of anchor points for this frame - New in 1.10.

LayoutFrame:GetParent() - Get the parent of this frame (The object, not just the name) - Moved in 1.10.

LayoutFrame:GetPoint(point) - Get details for an anchor points for this frame (point,relativeTo,relativePoint,xofs,yofs) - New in 1.10.

LayoutFrame:GetRight() - Get the x location of the right edge of this frame - Moved in 1.10.

LayoutFrame:GetTop() - Get the y location of the top edge of this frame - Moved in 1.10.

LayoutFrame:GetWidth() - Get the width of this object.

LayoutFrame:Hide() - Set this object to hidden (it and all of its children will disappear).

LayoutFrame:IsShown() - Determine if this object is shown (would be visible if its parent was visible).

LayoutFrame:IsVisible() - Get whether the object is visible on screen (logically (IsShown() and GetParent():IsVisible()));

LayoutFrame:SetAllPoints(frame or "frameName") - Set all anchors to match edges of specified frame - Moved in 1.10.

LayoutFrame:SetAlpha(alpha) - Set the alpha level of this object (affects children also).

LayoutFrame:SetHeight(height) - Set the height of the object.

LayoutFrame:SetParent(parent or "parentName") - Set the parent for this frame - Moved in 1.10.

LayoutFrame:SetPoint("point", "relativeFrame" or relativeObject, "relativePoint"[, xOfs, yOfs]) - Set an attachment point of this object - Updated in 1.10.

LayoutFrame:SetWidth(width) - Set the width of the object.

LayoutFrame:Show() - Set this object to shown (it will appear if its parent is visible).

LayoutFrame Derivatives

Frame

(See Frame object information for details) Frame:GetFrameType() returns 'Frame'. Frame has all of the methods from LayoutFrame and UIObject, plus the following:

Frame:CreateFontString(["name"[, "layer"]]) - Create and return a new FontString as a child of this Frame.

Frame:CreateTexture(["name"[, "layer"]]) - Create and return a new Texture as a child of this Frame.

Frame:DisableDrawLayer("layer") - Disable rendering of regions in the specified draw layer.

Frame:EnableDrawLayer("layer") - Enable rendering of regions in the specified draw layer.

Frame:EnableKeyboard(enableFlag) - Set whether this frame will get keyboard input.

Frame:EnableMouse(enableFlag) - Set whether this frame will get mouse input.

Frame:EnableMouseWheel(enableFlag) - Set whether this frame will get mouse wheel events.

Frame:GetChildren() - Get the children of this frame.

Frame:GetEffectiveScale() - Get the scale factor of this object relative to the root window.

Frame:GetFrameLevel() - Get the level of this frame.

Frame:GetFrameStrata() - Get the strata of this frame.

Frame:GetFrameType() - Get the type of this frame.

Frame:GetID() - Get the ID of this frame.

Frame:GetNumChildren() - Get the number of children this frame has.

Frame:GetNumRegions() - Return the number of Regions that are children of this frame.

Frame:GetRegions() - Return the regions of the frame (multiple return values).

Frame:GetScale() - Get the scale factor of this object relative to its parent.

Frame:GetScript("handler") - Get the function for one of this frame's handlers.

Frame:HasScript("handler") - Return true if the frame can be given a handler of the specified type (NOT whether it actually HAS one, use GetScript for that) - Since 1.8.

Frame:IsFrameType("type") - Determine if this frame is of the specified type, or a subclass of that type.

Frame:IsMovable() - Determine if the frame can be moved.

Frame:IsResizable() - Determine if the frame can be resized.

Frame:IsToplevel() - Determine if the frame is Toplevel.

Frame:IsUserPlaced() - Determine if this frame has been relocated by the user.

Frame:Lower() - Lower this frame behind other frames.

Frame:Raise() - Raise this frame above other frames.

Frame:RegisterEvent("event") - Indicate that this frame should be notified when event occurs.

Frame:RegisterForDrag("buttonType"[, "buttonType"...]]) - Inidicate that this frame should be notified of drag events for the specified buttons.

Frame:SetBackdrop([backdropTable]) - Set the backdrop of the frame according to the specification provided.

Frame:SetBackdropBorderColor(r,g,b[,a]) - Set the frame's backdrop's border's color.

Frame:SetBackdropColor(r,g,b[,a]) - Set the frame's backdrop color.

Frame:SetFrameLevel(level) - Set the level of this frame (determines which of overlapping frames shows on top).

Frame:SetFrameStrata("strata") - Set the strata of this frame.

Frame:SetID(id) - Set the ID of this frame.

Frame:SetMaxResize(maxWidth, maxHeight) - Set the maximum dimensions this frame can be resized to.

Frame:SetMinResize(minWidth, minHeight) - Set the minimum dimensions this frame can be resized to.

Frame:SetMovable(isMovable) - Set whether the frame can be moved.

Frame:SetResizable(isResizable) - Set whether the frame can be resized.

Frame:SetScale(scale) - Set the scale factor of this frame relative to its parent.

Frame:SetScript("handler", function) - Set the function to use for a handler on this frame.

Frame:SetToplevel(isToplevel) - Set whether the frame is Toplevel.

Frame:SetUserPlaced(isUserPlaced) - Set whether the frame has been relocated by the user (and will thus be saved in the layout cache).

Frame:StartMoving() - Start moving this frame.

Frame:StartSizing("point") - Start sizing this frame using the specified anchor point.

Frame:StopMovingOrSizing() - Stop moving and/or sizing this frame.

Frame:UnregisterAllEvents() - Indicate that this frame should no longer be notified when any events occur.

Frame:UnregisterEvent("event") - Indicate that this frame should no longer be notified when event occurs.

Region

Another abstract type, for objects that represent only a rendering process onto the screen, rather than a full blown frame. (See Region object information for details) Region has all of the methods from LayoutFrame and UIObject, plus the following:

Region:GetDrawLayer() - Returns the draw layer for the Region - New in 1.10.

Region:SetDrawLayer("layer") - Sets the draw layer for the Region - New in 1.10.

Frame Derivatives

Button

(See Button object information for details) Button:GetFrameType() returns 'Button'. Button has all of the methods from Frame, LayoutFrame and UIObject, plus the following:

Button:Click() - Execute the click action of the button.

Button:Disable() - Disable the Button so that it cannot be clicked.

Button:Enable() - Enable to the Button so that it may be clicked.

Button:GetButtonState() - Return the current state ("PUSHED","NORMAL") of the Button.

Button:GetDisabledFontObject() - Return the font object for the Button when disabled - New in 1.10.

Button:GetFont() - Returns the font, size, and flags currently used for display on the Button.

Button:GetHighlightFontObject() - Return the font object for the Button when highlighted - New in 1.10.

Button:GetText() - Get the text label for the Button.

Button:GetTextFontObject() - Return the font object for the Button's normal text - New in 1.10.

Button:GetTextHeight() - Get the height of the Button's text.

Button:GetTextWidth() - Get the width of the Button's text.

Button:IsEnabled() - Determine whether the Button is enabled.

Button:LockHighlight() - Set the Button to always be drawn highlighted.

Button:RegisterForClicks("clickType"[, "clickType"...]) - Control which mouse button up/down events get passed to the <OnClick> event handler.

Button:SetButtonState("state"[, lock]) - Set the state of the Button ("PUSHED", "NORMAL") and whether it is locked.

Button:SetDisabledFontObject([font]) - Set the font object for settings when disabled - New in 1.10.

Button:SetDisabledTextColor(r,g,b[,a]) - Set the disabled text color for the Button.

Button:SetDisabledTexture(texture or "texturePath") - Set the disabled texture for the Button - Updated in 1.10.

Button:SetFont("font", size[, "flags"]) - Set the font to use for display.

Button:SetHighlightFontObject([font]) - Set the font object for settings when highlighted - New in 1.10.

Button:SetHighlightTextColor(r,g,b[,a]) - Set the highlight text color for the Button.

Button:SetHighlightTexture(texture or "texturePath") - Set the highlight texture for the Button - Updated in 1.10.

Button:SetNormalTexture(texture or "texturePath") - Set the normal texture for the Button - Updated in 1.10.

Button:SetPushedTexture(texture or "texturePath") - Set the pushed texture for the Button - Updated in 1.10.

Button:SetText("text") - Set the text label for the Button.

Button:SetTextColor(r,g,b) - Set the text color for the Button.

Button:SetTextFontObject([font]) - Set the font object from which to get settings for this Button's normal state - New in 1.10.

Button:UnlockHighlight() - Set the Button to not always be drawn highlighted.

ColorSelect

(See ColorSelect object information for details) ColorSelect:GetFrameType() returns 'ColorSelect'. ColorSelect has all of the methods from Frame, LayoutFrame and UIObject, plus the following:

ColorSelect:GetColorHSV() - Get the HSV values of the selected color.

ColorSelect:GetColorRGB() - Get the RGB values of the selected color.

ColorSelect:SetColorHSV(h,s,v) - Set to a specific HSV color.

ColorSelect:SetColorRGB(r,g,b) - Set to a specific RGB color.

EditBox

(See EditBox object information for details) EditBox:GetFrameType() returns 'EditBox'. EditBox has all of the methods from Frame, LayoutFrame and UIObject, plus the following:

EditBox:AddHistoryLine("text") - Add text to the edit history.

EditBox:ClearFocus()

EditBox:GetAltArrowKeyMode

EditBox:GetFont() - Returns the font, size, and flags currently used for display.

EditBox:GetFontObject

EditBox:GetHistoryLines() - Get the number of history lines for this edit box

EditBox:GetInputLanguage() - Get the input language (locale based not in-game)

EditBox:GetJustifyH

EditBox:GetJustifyV

EditBox:GetNumLetters() - Gets the number of letters in the box.

EditBox:GetNumber()

EditBox:GetShadowColor

EditBox:GetShadowOffset

EditBox:GetSpacing

EditBox:GetText() - Get the current text contained in the edit box.

EditBox:GetTextColor

EditBox:HighlightText([startPos, endPos]) - Set the highlight to all or some of the edit box text.

EditBox:Insert("text") - Insert text into the edit box.

EditBox:SetAltArrowKeyMode

EditBox:SetFocus()

EditBox:SetFont("font", size[, "flags"]) - Set the font to use for display.

EditBox:SetFontObject

EditBox:SetHistoryLines() - Set the number of history lines to remember.

EditBox:SetJustifyH

EditBox:SetJustifyV

EditBox:SetMaxBytes(maxBytes) - Set the maximum byte size for entered text.

EditBox:SetMaxLetters(maxLetters) - Set the maximum number of letters for entered text.

EditBox:SetNumber(number)

EditBox:SetShadowColor

EditBox:SetShadowOffset

EditBox:SetSpacing

EditBox:SetText("text") - Set the text contained in the edit box.

EditBox:SetTextColor(r,g,b) - Set the color of the text in the edit box.

EditBox:SetTextInsets(l,r,t,b)

EditBox:ToggleInputLanguage()

GameTooltip

The tooltip automatically resizes itself when its Show() method is called. (See GameTooltip object information for details) GameTooltip:GetFrameType() returns 'GameTooltip'. GameTooltip has all of the methods from Frame, LayoutFrame and UIObject, plus the following:

GameTooltip:AddDoubleLine(textL, textR, rL,gL,bL, rR,gR,bR)

GameTooltip:AddLine

GameTooltip:AppendText("text") - Append text to the end of the first line of the tooltip.

GameTooltip:ClearLines

GameTooltip:FadeOut

GameTooltip:GetAnchorType() - Returns the current anchoring type.

GameTooltip:IsOwned(frame) - Returns true if the tooltip is currently owned by the specified frame - Since 1.8.

GameTooltip:NumLines() - Get the number of lines in the tooltip.

GameTooltip:SetAction(slot) - Shows the tooltip for the specified action button.

GameTooltip:SetAuctionCompareItem("type", index[, offset])

GameTooltip:SetAuctionItem("type", index) - Shows the tooltip for the specified auction item.

GameTooltip:SetAuctionSellItem

GameTooltip:SetBagItem

GameTooltip:SetBuybackItem

GameTooltip:SetCraftItem

GameTooltip:SetCraftSpell

GameTooltip:SetHyperlink(link) - Shows the tooltip for the specified hyperlink (usually item link).

GameTooltip:SetInboxItem(index) - Shows the tooltip for the specified mail inbox item.

GameTooltip:SetInventoryItem(unit, slot[, nameOnly])

GameTooltip:SetLootItem

GameTooltip:SetLootRollItem(id) - Shows the tooltip for the specified loot roll item.

GameTooltip:SetMerchantCompareItem("slot"[, offset])

GameTooltip:SetMerchantItem

GameTooltip:SetMinimumWidth(width) - (Formerly SetMoneyWidth)

GameTooltip:SetOwner

GameTooltip:SetPadding

GameTooltip:SetPetAction(slot) - Shows the tooltip for the specified pet action.

GameTooltip:SetPlayerBuff(buffIndex) - Direct the tooltip to show information about a player's buff.

GameTooltip:SetQuestItem

GameTooltip:SetQuestLogItem

GameTooltip:SetQuestLogRewardSpell

GameTooltip:SetQuestRewardSpell

GameTooltip:SetSendMailItem

GameTooltip:SetShapeshift(slot) - Shows the tooltip for the specified shapeshift form.

GameTooltip:SetSpell(spellId, spellbookTabNum) - Shows the tooltip for the specified spell.

GameTooltip:SetTalent(tabIndex, talentIndex) - Shows the tooltip for the specified talent.

GameTooltip:SetText("text", r,g,b[,a[, textWrap]]) - Set the text of the tooltip.

GameTooltip:SetTrackingSpell

GameTooltip:SetTradePlayerItem

GameTooltip:SetTradeSkillItem

GameTooltip:SetTradeTargetItem

GameTooltip:SetTrainerService

GameTooltip:SetUnit

GameTooltip:SetUnitBuff("unit", buffIndex[, raidFilter]) - Shows the tooltip for a unit's buff.

GameTooltip:SetUnitDebuff("unit", buffIndex[, raidFilter]) - Shows the tooltip for a unit's debuff.

MessageFrame

(See MessageFrame object information for details) MessageFrame:GetFrameType() returns 'MessageFrame'. MessageFrame has all of the methods from Frame, LayoutFrame and UIObject, plus the following:

MessageFrame:AddMessage("text", r,g,b,a, holdTime) - Add a message to the frame which will fade eventually.

MessageFrame:GetFont

MessageFrame:GetFontObject

MessageFrame:GetJustifyH

MessageFrame:GetJustifyV

MessageFrame:GetShadowColor

MessageFrame:GetShadowOffset

MessageFrame:GetSpacing

MessageFrame:GetTextColor

MessageFrame:SetFont

MessageFrame:SetFontObject

MessageFrame:SetJustifyH

MessageFrame:SetJustifyV

MessageFrame:SetShadowColor

MessageFrame:SetShadowOffset

MessageFrame:SetSpacing

MessageFrame:SetTextColor

Minimap

Tracking dots malfunction if you have multiple instances of this widget that are different sizes/zooms. (See Minimap object information for details) Minimap:GetFrameType() returns 'Minimap'. Minimap has all of the methods from Frame, LayoutFrame and UIObject, plus the following:

Minimap:GetPingPosition() - Get the last ping location.

Minimap:GetZoom() - Get the current zoom level.

Minimap:GetZoomLevels() - Get the maximum zoom level.

Minimap:PingLocation(x,y) - Perform a ping at the specified location.

Minimap:SetBlipTexture

Minimap:SetIconTexture

Minimap:SetMaskTexture

Minimap:SetZoom(level) - Set the current zoom level.

Model

Used to display real 3D-mesh geometry as part of the UI. (See Model object information for details) Model:GetFrameType() returns 'Model'. Model has all of the methods from Frame, LayoutFrame and UIObject, plus the following:

Model:AdvanceTime()

Model:ClearFog() - Removes all fogging effects currently active in rendering.

Model:ClearModel() - Removes all geometry from the Model (i.e. makes it empty)

Model:GetFacing() - Returns the direction the model is facing.

Model:GetModelScale() - Returns the current mesh scaling factor.

Model:GetPosition() - Returns the current position of the mesh as x,y,z

Model:ReplaceIconTexture("texture")

Model:SetCamera(index) - Select a predefined camera.

Model:SetFacing(facing) - Set the direction that the model is facing.

Model:SetFogColor(r,g,b[,a]) - Set the fog color and enable fogging.

Model:SetFogFar(value) - Set the far-clipping plane distance for fogging.

Model:SetFogNear(value) - Set the near-clipping plane distance for fogging.

Model:SetLight(enabled[, omni, dirX,dirY,dirZ, ambIntensity[, ambR,ambG,ambB[, dirIntensity[, dirR,dirG,dirB]]]]) - Place the light source used for rendering

Model:SetModel("file") - Set the mesh that is displayed in the frame.

Model:SetModelScale(scale) - Sets the scale factor for the mesh before rendering.

Model:SetPosition(x,y,z) - Set the position of the mesh inside the frame's coordinate system.

Model:SetSequence(sequence) - Set the animation to be played.

Model:SetSequenceTime(sequence, time)

MovieFrame

(See MovieFrame object information for details) MovieFrame:GetFrameType() returns 'Frame'. MovieFrame has all of the methods from Frame, LayoutFrame and UIObject, plus the following:

MovieFrame:EnableSubtitles

MovieFrame:StartMovie("filename")

MovieFrame:StopMovie

ScrollFrame

(See ScrollFrame object information for details) ScrollFrame:GetFrameType() returns 'ScrollFrame'. ScrollFrame has all of the methods from Frame, LayoutFrame and UIObject, plus the following:

ScrollFrame:GetHorizontalScroll()

ScrollFrame:GetHorizontalScrollRange()

ScrollFrame:GetScrollChild

ScrollFrame:GetVerticalScroll()

ScrollFrame:GetVerticalScrollRange()

ScrollFrame:SetHorizontalScroll(offset)

ScrollFrame:SetScrollChild

ScrollFrame:SetVerticalScroll(offset)

ScrollFrame:UpdateScrollChildRect()

ScrollingMessageFrame

(See ScrollingMessageFrame object information for details) ScrollingMessageFrame:GetFrameType() returns 'ScrollingMessageFrame'. ScrollingMessageFrame has all of the methods from Frame, LayoutFrame and UIObject, plus the following:

ScrollingMessageFrame:AddMessage("text"[, r,g,b[, id]]) - Add a message to the frame, with an optional color ID.

ScrollingMessageFrame:AtBottom() - Return true if frame is at the bottom.

ScrollingMessageFrame:Clear() - Clear all lines from the frame.

ScrollingMessageFrame:GetCurrentLine()

ScrollingMessageFrame:GetCurrentScroll()

ScrollingMessageFrame:GetFadeDuration

ScrollingMessageFrame:GetFading

ScrollingMessageFrame:GetFont() - Returns the font, size, and flags currently used for display. - New in 1.9.

ScrollingMessageFrame:GetFontObject

ScrollingMessageFrame:GetJustifyH

ScrollingMessageFrame:GetJustifyV

ScrollingMessageFrame:GetMaxLines() - Get the maximum number of lines the frame can display.

ScrollingMessageFrame:GetNumLinesDisplayed()

ScrollingMessageFrame:GetNumMessages()

ScrollingMessageFrame:GetShadowColor

ScrollingMessageFrame:GetShadowOffset

ScrollingMessageFrame:GetSpacing

ScrollingMessageFrame:GetTextColor

ScrollingMessageFrame:GetTimeVisible

ScrollingMessageFrame:PageDown()

ScrollingMessageFrame:PageUp()

ScrollingMessageFrame:ScrollDown()

ScrollingMessageFrame:ScrollToBottom()

ScrollingMessageFrame:ScrollToTop()

ScrollingMessageFrame:ScrollUp()

ScrollingMessageFrame:SetFadeDuration(seconds) - Set the fade duration.

ScrollingMessageFrame:SetFading

ScrollingMessageFrame:SetFont("font", size[, "flags"]) - Set the font to use for display - New in 1.9.

ScrollingMessageFrame:SetFontObject

ScrollingMessageFrame:SetJustifyH

ScrollingMessageFrame:SetJustifyV

ScrollingMessageFrame:SetMaxLines(lines) - Set the maximum number of displayed lines.

ScrollingMessageFrame:SetScrollFromBottom

ScrollingMessageFrame:SetShadowColor

ScrollingMessageFrame:SetShadowOffset

ScrollingMessageFrame:SetSpacing

ScrollingMessageFrame:SetTextColor

ScrollingMessageFrame:SetTimeVisible(seconds) - Sets how long lines remain visible.

ScrollingMessageFrame:UpdateColorByID(id, r,g,b)

SimpleHTML

(See SimpleHTML object information for details) SimpleHTML:GetFrameType() returns 'SimpleHTML'. SimpleHTML has all of the methods from Frame, LayoutFrame and UIObject, plus the following:

SimpleHTML:GetFont

SimpleHTML:GetFontObject

SimpleHTML:GetJustifyH

SimpleHTML:GetJustifyV

SimpleHTML:GetShadowColor

SimpleHTML:GetShadowOffset

SimpleHTML:GetSpacing

SimpleHTML:GetTextColor

SimpleHTML:SetFont

SimpleHTML:SetFontObject

SimpleHTML:SetHyperlinkFormat("format") - Set the string.format format to use to display hyperlinks.

SimpleHTML:SetJustifyH

SimpleHTML:SetJustifyV

SimpleHTML:SetShadowColor

SimpleHTML:SetShadowOffset

SimpleHTML:SetSpacing

SimpleHTML:SetText("text") - Set the text to be displayed.

SimpleHTML:SetTextColor(r,g,b) - Set the color of displayed text.

Slider

(See Slider object information for details) Slider:GetFrameType() returns 'Slider'. Slider has all of the methods from Frame, LayoutFrame and UIObject, plus the following:

Slider:GetMinMaxValues() - Get the current bounds of the slider.

Slider:GetOrientation

Slider:GetValue() - Get the current value of the slider.

Slider:GetValueStep() - Get the current step size of the slider.

Slider:SetMinMaxValues(min, max) - Set the bounds of the slider.

Slider:SetOrientation

Slider:SetValue(value) - Set the value of the slider.

Slider:SetValueStep(value) - Set the step size of the slider.

StatusBar

(See StatusBar object information for details) StatusBar:GetFrameType() returns 'StatusBar'. StatusBar has all of the methods from Frame, LayoutFrame and UIObject, plus the following:

StatusBar:GetMinMaxValues() - Get the current bounds of the bar.

StatusBar:GetOrientation

StatusBar:GetStatusBarColor

StatusBar:GetStatusBarTexture

StatusBar:GetValue() - Get the current value of the bar.

StatusBar:SetMinMaxValues(min, max) - Set the bounds of the bar.

StatusBar:SetOrientation

StatusBar:SetStatusBarColor(r,g,b[,a]) - Set the color of the bar.

StatusBar:SetStatusBarTexture("file"[, "layer"]) - Sets the texture of the bar.

StatusBar:SetValue(value) - Set the value of the bar.

TaxiRouteFrame

You are only allowed a single instance of this widget. (See TaxiRouteFrame object information for details) TaxiRouteFrame:GetFrameType() returns 'Frame'. TaxiRouteFrame has all of the methods from Frame, LayoutFrame and UIObject.

WorldFrame

You are only allowed a single instance of this widget. (See WorldFrame object information for details) WorldFrame:GetFrameType() returns 'Frame'. WorldFrame has all of the methods from Frame, LayoutFrame and UIObject.

Button Derivatives

CheckButton

(See CheckButton object information for details) CheckButton:GetFrameType() returns 'CheckButton'. CheckButton has all of the methods from Button, Frame, LayoutFrame and UIObject, plus the following:

CheckButton:GetChecked() - Get the status of the checkbox.

CheckButton:SetChecked([state]) - Set the status of the checkbox.

CheckButton:SetCheckedTexture("texture") - Set the texture to use for a checked box.

CheckButton:SetDisabledCheckedTexture("texture") - Set the texture to use for an unchecked box.

LootButton

(See LootButton object information for details) LootButton:GetFrameType() returns 'LootButton'. LootButton has all of the methods from Button, Frame, LayoutFrame and UIObject, plus the following:

LootButton:SetSlot(index) - Set which the item to loot if the button is clicked.

Model Derivatives

PlayerModel

(See PlayerModel object information for details) PlayerModel:GetFrameType() returns 'PlayerModel'. PlayerModel has all of the methods from Model, Frame, LayoutFrame and UIObject, plus the following:

PlayerModel:RefreshUnit()

PlayerModel:SetRotation(rotationRadians)

PlayerModel:SetUnit("unit")

PlayerModel Derivatives

DressUpModel

(See DressUpModel object information for details) DressUpModel:GetFrameType() returns 'DressUpModel'. DressUpModel has all of the methods from PlayerModel, Model, Frame, LayoutFrame and UIObject, plus the following:

DressUpModel:Dress() - Set the model to reflect the character's current inventory.

DressUpModel:TryOn("item") - Add the specified item to the model.

DressUpModel:Undress() - Set the model to reflect the character without inventory.

TabardModel

(See TabardModel object information for details) TabardModel:GetFrameType() returns 'TabardModel'. TabardModel has all of the methods from PlayerModel, Model, Frame, LayoutFrame and UIObject, plus the following:

TabardModel:CanSaveTabardNow() - Indicate if the tabard can be saved.

TabardModel:CycleVariation(variationIndex, delta)

TabardModel:GetLowerBackgroundFileName

TabardModel:GetLowerEmblemFileName

TabardModel:GetLowerEmblemTexture("textureName")

TabardModel:GetUpperBackgroundFileName

TabardModel:GetUpperEmblemFileName

TabardModel:GetUpperEmblemTexture("textureName")

TabardModel:InitializeTabardColors()

TabardModel:Save() - Save the tabard.

Region Derivatives

FontString

(See FontString object information for details) FontString:GetFrameType() returns 'FontString'. FontString has all of the methods from Region, LayoutFrame and UIObject, plus the following:

FontString:GetFont() - Returns the font, size, and flags currently used for display.

FontString:GetFontObject

FontString:GetJustifyH

FontString:GetJustifyV

FontString:GetShadowColor

FontString:GetShadowOffset

FontString:GetSpacing

FontString:GetStringWidth() - Returns the width in pixels of the current string in the current font (without line wrapping).

FontString:GetText() - Get the displayed text.

FontString:GetTextColor() - Get the color of the displayed text.

FontString:SetAlphaGradient(start, length) - Create or remove an alpha gradient over the text.

FontString:SetFont("font", size[, "flags"]) - Set the font to use for display.

FontString:SetFontObject

FontString:SetJustifyH("direction") - Set the horizontal justification of this string.

FontString:SetJustifyV("direction") - Set the vertical justification of this string.

FontString:SetNonSpaceWrap(wrapFlag) - Set whether long strings without spaces are wrapped or truncated.

FontString:SetShadowColor

FontString:SetShadowOffset

FontString:SetSpacing

FontString:SetText("text") - Set the displayed text.

FontString:SetTextColor(r,g,b[,a]) - Set the color of the text.

FontString:SetTextHeight(pixelHeight) - Set the height of the text by scaling graphics (Note: Can distort text).

FontString:SetVertexColor(r,g,b[,a])

Texture

(See Texture object information for details) Texture:GetFrameType() returns 'Texture'. Texture has all of the methods from Region, LayoutFrame and UIObject, plus the following:

Texture:GetBlendMode

Texture:GetTexture() - Gets this texture's current texture path.

Texture:GetVertexColor

Texture:SetBlendMode

Texture:SetDesaturated(flag) - Set whether this texture should be displayed with no saturation (IMPORTANT: This has a return value)

Texture:SetGradient("orientation", minR,minG,minB, maxR,maxG,maxB)

Texture:SetGradientAlpha("orientation", minR,minG,minB,minA, maxR,maxG,maxB,maxA)

Texture:SetTexCoord(minX,maxX,minY,maxY or ULx,ULy,LLx,LLy,URx,URy,LRx,LRy) - Set the corner coordinates for texture display.

Texture:SetTexture("texturePath" or r,g,b[,a]) - Sets the texture to be displayed

Texture:SetVertexColor(r,g,b[,a])

Wowpedia

Changes: Widget API