ColorSelect is a very specialized type of frame with a very spcific purpose; to allow the user to interactively select a color, typically to control the appearance of another UI element. Most often these are used to allow the player to control the appearance of chat messages in different channels. They are also used when creating a tabard to control the color scheme.
While the ColorSelect type gives you fairly detailed control over the appearance of the color wheel and value slider, the standard Color picker frame as defined in FrameXML/ColorPicketFrame.xml is preconfigured and usually adequate to your needs. You will usually be more interested in the SetColor methods (to load a color you have stored for a particular element) and the GetColor methods (to retrieve the new color chosen by the user). ColorSelect supports both RGB and HSV color descriptions.
Defined Methods
- hue, saturation, value = ColorSelect:GetColorHSV() - Returns the hue, saturation and value of the currently selected color
- red, blue, green = ColorSelect:GetColorRGB() - Returns the red, green and blue components of the currently selected color
- texture = ColorSelect:GetColorValueTexture() - Returns the texture for the color picker's value slider background
- texture = ColorSelect:GetColorValueThumbTexture() - Returns the texture for the color picker's value slider thumb
- texture = ColorSelect:GetColorWheelTexture() - Returns the texture for the color picker's hue/saturation wheel
- texture = ColorSelect:GetColorWheelThumbTexture() - Returns the texture for the selection indicator on the color picker's hue/saturation wheel
- ColorSelect:SetColorHSV(hue, saturation, value) - Sets the color picker's selected color by hue, saturation and value
- ColorSelect:SetColorRGB(red, blue, green) - Sets the color picker's selected color by red, green and blue components
- ColorSelect:SetColorValueTexture(texture) - Sets the `Texture` object used to display the color picker's value slider
- ColorSelect:SetColorValueThumbTexture(texture) or ColorSelect:SetColorValueThumbTexture("filename") - Sets the texture for the color picker's value slider thumb
- ColorSelect:SetColorWheelTexture(texture) - Sets the `Texture` object used to display the color picker's hue/saturation wheel
- ColorSelect:SetColorWheelThumbTexture(texture) or ColorSelect:SetColorWheelThumbTexture("filename") - Sets the texture for the selection indicator on the color picker's hue/saturation wheel
Inherited Methods
- ColorSelect:AllowAttributeChanges() - Temporarily allows insecure code to modify the frame's attributes during combat
- enabled = ColorSelect:CanChangeAttribute() - Returns whether secure frame attributes can currently be changed
- canChange = ColorSelect:CanChangeProtectedState() - Returns whether protected properties of the region can be changed by non-secure scripts
- ColorSelect:ClearAllPoints() - Removes all anchor points from the region
- animationGroup = ColorSelect:CreateAnimationGroup(["name" [, "inheritsFrom"]]) - Creates a new AnimationGroup as a child of the region
- fontstring = ColorSelect:CreateFontString(["name" [, "layer" [, "inherits"]]]) - Creates a new [[docs/widgets/FontString|`FontString`]] as a child of the frame
- texture = ColorSelect:CreateTexture(["name" [, "layer" [, "inherits"]]]) - Creates a new [[docs/widgets/Texture|`Texture`]] as a child of the frame
- region = ColorSelect:CreateTitleRegion() - Creates a title region for dragging the frame
- ColorSelect:DisableDrawLayer("layer") - Prevents display of all child objects of the frame on a specified graphics layer
- ColorSelect:EnableDrawLayer("layer") - Allows display of all child objects of the frame on a specified graphics layer
- ColorSelect:EnableJoystick(enable) - Enables or disables joystick interactivity
- ColorSelect:EnableKeyboard(enable) - Enables or disables keyboard interactivity for the frame
- ColorSelect:EnableMouse(enable) - Enables or disables mouse interactivity for the frame
- ColorSelect:EnableMouseWheel(enable) - Enables or disables mouse wheel interactivity for the frame
- alpha = ColorSelect:GetAlpha() - Returns the opacity of the region relative to its parent
- ... = ColorSelect:GetAnimationGroups() - Returns a list of animation groups belonging to the region
- value = ColorSelect:GetAttribute("name") - Returns the value of a secure frame attribute
- backdrop = ColorSelect:GetBackdrop() - Returns information about the frame's backdrop graphic
- red, green, blue, alpha = ColorSelect:GetBackdropBorderColor() - Returns the shading color for the frame's border graphic
- red, green, blue, alpha = ColorSelect:GetBackdropColor() - Returns the shading color for the frame's background graphic
- bottom = ColorSelect:GetBottom() - Returns the distance from the bottom of the screen to the bottom of the region
- left, bottom, width, height = ColorSelect:GetBoundsRect() - Returns the position and dimension of the smallest area enclosing the frame and its children
- x, y = ColorSelect:GetCenter() - Returns the screen coordinates of the region's center
- ... = ColorSelect:GetChildren() - Returns a list of child frames of the frame
- left, right, top, bottom = ColorSelect:GetClampRectInsets() - Returns offsets from the frame's edges used when limiting user movement or resizing of the frame
- depth = ColorSelect:GetDepth() - Returns the 3D depth of the frame (for stereoscopic 3D setups)
- ColorSelect:GetDontSavePosition() - This function is not yet documented
- alpha = ColorSelect:GetEffectiveAlpha() - Returns the overall opacity of the frame
- depth = ColorSelect:GetEffectiveDepth() - Returns the overall 3D depth of the frame (for stereoscopic 3D configurations)
- scale = ColorSelect:GetEffectiveScale() - Returns the overall scale factor of the frame
- level = ColorSelect:GetFrameLevel() - Sets the level at which the frame is layered relative to others in its strata
- strata = ColorSelect:GetFrameStrata() - Returns the general layering strata of the frame
- height = ColorSelect:GetHeight() - Returns the height of the region
- left, right, top, bottom = ColorSelect:GetHitRectInsets() - Returns the insets from the frame's edges which determine its mouse-interactable area
- id = ColorSelect:GetID() - Returns the frame's numeric identifier
- left = ColorSelect:GetLeft() - Returns the distance from the left edge of the screen to the left edge of the region
- maxWidth, maxHeight = ColorSelect:GetMaxResize() - Returns the maximum size of the frame for user resizing
- minWidth, minHeight = ColorSelect:GetMinResize() - Returns the minimum size of the frame for user resizing
- name = ColorSelect:GetName() - Returns the widget object's name
- numChildren = ColorSelect:GetNumChildren() - Returns the number of child frames belonging to the frame
- numPoints = ColorSelect:GetNumPoints() - Returns the number of anchor points defined for the region
- numRegions = ColorSelect:GetNumRegions() - Returns the number of non-Frame child regions belonging to the frame
- type = ColorSelect:GetObjectType() - Returns the object's widget type
- parent = ColorSelect:GetParent() - Returns the object's parent object
- point, relativeTo, relativePoint, xOffset, yOffset = ColorSelect:GetPoint(index) - Returns information about one of the region's anchor points
- left, bottom, width, height = ColorSelect:GetRect() - Returns the position and dimensions of the region
- ... = ColorSelect:GetRegions() - Returns a list of non-Frame child regions belonging to the frame
- right = ColorSelect:GetRight() - Returns the distance from the left edge of the screen to the right edge of the region
- scale = ColorSelect:GetScale() - Returns the frame's scale factor
- handler = ColorSelect:GetScript("scriptType") - Returns the widget's handler function for a script
- width, height = ColorSelect:GetSize() - Returns the width and height of the region
- region = ColorSelect:GetTitleRegion() - Returns the frame's TitleRegion object
- top = ColorSelect:GetTop() - Returns the distance from the bottom of the screen to the top of the region
- width = ColorSelect:GetWidth() - Returns the width of the region
- hasScript = ColorSelect:HasScript("scriptType") - Returns whether the widget supports a script handler
- ColorSelect:Hide() - Hides the region
- ColorSelect:HookScript("scriptType", handler) - Securely hooks a script handler
- ColorSelect:IgnoreDepth(enable) - Sets whether the frame's depth property is ignored (for stereoscopic 3D setups)
- enabled = ColorSelect:IsClampedToScreen() - Returns whether the frame's boundaries are limited to those of the screen
- isDragging = ColorSelect:IsDragging() - Returns whether the region is currently being dragged
- registered = ColorSelect:IsEventRegistered("event") - Returns whether the frame is registered for a given [[docs/events|event]]
- enabled = ColorSelect:IsIgnoringDepth() - Returns whether the frame's depth property is ignored (for stereoscopic 3D setups)
- enabled = ColorSelect:IsJoystickEnabled() - Returns whether joystick interactivity is enabled for the frame
- enabled = ColorSelect:IsKeyboardEnabled() - Returns whether keyboard interactivity is enabled for the frame
- enabled = ColorSelect:IsMouseEnabled() - Returns whether mouse interactivity is enabled for the frame
- isOver = ColorSelect:IsMouseOver([topOffset [, leftOffset [, bottomOffset [, rightOffset]]]]) - Returns whether the mouse cursor is over the given region
- enabled = ColorSelect:IsMouseWheelEnabled() - Returns whether mouse wheel interactivity is enabled for the frame
- movable = ColorSelect:IsMovable() - Returns whether the frame can be moved by the user
- isType = ColorSelect:IsObjectType("type") - Returns whether the object belongs to a given widget type
- isProtected, explicit = ColorSelect:IsProtected() - Returns whether the region is protected
- enabled = ColorSelect:IsResizable() - Returns whether the frame can be resized by the user
- shown = ColorSelect:IsShown() - Returns whether the region is shown
- enabled = ColorSelect:IsToplevel() - Returns whether the frame is automatically raised to the front when clicked
- enabled = ColorSelect:IsUserPlaced() - Returns whether the frame is flagged for automatic saving and restoration of position and dimensions
- visible = ColorSelect:IsVisible() - Returns whether the region is visible
- ColorSelect:Lower() - Reduces the frame's frame level below all other frames in its strata
- ColorSelect:Raise() - Increases the frame's frame level above all other frames in its strata
- ColorSelect:RegisterAllEvents() - Registers the frame for all events
- ColorSelect:RegisterEvent("event") - Registers the frame for an [[docs/events|event]]
- ColorSelect:RegisterForDrag(...) - Registers the frame for dragging
- ColorSelect:SetAllPoints([region]) or ColorSelect:SetAllPoints(["name"]) - Sets all anchor points of the region to match those of another region
- ColorSelect:SetAlpha(alpha) - Sets the opacity of the region relative to its parent
- ColorSelect:SetAttribute("name", value) - Sets a secure frame attribute
- ColorSelect:SetBackdrop(backdrop) - Sets a backdrop graphic for the frame
- ColorSelect:SetBackdropBorderColor(red, green, blue [, alpha]) - Sets a shading color for the frame's border graphic
- ColorSelect:SetBackdropColor(red, green, blue [, alpha]) - Sets a shading color for the frame's background graphic
- ColorSelect:SetClampRectInsets(left, right, top, bottom) - Sets offsets from the frame's edges used when limiting user movement or resizing of the frame
- ColorSelect:SetClampedToScreen(enable) - Sets whether the frame's boundaries should be limited to those of the screen
- ColorSelect:SetDepth(depth) - Sets the 3D depth of the frame (for stereoscopic 3D configurations)
- ColorSelect:SetDontSavePosition() - This function is not yet documented
- ColorSelect:SetFrameLevel(level) - Sets the level at which the frame is layered relative to others in its strata
- ColorSelect:SetFrameStrata("strata") - Sets the general layering strata of the frame
- ColorSelect:SetHeight(height) - Sets the region's height
- ColorSelect:SetHitRectInsets(left, right, top, bottom) - Sets the insets from the frame's edges which determine its mouse-interactable area
- ColorSelect:SetID(id) - Sets a numeric identifier for the frame
- ColorSelect:SetMaxResize(maxWidth, maxHeight) - Sets the maximum size of the frame for user resizing
- ColorSelect:SetMinResize(minWidth, minHeight) - Sets the minimum size of the frame for user resizing
- ColorSelect:SetMovable(enable) - Sets whether the frame can be moved by the user
- ColorSelect:SetParent(frame) or ColorSelect:SetParent("name") - Makes another frame the parent of this region
- ColorSelect:SetPoint("point" [, relativeTo [, "relativePoint" [, xOffset [, yOffset]]]]) - Sets an anchor point for the region
- ColorSelect:SetResizable(enable) - Sets whether the frame can be resized by the user
- ColorSelect:SetScale(scale) - Sets the frame's scale factor
- ColorSelect:SetScript("scriptType", handler) - Sets the widget's handler function for a script
- ColorSelect:SetSize(width, height) - Sets the size of the region to the specified values
- ColorSelect:SetToplevel(enable) - Sets whether the frame should automatically come to the front when clicked
- ColorSelect:SetUserPlaced(enable) - Flags the frame for automatic saving and restoration of position and dimensions
- ColorSelect:SetWidth(width) - Sets the region's width
- ColorSelect:Show() - Shows the region
- ColorSelect:StartMoving() - Begins repositioning the frame via mouse movement
- ColorSelect:StartSizing() - Begins resizing the frame via mouse movement
- ColorSelect:StopAnimating() - Stops any active animations involving the region or its children
- ColorSelect:StopMovingOrSizing() - Ends movement or resizing of the frame initiated with [[docs/widgets/Frame/StartMoving|`:StartMoving()`]] or [[docs/widgets/Frame/StartSizing|`:StartSizing()`]]
- ColorSelect:UnregisterAllEvents() - Unregisters the frame from any [[docs/events|events]] for which it is registered
- ColorSelect:UnregisterEvent("event") - Unregisters the frame for an event
Script Handlers
- OnAttributeChanged(self, "name", value) - Run when a frame attribute is changed
- OnChar(self, "text") - Run for each text character typed in the frame
- OnColorSelect(self, r, g, b) - Run when the color select frame's color selection changes
- OnDisable(self) - Run when the frame is disabled
- OnDragStart(self, "button") - Run when the mouse is dragged starting in the frame
- OnDragStop(self) - Run when the mouse button is released after a drag started in the frame
- OnEnable(self) - Run when the frame is enabled
- OnEnter(self, motion) - Run when the mouse cursor enters the frame's interactive area
- OnEvent(self, "event", ...) - Run whenever an [[docs/events|event]] fires for which the frame is registered
- OnHide(self) - Run when the frame's visbility changes to hidden
- OnKeyDown(self, "key") - Run when a keyboard key is pressed if the frame is keyboard enabled
- OnKeyUp(self, "key") - Run when a keyboard key is released if the frame is keyboard enabled
- OnLeave(self, motion) - Run when the mouse cursor leaves the frame's interactive area
- OnLoad(self) - Run when the frame is created
- OnMouseDown(self, "button") - Run when a mouse button is pressed while the cursor is over the frame
- OnMouseUp(self, "button") - Run when the mouse button is released following a mouse down action in the frame
- OnMouseWheel(self, delta) - Run when the frame receives a mouse wheel scrolling action
- OnReceiveDrag(self) - Run when the mouse button is released after dragging into the frame
- OnShow(self) - Run when the frame becomes visible
- OnSizeChanged(self, width, height) - Run when a frame's size changes
- OnUpdate(self, elapsed) - Run each time the screen is drawn by the game engine