Fl_Color_Chooser Class Reference

The Fl_Color_Chooser widget provides a standard RGB color chooser. More...

#include <Fl_Color_Chooser.H>

Inheritance diagram for Fl_Color_Chooser:

Public Member Functions
double	b () const
	Returns the current blue value. More...
	Fl_Color_Chooser (int X, int Y, int W, int H, const char *L=0)
	Creates a new Fl_Color_Chooser widget using the given position, size, and label string. More...
double	g () const
	Returns the current green value. More...
int	handle (int e) FL_OVERRIDE
	Handles all events received by this widget. More...
int	hsv (double H, double S, double V)
	Set the hsv values. More...
double	hue () const
	Returns the current hue. More...
int	mode ()
	Returns which Fl_Color_Chooser variant is currently active. More...
void	mode (int newMode)
	Set which Fl_Color_Chooser variant is currently active. More...
double	r () const
	Returns the current red value. More...
int	rgb (double R, double G, double B)
	Sets the current rgb color values. More...
double	saturation () const
	Returns the saturation. More...
double	value () const
	Returns the value/brightness. More...
Public Member Functions inherited from Fl_Group
Fl_Widget *&	_ddfdesign_kludge ()
	This is for forms compatibility only.
void	add (Fl_Widget &)
	The widget is removed from its current group (if any) and then added to the end of this group.
void	add (Fl_Widget *o)
	See void Fl_Group::add(Fl_Widget &w)
void	add_resizable (Fl_Widget &o)
	Adds a widget to the group and makes it the resizable widget.
Fl_Widget *const *	array () const
	Returns a pointer to the array of children. More...
Fl_Group const *	as_group () const FL_OVERRIDE
Fl_Group *	as_group () FL_OVERRIDE
	Returns an Fl_Group pointer if this widget is an Fl_Group. More...
void	begin ()
	Sets the current group so you can build the widget tree by just constructing the widgets. More...
Fl_Widget *	child (int n) const
	Returns array()[n]. More...
int	children () const
	Returns how many child widgets the group has.
void	clear ()
	Deletes all child widgets from memory recursively. More...
unsigned int	clip_children ()
	Returns the current clipping mode. More...
void	clip_children (int c)
	Controls whether the group widget clips the drawing of child widgets to its bounding box. More...
virtual int	delete_child (int n)
	Removes the widget at index from the group and deletes it. More...
void	end ()
	Exactly the same as current(this->parent()). More...
int	find (const Fl_Widget &o) const
	See int Fl_Group::find(const Fl_Widget *w) const.
int	find (const Fl_Widget *) const
	Searches the child array for the widget and returns the index. More...
	Fl_Group (int, int, int, int, const char *=0)
	Creates a new Fl_Group widget using the given position, size, and label string. More...
void	focus (Fl_Widget *W)
void	forms_end ()
	This is for forms compatibility only.
int	handle (int) FL_OVERRIDE
	Handles the specified event. More...
void	init_sizes ()
	Resets the internal array of widget sizes and positions. More...
void	insert (Fl_Widget &, int i)
	The widget is removed from its current group (if any) and then inserted into this group. More...
void	insert (Fl_Widget &o, Fl_Widget *before)
	This does insert(w, find(before)). More...
void	remove (Fl_Widget &)
	Removes a widget from the group but does not delete it. More...
void	remove (Fl_Widget *o)
	Removes the widget o from the group. More...
void	remove (int index)
	Removes the widget at index from the group but does not delete it. More...
Fl_Widget *	resizable () const
	Returns the group's resizable widget. More...
void	resizable (Fl_Widget &o)
	Sets the group's resizable widget. More...
void	resizable (Fl_Widget *o)
	The resizable widget defines both the resizing box and the resizing behavior of the group and its children. More...
void	resize (int, int, int, int) FL_OVERRIDE
	Resizes the Fl_Group widget and all of its children. More...
virtual	~Fl_Group ()
	The destructor also deletes all the children. More...
Public Member Functions inherited from Fl_Widget
void	_clear_fullscreen ()
void	_set_fullscreen ()
void	activate ()
	Activates the widget. More...
unsigned int	active () const
	Returns whether the widget is active. More...
int	active_r () const
	Returns whether the widget and all of its parents are active. More...
Fl_Align	align () const
	Gets the label alignment. More...
void	align (Fl_Align alignment)
	Sets the label alignment. More...
long	argument () const
	Gets the current user data (long) argument that is passed to the callback function. More...
void	argument (long v)
	Sets the current user data (long) argument that is passed to the callback function. More...
virtual class Fl_Gl_Window *	as_gl_window ()
	Returns an Fl_Gl_Window pointer if this widget is an Fl_Gl_Window. More...
virtual class Fl_Gl_Window const *	as_gl_window () const
virtual Fl_Group *	as_group ()
	Returns an Fl_Group pointer if this widget is an Fl_Group. More...
virtual Fl_Group const *	as_group () const
virtual Fl_Window *	as_window ()
	Returns an Fl_Window pointer if this widget is an Fl_Window. More...
virtual Fl_Window const *	as_window () const
void	bind_deimage (Fl_Image *img)
	Sets the image to use as part of the widget label when in the inactive state. More...
void	bind_deimage (int f)
	Bind the inactive image to the widget, so the widget will delete the image when it is no longer needed. More...
void	bind_image (Fl_Image *img)
	Sets the image to use as part of the widget label when in the active state. More...
void	bind_image (int f)
	Bind the image to the widget, so the widget will delete the image when it is no longer needed. More...
Fl_Boxtype	box () const
	Gets the box type of the widget. More...
void	box (Fl_Boxtype new_box)
	Sets the box type for the widget. More...
Fl_Callback_p	callback () const
	Gets the current callback function for the widget. More...
void	callback (Fl_Callback *cb)
	Sets the current callback function for the widget. More...
void	callback (Fl_Callback *cb, Fl_Callback_User_Data *p, bool auto_free)
	Sets the current callback function and managed user data for the widget. More...
void	callback (Fl_Callback *cb, void *p)
	Sets the current callback function and data for the widget. More...
void	callback (Fl_Callback0 *cb)
	Sets the current callback function for the widget. More...
void	callback (Fl_Callback1 *cb, long p=0)
	Sets the current callback function for the widget. More...
unsigned int	changed () const
	Checks if the widget value changed since the last callback. More...
void	clear_active ()
	Marks the widget as inactive without sending events or changing focus. More...
void	clear_changed ()
	Marks the value of the widget as unchanged. More...
void	clear_damage (uchar c=0)
	Clears or sets the damage flags. More...
void	clear_output ()
	Sets a widget to accept input. More...
void	clear_visible ()
	Hides the widget. More...
void	clear_visible_focus ()
	Disables keyboard focus navigation with this widget. More...
Fl_Color	color () const
	Gets the background color of the widget. More...
void	color (Fl_Color bg)
	Sets the background color of the widget. More...
void	color (Fl_Color bg, Fl_Color sel)
	Sets the background and selection color of the widget. More...
Fl_Color	color2 () const
	For back compatibility only. More...
void	color2 (unsigned a)
	For back compatibility only. More...
int	contains (const Fl_Widget *w) const
	Checks if w is a child of this widget. More...
void	copy_label (const char *new_label)
	Sets the current label. More...
void	copy_tooltip (const char *text)
	Sets the current tooltip text. More...
uchar	damage () const
	Returns non-zero if draw() needs to be called. More...
void	damage (uchar c)
	Sets the damage bits for the widget. More...
void	damage (uchar c, int x, int y, int w, int h)
	Sets the damage bits for an area inside the widget. More...
int	damage_resize (int, int, int, int)
	Internal use only.
void	deactivate ()
	Deactivates the widget. More...
Fl_Image *	deimage ()
	Gets the image that is used as part of the widget label when in the inactive state. More...
const Fl_Image *	deimage () const
	Gets the image that is used as part of the widget label when in the inactive state. More...
void	deimage (Fl_Image &img)
	Sets the image to use as part of the widget label when in the inactive state. More...
void	deimage (Fl_Image *img)
	Sets the image to use as part of the widget label when in the inactive state. More...
int	deimage_bound () const
	Returns whether the inactive image is managed by the widget. More...
void	do_callback (Fl_Callback_Reason reason=FL_REASON_UNKNOWN)
	Calls the widget callback function with default arguments. More...
void	do_callback (Fl_Widget *widget, long arg, Fl_Callback_Reason reason=FL_REASON_UNKNOWN)
	Calls the widget callback function with arbitrary arguments. More...
void	do_callback (Fl_Widget *widget, void *arg=0, Fl_Callback_Reason reason=FL_REASON_UNKNOWN)
	Calls the widget callback function with arbitrary arguments. More...
virtual void	draw ()=0
	Draws the widget. More...
void	draw_label (int, int, int, int, Fl_Align) const
	Draws the label in an arbitrary bounding box with an arbitrary alignment. More...
int	h () const
	Gets the widget height. More...
virtual int	handle (int event)
	Handles the specified event. More...
virtual void	hide ()
	Makes a widget invisible. More...
int	horizontal_label_margin ()
	Get the spacing between the label and the horizontal edge of the widget. More...
void	horizontal_label_margin (int px)
	Set the spacing between the label and the horizontal edge of the widget. More...
Fl_Image *	image ()
	Gets the image that is used as part of the widget label when in the active state. More...
const Fl_Image *	image () const
	Gets the image that is used as part of the widget label when in the active state. More...
void	image (Fl_Image &img)
	Sets the image to use as part of the widget label when in the active state. More...
void	image (Fl_Image *img)
	Sets the image to use as part of the widget label when in the active state. More...
int	image_bound () const
	Returns whether the image is managed by the widget. More...
int	inside (const Fl_Widget *wgt) const
	Checks if this widget is a child of wgt. More...
int	is_label_copied () const
	Returns whether the current label was assigned with copy_label(). More...
const char *	label () const
	Gets the current label text. More...
void	label (const char *text)
	Sets the current label pointer. More...
void	label (Fl_Labeltype a, const char *b)
	Shortcut to set the label text and type in one call. More...
int	label_image_spacing ()
	Return the gap size between the label and the image. More...
void	label_image_spacing (int gap)
	Set the gap between the label and the image in pixels. More...
Fl_Color	labelcolor () const
	Gets the label color. More...
void	labelcolor (Fl_Color c)
	Sets the label color. More...
Fl_Font	labelfont () const
	Gets the font to use. More...
void	labelfont (Fl_Font f)
	Sets the font to use. More...
Fl_Fontsize	labelsize () const
	Gets the font size in pixels. More...
void	labelsize (Fl_Fontsize pix)
	Sets the font size in pixels. More...
Fl_Labeltype	labeltype () const
	Gets the label type. More...
void	labeltype (Fl_Labeltype a)
	Sets the label type. More...
void	measure_label (int &ww, int &hh) const
	Sets width ww and height hh accordingly with the label size. More...
bool	needs_keyboard () const
	Returns whether this widget needs a keyboard. More...
void	needs_keyboard (bool needs)
	Sets whether this widget needs a keyboard. More...
unsigned int	output () const
	Returns if a widget is used for output only. More...
Fl_Group *	parent () const
	Returns a pointer to the parent widget. More...
void	parent (Fl_Group *p)
	Internal use only - "for hacks only". More...
void	position (int X, int Y)
	Repositions the window or widget. More...
void	redraw ()
	Schedules the drawing of the widget. More...
void	redraw_label ()
	Schedules the drawing of the label. More...
virtual void	resize (int x, int y, int w, int h)
	Changes the size or position of the widget. More...
Fl_Color	selection_color () const
	Gets the selection color. More...
void	selection_color (Fl_Color a)
	Sets the selection color. More...
void	set_active ()
	Marks the widget as active without sending events or changing focus. More...
void	set_changed ()
	Marks the value of the widget as changed. More...
void	set_output ()
	Sets a widget to output only. More...
void	set_visible ()
	Makes the widget visible. More...
void	set_visible_focus ()
	Enables keyboard focus navigation with this widget. More...
int	shortcut_label () const
	Returns whether the widget's label uses '&' to indicate shortcuts. More...
void	shortcut_label (int value)
	Sets whether the widget's label uses '&' to indicate shortcuts. More...
virtual void	show ()
	Makes a widget visible. More...
void	size (int W, int H)
	Changes the size of the widget. More...
int	take_focus ()
	Gives the widget the keyboard focus. More...
unsigned int	takesevents () const
	Returns if the widget is able to take events. More...
int	test_shortcut ()
	Returns true if the widget's label contains the entered '&x' shortcut. More...
const char *	tooltip () const
	Gets the current tooltip text. More...
void	tooltip (const char *text)
	Sets the current tooltip text. More...
Fl_Window *	top_window () const
	Returns a pointer to the top-level window for the widget. More...
Fl_Window *	top_window_offset (int &xoff, int &yoff) const
	Finds the x/y offset of the current widget relative to the top-level window. More...
uchar	type () const
	Gets the widget type. More...
void	type (uchar t)
	Sets the widget type. More...
int	use_accents_menu ()
	Returns non zero if MAC_USE_ACCENTS_MENU flag is set, 0 otherwise.
void *	user_data () const
	Gets the user data for this widget. More...
void	user_data (Fl_Callback_User_Data *v, bool auto_free)
	Sets the user data for this widget.
void	user_data (void *v)
	Sets the user data for this widget.
int	vertical_label_margin ()
	Get the spacing between the label and the vertical edge of the widget. More...
void	vertical_label_margin (int px)
	Set the spacing between the label and the vertical edge of the widget. More...
unsigned int	visible () const
	Returns whether a widget is visible. More...
unsigned int	visible_focus () const
	Checks whether this widget has a visible focus. More...
void	visible_focus (int v)
	Modifies keyboard focus navigation. More...
int	visible_r () const
	Returns whether a widget and all its parents are visible. More...
int	w () const
	Gets the widget width. More...
Fl_When	when () const
	Returns the conditions under which the callback is called. More...
void	when (uchar i)
	Sets the flags used to decide when a callback is called. More...
Fl_Window *	window () const
	Returns a pointer to the nearest parent window up the widget hierarchy. More...
int	x () const
	Gets the widget position in its window. More...
int	y () const
	Gets the widget position in its window. More...
virtual	~Fl_Widget ()
	Destroys the widget. More...

Static Public Member Functions
static void	hsv2rgb (double H, double S, double V, double &R, double &G, double &B)
	This static method converts HSV colors to RGB colorspace. More...
static void	rgb2hsv (double R, double G, double B, double &H, double &S, double &V)
	This static method converts RGB colors to HSV colorspace. More...
Static Public Member Functions inherited from Fl_Group
static Fl_Group *	current ()
	Returns the currently active group. More...
static void	current (Fl_Group *g)
	Sets the current group. More...
Static Public Member Functions inherited from Fl_Widget
static void	default_callback (Fl_Widget *widget, void *data)
	The default callback for all widgets that don't set a callback. More...
static unsigned int	label_shortcut (const char *t)
	Returns the Unicode value of the '&x' shortcut in a given text. More...
static int	test_shortcut (const char *, const bool require_alt=false)
	Returns true if the given text t contains the entered '&x' shortcut. More...

Related Functions
(Note that these are not member functions.)
int	fl_color_chooser (const char *name, double &r, double &g, double &b, int cmode)
	Pops up a window to let the user pick an arbitrary RGB color. More...
int	fl_color_chooser (const char *name, uchar &r, uchar &g, uchar &b, int cmode)
	Pops up a window to let the user pick an arbitrary RGB color. More...

Additional Inherited Members
Protected Types inherited from Fl_Widget
enum	{   INACTIVE = 1<<0 , INVISIBLE = 1<<1 , OUTPUT = 1<<2 , NOBORDER = 1<<3 ,   FORCE_POSITION = 1<<4 , NON_MODAL = 1<<5 , SHORTCUT_LABEL = 1<<6 , CHANGED = 1<<7 ,   OVERRIDE = 1<<8 , VISIBLE_FOCUS = 1<<9 , COPIED_LABEL = 1<<10 , CLIP_CHILDREN = 1<<11 ,   MENU_WINDOW = 1<<12 , TOOLTIP_WINDOW = 1<<13 , MODAL = 1<<14 , NO_OVERLAY = 1<<15 ,   GROUP_RELATIVE = 1<<16 , COPIED_TOOLTIP = 1<<17 , FULLSCREEN = 1<<18 , MAC_USE_ACCENTS_MENU = 1<<19 ,   NEEDS_KEYBOARD = 1<<20 , IMAGE_BOUND = 1<<21 , DEIMAGE_BOUND = 1<<22 , AUTO_DELETE_USER_DATA = 1<<23 ,   MAXIMIZED = 1<<24 , POPUP = 1<<25 , USERFLAG3 = 1<<29 , USERFLAG2 = 1<<30 ,   USERFLAG1 = 1<<31 }
	flags possible values enumeration. More...
Protected Member Functions inherited from Fl_Group
Fl_Rect *	bounds ()
	Returns the internal array of widget sizes and positions. More...
void	draw () FL_OVERRIDE
	Draws the widget. More...
void	draw_child (Fl_Widget &widget) const
	Forces a child to redraw. More...
void	draw_children ()
	Draws all children of the group. More...
void	draw_outside_label (const Fl_Widget &widget) const
	Parents normally call this to draw outside labels of child widgets.
virtual int	on_insert (Fl_Widget *, int)
	Allow derived groups to act when a widget is added as a child. More...
virtual int	on_move (int, int)
	Allow derived groups to act when a widget is moved within the group. More...
virtual void	on_remove (int)
	Allow derived groups to act when a child widget is removed from the group. More...
int *	sizes ()
	Returns the internal array of widget sizes and positions. More...
void	update_child (Fl_Widget &widget) const
	Draws a child only if it needs it. More...
Protected Member Functions inherited from Fl_Widget
void	clear_flag (unsigned int c)
	Clears a flag in the flags mask.
void	draw_backdrop () const
	If FL_ALIGN_IMAGE_BACKDROP is set, the image or deimage will be drawn.
void	draw_box () const
	Draws the widget box according its box style.
void	draw_box (Fl_Boxtype t, Fl_Color c) const
	Draws a box of type t, of color c at the widget's position and size.
void	draw_box (Fl_Boxtype t, int x, int y, int w, int h, Fl_Color c) const
	Draws a box of type t, of color c at the position X,Y and size W,H.
void	draw_focus () const
	Draws a focus rectangle around the widget. More...
void	draw_focus (Fl_Boxtype t, int X, int Y, int W, int H) const
	Draws a focus rectangle around the widget. More...
void	draw_focus (Fl_Boxtype t, int x, int y, int w, int h, Fl_Color bg) const
	Draws a focus box for the widget at the given position and size. More...
void	draw_label () const
	Draws the widget's label at the defined label position. More...
void	draw_label (int, int, int, int) const
	Draws the label in an arbitrary bounding box. More...
	Fl_Widget (int x, int y, int w, int h, const char *label=0L)
	Creates a widget at the given position and size. More...
unsigned int	flags () const
	Gets the widget flags mask.
void	h (int v)
	Internal use only. More...
void	set_flag (unsigned int c)
	Sets a flag in the flags mask.
void	w (int v)
	Internal use only. More...
void	x (int v)
	Internal use only. More...
void	y (int v)
	Internal use only. More...

Detailed Description

The Fl_Color_Chooser widget provides a standard RGB color chooser.

You can place any number of the widgets into a panel of your own design. The diagram shows the widget as part of a color chooser dialog created by the fl_color_chooser() function. The Fl_Color_Chooser widget contains the hue box, value slider, and rgb input fields from the above diagram (it does not have the color chips or the Cancel or OK buttons). The callback is done every time the user changes the rgb value. It is not done if they move the hue control in a way that produces the same rgb value, such as when saturation or value is zero.

The fl_color_chooser() function pops up a window to let the user pick an arbitrary RGB color. They can pick the hue and saturation in the "hue box" on the left (hold down CTRL to just change the saturation), and the brightness using the vertical slider. Or they can type the 8-bit numbers into the RGB Fl_Value_Input fields, or drag the mouse across them to adjust them. The pull-down menu lets the user set the input fields to show RGB, HSV, or 8-bit RGB (0 to 255).

The user can press CTRL-C to copy the currently selected color value as text in RGB hex format with leading zeroes to the clipboard, for instance FL_GREEN would be '00FF00' (since FLTK 1.4.0).

fl_color_chooser() returns non-zero if the user picks ok, and updates the RGB values. If the user picks cancel or closes the window this returns zero and leaves RGB unchanged.

If you use the color chooser on an 8-bit screen, it will allocate all the available colors, leaving you no space to exactly represent the color the user picks! You can however use fl_rectf() to fill a region with a simulated color using dithering.

Callback reasons can be FL_REASON_DRAGGED, FL_REASON_CHANGED, or FL_REASON_RESELECTED.

Constructor & Destructor Documentation

Fl_Color_Chooser()

Fl_Color_Chooser::Fl_Color_Chooser	(	int	X,
		int	Y,
		int	W,
		int	H,
		const char *	L = 0
	)

Creates a new Fl_Color_Chooser widget using the given position, size, and label string.

The recommended dimensions are 200x95. The color is initialized to black.

Parameters

[in]	X,Y,W,H	position and size of the widget
[in]	L	widget label, default is no label

Member Function Documentation

b()

double Fl_Color_Chooser::b ( ) const

inline

Returns the current blue value.

0 <= b <= 1.

g()

double Fl_Color_Chooser::g ( ) const

inline

Returns the current green value.

0 <= g <= 1.

handle()

int Fl_Color_Chooser::handle ( int  e )

virtual

Handles all events received by this widget.

This specific handle() method processes the standard 'copy' function as seen in other input widgets. It copies the current color value to the clipboard as a string in RGB format ('RRGGBB').

This format is independent of the Fl_Color_Chooser display format setting. No other formats are supplied.

The keyboard events handled are:

• ctrl-c
• ctrl-x
• ctrl-Insert

All other events are processed by the parent class Fl_Group.

This enables the user to choose a color value, press ctrl-c to copy the value to the clipboard and paste it into a color selection widget in another application window or any other text input (e.g. a preferences dialog or an editor).

Note

Keyboard event handling by the current focus widget has priority, hence moving the focus to one of the buttons or selecting text in one of the input widgets effectively disables this special method.

Parameters

[in]

e

current event

Returns

1 if event has been handled, 0 otherwise

See also

Fl_Group::handle(int)

Reimplemented from Fl_Widget.

hsv()

int Fl_Color_Chooser::hsv	(	double	H,
		double	S,
		double	V
	)

Set the hsv values.

The passed values are clamped (or for hue, modulus 6 is used) to get legal values. Does not do the callback.

Parameters

[in]

H,S,V

color components.

Returns

1 if a new hsv value was set, 0 if the hsv value was the previous one.

hsv2rgb()

void Fl_Color_Chooser::hsv2rgb ( double  H, double  S, double  V, double &  R, double &  G, double &  B  )

static

This static method converts HSV colors to RGB colorspace.

Parameters

[in]	H,S,V	color components
[out]	R,G,B	color components

hue()

double Fl_Color_Chooser::hue ( ) const

inline

Returns the current hue.

0 <= hue < 6. Zero is red, one is yellow, two is green, etc. This value is convenient for the internal calculations - some other systems consider hue to run from zero to one, or from 0 to 360.

mode() [1/2]

int Fl_Color_Chooser::mode ( )

inline

Returns which Fl_Color_Chooser variant is currently active.

Returns

color modes are rgb(0), byte(1), hex(2), or hsv(3)

mode() [2/2]

void Fl_Color_Chooser::mode

(

int

newMode

)

Set which Fl_Color_Chooser variant is currently active.

Parameters

[in]

newMode

color modes are rgb(0), byte(1), hex(2), or hsv(3)

r()

double Fl_Color_Chooser::r ( ) const

inline

Returns the current red value.

0 <= r <= 1.

rgb()

int Fl_Color_Chooser::rgb	(	double	R,
		double	G,
		double	B
	)

Sets the current rgb color values.

Does not do the callback. Does not clamp (but out of range values will produce psychedelic effects in the hue selector).

Parameters

[in]

R,G,B

color components.

Returns

1 if a new rgb value was set, 0 if the rgb value was the previous one.

rgb2hsv()

void Fl_Color_Chooser::rgb2hsv ( double  R, double  G, double  B, double &  H, double &  S, double &  V  )

static

This static method converts RGB colors to HSV colorspace.

Parameters

[in]	R,G,B	color components
[out]	H,S,V	color components

saturation()

double Fl_Color_Chooser::saturation ( ) const

inline

Returns the saturation.

0 <= saturation <= 1.

value()

double Fl_Color_Chooser::value ( ) const

inline

Returns the value/brightness.

0 <= value <= 1.

---

The documentation for this class was generated from the following files:

• Fl_Color_Chooser.H
• Fl_Color_Chooser.cxx