WoW:Using the ColorPickerFrame - Revision history

Move page script: Move page script moved page Using the ColorPickerFrame to WoW:Using the ColorPickerFrame without leaving a redirect

2023-08-15T04:49:15Z

Move page script moved page Using the ColorPickerFrame to Using the ColorPickerFrame without leaving a redirect

← Older revision	Revision as of 04:49, 15 August 2023
(No difference)

Bear at 09:15, 21 May 2020

2020-05-21T09:15:50Z

← Older revision		Revision as of 09:15, 21 May 2020
Line 1:		Line 1:
	{{~~UIHowTo~~}}		{{wow/uihowto}}
	'''ColorPickerFrame''' is a FrameXML-provided frame that is used by the UI to allow the user to customize color and opacity properties of various objects. The frame can also be used by third-party addons.		'''ColorPickerFrame''' is a FrameXML-provided frame that is used by the UI to allow the user to customize color and opacity properties of various objects. The frame can also be used by third-party addons.

WoWWiki>Mroz123: Note

2010-11-06T00:14:29Z

Note

← Older revision		Revision as of 00:14, 6 November 2010
Line 70:		Line 70:

	All these problems are solved with the addon [http://wow.curse.com/downloads/wow-addons/details/colortools.aspx ColorTools ].		All these problems are solved with the addon [http://wow.curse.com/downloads/wow-addons/details/colortools.aspx ColorTools ].

			==Note==
			As [[User:Exawatt\|Exawatt]] stated, ColorPickerFrame:SetColorRGB(R, G, B) will execute ColorPickerFrame.func
			This is very important when you're reusing ColorPickerFrame with another callback function. In that case make sure you set the new callback before you call SetColorRGB(R, G, B)

WoWWiki>ShandrisForever: /* Limitations */

2010-03-23T16:18:44Z

Limitations

← Older revision		Revision as of 16:18, 23 March 2010
Line 62:		Line 62:
	This can then be used with the previously described ShowColorPicker function:		This can then be used with the previously described ShowColorPicker function:
	ShowColorPicker(r, g, b, a, myColorCallback);		ShowColorPicker(r, g, b, a, myColorCallback);
			==Limitations==
			[[File:ColorPickerTools.jpg\|320px\|right\|thumb\|ColorTools.]]
			The color picker has three main limitations:
			*You have no way to know exactly which color is chosen (no color code)
			*You can't copy color values from one instance of the color picker to another one
			*You cannot move the color picker in case it obscures another underlying frame

			All these problems are solved with the addon [http://wow.curse.com/downloads/wow-addons/details/colortools.aspx ColorTools ].

WoWWiki>Krinya007: /* Responding to user interactions */

2009-11-16T07:23:33Z

Responding to user interactions

← Older revision		Revision as of 07:23, 16 November 2009
Line 52:		Line 52:
	else		else
	-- Something changed		-- Something changed
	newA, newR, newG, newB = OpacitySliderFrame:GetValue(), ColorPickerFrame:GetColorRGB;		newA, newR, newG, newB = OpacitySliderFrame:GetValue(), ColorPickerFrame:GetColorRGB();
	end		end

WoWWiki>Blamdarot: Added some simple explanation to get newbies like me up to speed for the meat of the information.

2009-11-14T01:29:38Z

Added some simple explanation to get newbies like me up to speed for the meat of the information.

← Older revision		Revision as of 01:29, 14 November 2009
Line 11:		Line 11:

	== Showing the color picker ==		== Showing the color picker ==
			The ColorPickerFrame is already defined by Blizzard. You can display it by simply calling: ColorPickerFrame:Show()

			However, displaying it is not enough if you want it to have any functionality. So, you also need to define the following three functions:
			* ColorPickerFrame.func()
			* ColorPickerFrame.opacityFunc()
			* ColorPickerFrame.cancelFunc()

	When you want to prompt the user to select a color, you need to assign your own callback functions to the ColorPickerFrame variables, set the currently selected color to your previous value, and show the ColorPickerFrame.		When you want to prompt the user to select a color, you need to assign your own callback functions to the ColorPickerFrame variables, set the currently selected color to your previous value, and show the ColorPickerFrame.

WoWWiki>Bruners: /* Showing the color picker */

2009-07-13T01:12:46Z

Showing the color picker

← Older revision		Revision as of 01:12, 13 July 2009
Line 21:		Line 21:
	ColorPickerFrame:SetColorRGB(r,g,b);		ColorPickerFrame:SetColorRGB(r,g,b);
	ColorPickerFrame.hasOpacity, ColorPickerFrame.opacity = (a ~= nil), a;		ColorPickerFrame.hasOpacity, ColorPickerFrame.opacity = (a ~= nil), a;
	ColorPickerFrame.~~previousValue~~ = {r,g,b,a};		ColorPickerFrame.previousValues = {r,g,b,a};
	ColorPickerFrame.func, ColorPickerFrame.opacityFunc, ColorPickerFrame.cancelFunc =		ColorPickerFrame.func, ColorPickerFrame.opacityFunc, ColorPickerFrame.cancelFunc =
	changedCallback, changedCallback, changedCallback;		changedCallback, changedCallback, changedCallback;

WoWWiki>Starlightblunder: colon entities

2009-07-12T23:00:09Z

colon entities

@@ Line 1: / Line 1: @@
-== What is it? ==
+{{UIHowTo}}
-The ColorPickerFrame (See: [[XML_User_Interface#ColorSelect]]) is the default WoW frame to easily select color and opacity using a GUI.
+== Overview ==
-The ColorPickerFrame comes with customizable functions, which are next.
+There is only one instance of the ColorPickerFrame, and, as such, only color selection request can be processed at a time. When the player interacts with the color picker, the frame calls functions assigned to the following variables:
-== ColorPickerFrame functions ==
+The opacity slider's visibility is controlled by the <code>ColorPickerFrame.hasOpacity</code> boolean value.
- ColorPickerFrame.func;
+== Showing the color picker ==
- --Called on changing the color wheel
+When you want to prompt the user to select a color, you need to assign your own callback functions to the ColorPickerFrame variables, set the currently selected color to your previous value, and show the ColorPickerFrame.
- ColorPickerFrame.opacityFunc;
+To set the initial color and opacity values, you need to:
- --Called on changing the opacity slider
+; ColorPickerFrame&#58;SetColorRGB(r,g,b) : Sets the initial color.
-  ColorPickerFrame.cancelFunc;
+The following example function performs all of the required tasks: sets the initial color, enables/disables the opacity control and registers your callback function before showing the color picker.
- --Called on hitting CANCEL button OR pressing ESCAPE.
+  function ShowColorPicker(r, g, b, a, changedCallback)
- --cancelFunc is called with the argument ColorPickerFrame.previousValues so set that when
+  ColorPickerFrame:SetColorRGB(r,g,b);
-  --you show the frame
+  ColorPickerFrame.hasOpacity, ColorPickerFrame.opacity = (a ~= nil), a;
-These functions can be specified by you to do something.  The best example is setting some variables to the selected color as it changes.  Check the following code:
+== Responding to user interactions ==
- ColorPickerFrame.func = MY_COLOR_FUNCTION
+An example callback handler function is shown below.
-  ColorPickerFrame.cancelFunc = MY_CANCEL_FUNCTION
+  local r,g,b,a = 1, 0, 0, 1;
-  function MY_COLOR_FUNCTION()
+  local function myColorCallback(restore)
-    local R,G,B = ColorPickerFrame:GetColorRGB();
+  local newR, newG, newB, newA;
   end
- ColorPickerFrame.opacity = Alpha;
+This can then be used with the previously described ShowColorPicker function:
- --Sets the initial value of the opacity slider.
+  ShowColorPicker(r, g, b, a, myColorCallback);

WoWWiki>NefariousN: /* Examples of use */

2008-01-08T07:31:42Z

Examples of use

← Older revision		Revision as of 07:31, 8 January 2008
Line 70:		Line 70:

	Set R, G, and B to the ColorWheel's colors on changing the selected color		Set R, G, and B to the ColorWheel's colors on changing the selected color
	~~ColorPickerFrame.func = MY_COLOR_FUNCTION~~

	function MY_COLOR_FUNCTION()		function MY_COLOR_FUNCTION()
	local R,G,B = ColorPickerFrame:GetColorRGB();		local R,G,B = ColorPickerFrame:GetColorRGB();
	end		end

			ColorPickerFrame.func = MY_COLOR_FUNCTION
	[[Category:HOWTOs\|Use the ColorPickerFrame]]		[[Category:HOWTOs\|Use the ColorPickerFrame]]

WoWWiki>The Nerd Wonder at 23:01, 23 January 2006

2006-01-23T23:01:42Z

← Older revision		Revision as of 23:01, 23 January 2006
Line 1:		Line 1:

	== What is it? ==		== What is it? ==

Line 76:		Line 75:
	local R,G,B = ColorPickerFrame:GetColorRGB();		local R,G,B = ColorPickerFrame:GetColorRGB();
	end		end
			[[Category:HOWTOs\|Use the ColorPickerFrame]]