VisibleRegion is an abstract UI type used to describe the common functionality of objects that can be placed on the screen, and visible. In particular, methods exist to show and hide the frame, and change the alpha transparency.
Defined Methods
- alpha = VisibleRegion:GetAlpha() - Returns the opacity of the region relative to its parent
- VisibleRegion:Hide() - Hides the region
- shown = VisibleRegion:IsShown() - Returns whether the region is shown
- visible = VisibleRegion:IsVisible() - Returns whether the region is visible
- VisibleRegion:SetAlpha(alpha) - Sets the opacity of the region relative to its parent
- VisibleRegion:Show() - Shows the region
Inherited Methods
- canChange = VisibleRegion:CanChangeProtectedState() - Returns whether protected properties of the region can be changed by non-secure scripts
- VisibleRegion:ClearAllPoints() - Removes all anchor points from the region
- animationGroup = VisibleRegion:CreateAnimationGroup(["name" [, "inheritsFrom"]]) - Creates a new AnimationGroup as a child of the region
- ... = VisibleRegion:GetAnimationGroups() - Returns a list of animation groups belonging to the region
- bottom = VisibleRegion:GetBottom() - Returns the distance from the bottom of the screen to the bottom of the region
- x, y = VisibleRegion:GetCenter() - Returns the screen coordinates of the region's center
- height = VisibleRegion:GetHeight() - Returns the height of the region
- left = VisibleRegion:GetLeft() - Returns the distance from the left edge of the screen to the left edge of the region
- name = VisibleRegion:GetName() - Returns the widget object's name
- numPoints = VisibleRegion:GetNumPoints() - Returns the number of anchor points defined for the region
- type = VisibleRegion:GetObjectType() - Returns the object's widget type
- parent = VisibleRegion:GetParent() - Returns the object's parent object
- point, relativeTo, relativePoint, xOffset, yOffset = VisibleRegion:GetPoint(index) - Returns information about one of the region's anchor points
- left, bottom, width, height = VisibleRegion:GetRect() - Returns the position and dimensions of the region
- right = VisibleRegion:GetRight() - Returns the distance from the left edge of the screen to the right edge of the region
- width, height = VisibleRegion:GetSize() - Returns the width and height of the region
- top = VisibleRegion:GetTop() - Returns the distance from the bottom of the screen to the top of the region
- width = VisibleRegion:GetWidth() - Returns the width of the region
- isDragging = VisibleRegion:IsDragging() - Returns whether the region is currently being dragged
- isOver = VisibleRegion:IsMouseOver() - Returns whether the mouse cursor is over the given region
- isType = VisibleRegion:IsObjectType("type") - Returns whether the object belongs to a given widget type
- isProtected, explicit = VisibleRegion:IsProtected() - Returns whether the region is protected
- VisibleRegion:SetAllPoints([region]) or VisibleRegion:SetAllPoints(["name"]) - Sets all anchor points of the region to match those of another region
- VisibleRegion:SetHeight(height) - Sets the region's height
- VisibleRegion:SetParent(frame) or VisibleRegion:SetParent("name") - Makes another frame the parent of this region
- VisibleRegion:SetPoint("point" [, relativeTo [, "relativePoint" [, xOffset [, yOffset]]]]) - Sets an anchor point for the region
- VisibleRegion:SetSize(width, height) - Sets the size of the region to the specified values
- VisibleRegion:SetWidth(width) - Sets the region's width
- VisibleRegion:StopAnimating() - Stops any active animations involving the region or its children