Editing WoW:Widget API (section)

== UIObject Derivatives ==
Have all of the methods from [[#UIObject|UIObject]], plus the following:

=== [[UIOBJECT AnimationGroup|AnimationGroup]] ===
This manages playback, order, and looping of its child Animations. (added 3.1.0)

: {{id|API|AnimationGroup|Play}}() - Start playing the animations in this group.
: {{id|API|AnimationGroup|Pause}}() - Pause the animations in this group.
: {{id|API|AnimationGroup|Stop}}() - Stop all animations in this group.
: {{id|API|AnimationGroup|Finish}}() - Notify this group to stop playing once the current loop cycle is done.
: {{id|API|AnimationGroup|GetProgress}}() - Returns the progress of this animation as a unit value [0,1].
: {{id|API|AnimationGroup|IsDone}}() - Returns true if the group has finished playing.
: {{id|API|AnimationGroup|IsPlaying}}() - Returns true if the group is playing.
: {{id|API|AnimationGroup|IsPaused}}() - Returns true if the group is paused.
: {{id|API|AnimationGroup|GetDuration}}() - Gets the total duration for one loop cycle of all child Animations.
: {{id|API|AnimationGroup|SetLooping}}(loopType) - Sets the group loop type [NONE, REPEAT, BOUNCE]
: {{id|API|AnimationGroup|GetLooping}}() - Gets the group loop type.
: {{id|API|AnimationGroup|GetLoopState}}() - Gets the current group loop state [NONE, FORWARD, REVERSE]
: {{id|API|AnimationGroup|CreateAnimation}}("animationType", ["name"[,"inheritsFrom"]]) - Create and return an Animation as a child of this group.
: {{id|API|AnimationGroup|HasScript}}("handler") - Same as Frame:HasScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].
: {{id|API|AnimationGroup|GetScript}}("handler") - Same as Frame:GetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].
: {{id|API|AnimationGroup|SetScript}}("handler", function) - Same as Frame:SetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate].

=== [[UIOBJECT Animation|Animation]] ===
Is the base animation type for animations in an AnimationGroup. (added 3.1.0)

: {{id|API|Animation|Play}}() - Play the animation.
: {{id|API|Animation|Pause}}() - Pause the animation.
: {{id|API|Animation|Stop}}() - Stop the animation.
: {{id|API|Animation|IsDone}}() - Returns true if the animation has finished playing.
: {{id|API|Animation|IsPlaying}}() - Returns true if the animation is playing.
: {{id|API|Animation|IsPaused}}() - Returns true if the animation is paused.
: {{id|API|Animation|IsStopped}}() - Returns true if the animation is stopped.
: {{id|API|Animation|IsDelaying}}() - Returns true if the animation is in the middle of a start or end delay.
: {{id|API|Animation|GetElapsed}}() - Gets the amount of time in seconds that the animation has been playing for.
: {{id|API|Animation|SetStartDelay}}(delaySec) - Set the seconds that the animation delays before it starts to progress.
: {{id|API|Animation|GetStartDelay}}() - Get the seconds that the animation delays before it starts to progress.
: {{id|API|Animation|SetEndDelay}}(delaySec) - Set the number of seconds the animation delays after finishing.
: {{id|API|Animation|GetEndDelay}}() - Get the number of seconds the animation delays after finishing.
: {{id|API|Animation|SetDuration}}(durationSec) - Set the seconds it takes for the animation to progress from start to finish.
: {{id|API|Animation|GetDuration}}() - Get the seconds it takes for the animation to progress from start to finish.
: {{id|API|Animation|GetProgress}}() - Returns the progress of the animation as a unit value [0,1]. Ignores start and end delay.
: {{id|API|Animation|GetSmoothProgress}}() - Returns a smoothed, [0,1] progress value for the animation.
: {{id|API|Animation|GetProgressWithDelay}}() - Returns the progress of the animation combined with its start and end delay.
: {{id|API|Animation|SetMaxFramerate}}(framerate) - Sets the maximum fps that the animation will update its progress.
: {{id|API|Animation|GetMaxFramerate}}() - Gets the maximum fps that the animation will update its progress.
: {{id|API|Animation|SetOrder}}(order) - Sets the order that the animation plays within its parent group. Range is [1,100].
: {{id|API|Animation|GetOrder}}() - Gets the order of the animation within its parent group.
: {{id|API|Animation|SetSmoothing}}(smoothType) - Sets the smoothing type for the animation [IN,OUT,IN_OUT,OUT_IN]
: {{id|API|Animation|GetSmoothing}}() - Gets the smoothing type for the animation.
: {{id|API|Animation|SetParent}}(animGroup or "animGroupName") - Sets the parent for the animation. If the animation was not already a child of the parent, the parent will insert the animation into the proper order amongst its children.
: {{id|API|Animation|GetRegionParent}}() - Gets the Region object that the animation operates on. The region object is this Animation's parent's parent (the AnimationGroup's parent).
: {{id|API|Animation|HasScript}}("handler") - Same as Frame:HasScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate]
: {{id|API|Animation|GetScript}}("handler") - Same as Frame:GetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate]
: {{id|API|Animation|SetScript}}("handler") - Same as Frame:SetScript [OnLoad, OnPlay, OnPaused, OnStop, OnFinished, OnUpdate]

=== [[UIOBJECT FontInstance|FontInstance]] ===
This is an abstract object type that provides font related methods.

: {{id|API|FontInstance|GetFont}}() - Return the font file, height, and flags.
: {{id|API|FontInstance|GetFontObject}}() - Return the 'parent' Font object, or nil if none.
: {{id|API|FontInstance|GetJustifyH}}() - Return the horizontal text justification.
: {{id|API|FontInstance|GetJustifyV}}() - Return thevertical text justification.
: {{id|API|FontInstance|GetShadowColor}}() - Returns the color of text shadow (r, g, b, a).
: {{id|API|FontInstance|GetShadowOffset}}() - Returns the text shadow offset (x, y).
: {{id|API|FontInstance|GetSpacing}}() - Returns the text spacing.
: {{id|API|FontInstance|GetTextColor}}() - Returns the default text color.
: {{id|API|FontInstance|SetFont}}("path", height[,"flags"]) - Sets the font to use for text, returns 1 if the path was valid, nil otherwise (no change occurs).
: {{id|API|FontInstance|SetFontObject}}(fontObject) - Sets the 'parent' Font object from which this object inherits properties.
: {{id|API|FontInstance|SetJustifyH}}("justifyH") - Sets horizontal text justification ("LEFT","RIGHT", or "CENTER")
: {{id|API|FontInstance|SetJustifyV}}("justifyV") - Sets vertical text justification ("TOP","BOTTOM", or "MIDDLE")
: {{id|API|FontInstance|SetShadowColor}}(r, g, b[, a]) - Sets the text shadow color.
: {{id|API|FontInstance|SetShadowOffset}}(x, y) - Sets the text shadow offset.
: {{id|API|FontInstance|SetSpacing}}(spacing) - Sets the spacing between lines of text in the object.
: {{id|API|FontInstance|SetTextColor}}(r, g, b[, a]) - Sets the default text color.

=== [[UIOBJECT Region|Region]] ===
This is an abstract object type which cannot actually be created. Defines a potentially visible area.

: {{id|API|Region|ClearAllPoints}}() - Clear all attachment points for this object.
: {{id|API|Region|CreateAnimationGroup}}(["name"[,"inheritsFrom"]]) - Create and return a new AnimationGroup as a child of this Region. (added 3.1.0)
: {{id|API|Region|GetAnimationGroups}}() - Returns all AnimationGroups that are children of this Region. (added 3.1.0)
: {{id|API|Region|GetBottom}}() - Get the y location of the bottom edge of this frame - Moved in 1.10.
: {{id|API|Region|GetCenter}}() - Get the coordinates of the center of this frame - Moved in 1.10.
: {{id|API|Region|GetHeight}}() - Get the height of this object.
: {{id|API|Region|GetLeft}}() - Get the x location of the left edge of this frame - Moved in 1.10.
: {{id|API|Region|GetNumPoints}}() - Get the number of anchor points for this frame (added 1.10)
: {{id|API|Region|GetPoint}}(pointNum) - Get details for an anchor point for this frame (point, relativeTo, relativePoint, xofs, yofs) (added 1.10)
: {{id|API|Region|GetRect}}() - Get frame's left, bottom, width, height.
: {{id|API|Region|GetRight}}() - Get the x location of the right edge of this frame - Moved in 1.10.
: {{id|API|Region|GetSize}}() - Get the width and height of the frame
: {{id|API|Region|GetTop}}() - Get the y location of the top edge of this frame - Moved in 1.10.
: {{id|API|Region|GetWidth}}() - Get the width of this object.
: {{id|API|Region|Hide}}() - Set this object to hidden (it and all of its children will disappear).
: {{id|API|Region|IsDragging}}() - True if this Region or its Parent is being dragged. (added 3.1.0)
: {{id|API|Region|IsProtected}}() - Determine if this object can be manipulated in certain ways by tainted code in combat or not
: {{id|API|Region|IsShown}}() - Determine if this object is shown (would be visible if its parent was visible).
: {{id|API|Region|IsVisible}}() - Get whether the object is visible on screen (logically (IsShown() and GetParent():IsVisible()));
: {{id|API|Region|SetAllPoints}}(frame or "frameName") - Set all anchors to match edges of specified frame - Moved in 1.10.
: {{id|API|Region|SetHeight}}(height) - Set the height of the object.
: {{id|API|Region|SetParent}}(parent or "parentName") - Set the parent for this frame - Moved in 1.10.
: {{id|API|Region|SetPoint}}("point","relativeFrame" or relativeObject,"relativePoint"[, xOfs, yOfs]) - Set an attachment point of this object - Updated in 1.10. Since 2.2 cooordinates are now relative to the closest anchor point
: {{id|API|Region|SetSize}}(width, height) - Set the region's width and height
: {{id|API|Region|SetWidth}}(width) - Set the width of the object.
: {{id|API|Region|Show}}() - Set this object to shown (it will appear if its parent is visible).
: {{id|API|Region|StopAnimating}}() - Stops any active animations on the Region and its children. (added 3.1.0)