Class for color well widgets, which form a clickable square area that represents a color. More...

#include <hdicoreColorWell.h>

Inheritance diagram for hdi::core::ColorWell:

Collaboration diagram for hdi::core::ColorWell:

Public Member Functions
	ColorWell ()
	Constructs an empty ColorWell object.
	ColorWell (const ColorWell &colorwell_)
	Constructs a new ColorWell object from an existing ColorWell object (copy constructor).
	ColorWell (const Rect &frame_, const PluginColor &color_)
	Constructs a color well.
virtual	~ColorWell ()
	ColorWell destructor.
virtual ColorWell &	operator= (const ColorWell &rhs_)
	Allows one ColorWell object to be assigned from another.
virtual ColorWell *	clone () const
	Convenience method to clone a ColorWell object on the heap.
virtual ColorWell *	duplicate () const
	Convenience method to duplicate a ColorWell object, creating a new and identical UI element to the target (but not belonging to the same containing window).
virtual PluginColor	currentColor () const
	Gets the current value of the color well.
virtual void	setCurrentColor (const PluginColor &color_)
	Sets the current value of the color well.
virtual void	valueChanged ()
	Simulates the color well having its value changed.
virtual Callback *const	valueChangedCallback () const
	Gets the value changed callback for the color well.
virtual void	setValueChangedCallback (const Callback &callback_)
	Sets the value changed callback.
Public Member Functions inherited from hdi::core::Widget
virtual	~Widget ()
	Destructs a Widget.
virtual PlatformWidgetPtr	platformWidget () const
	Gets the platform-specific widget, around which the target object is wrapped.
virtual bool	isEmpty () const
	Gets whether the target Widget object is empty (constructed with the default ctor).
virtual bool	operator== (const Widget &rhs_) const
	Tests whether a given Widget object is the same as another.
virtual bool	operator!= (const Widget &rhs_) const
	Tests whether a given Widget object is not the same as another.
virtual Type	type () const
	Gets the type of the widget.
virtual Window *const	window () const
	Gets the parent window of the widget.
virtual Rect	frame () const
	Gets the widget frame.
virtual void	setFrame (const Rect &frame_)
	Sets the widget frame.
virtual void	offset (const double x_, const double y_)
	Offsets the widget from its current location by the given amounts, in 1x resolution coordinates.
virtual std::string	text () const
	Gets the current text value of the widget.
virtual void	setText (const std::string &text_)
	Sets the current text value of the widget.
virtual bool	enabled ()
	Gets whether the widget is enabled.
virtual void	setEnabled (const bool enable_)
	Enables or disables the widget.
virtual bool	visible ()
	Gets whether the widget is visible.
virtual void	setVisible (const bool visible_)
	Shows or hides the widget.
virtual void	setOrigin (const Point &p_)
	Convenience method to set just the origin of the target widget's frame.
virtual void	setSize (const Size &s_)
	Convenience method to set just the size of the target widget's frame.
virtual void	setWidth (const double w_)
	Convenience method to set just the width of the target widget's frame.
virtual void	setHeight (const double h_)
	Convenience method to set just the height of the target widget's frame.
virtual bool	hasFocus () const
	Gets whether the widget currently has focus.
virtual void	focus () const
	Forces the widget to have focus, taking it from any other focused widget of the same window.
virtual Callback *const	focusCallback () const
	Gets the current focus callback for the widget.
virtual void	setFocusCallback (const Callback &callback_)
	Sets the focus callback for the widget.
virtual void	blur () const
	Removes focus from the widget.
virtual Callback *const	blurCallback () const
	Gets the current blur callback for the widget.
virtual void	setBlurCallback (const Callback &callback_)
	Sets the blur callback for the widget.
virtual std::string	tooltip () const
	Gets the tool tip string for the widget.
virtual void	setTooltip (const std::string &tip_)
	Sets the tool tip string for the widget.
virtual void	update ()
	Force the widget to update (i.e. cause it to redraw).

Static Public Member Functions
static bool	showColorPicker (const PluginColor &inColor_, PluginColor &outColor__)
	Shows a color picker and provides the chosen color, unless the user canceled.
static bool	colorPickerShowing ()
	Gets whether any color picker dialog is currently showing due to a color well being clicked or the showColorPicker() method being called.
Static Public Member Functions inherited from hdi::core::Widget
static bool	isCoreWidget (const PlatformWidgetPtr widget_)
	Gets whether the given platform widget is a hdi_core widget.
static std::unique_ptr< Widget >	lastClickedWidget ()
	Gets the last widget that received a click event (either by the user or programmatically).
static std::unique_ptr< Widget >	lastValueChangingWidget ()
	Gets the last widget that received a value changing event (either by the user or programmatically).
static std::unique_ptr< Widget >	lastValueChangedWidget ()
	Gets the last widget that received a value changed event (either by the user or programmatically).
static std::unique_ptr< Widget >	lastDropWidget ()
	Gets the last widget that received a drag-and-drop drop event (either by the user or programmatically).
static std::unique_ptr< Widget >	lastPotentialReorderWidget ()
	Gets the last widget that received a potential-reorder event.
static std::unique_ptr< Widget >	lastReorderWidget ()
	Gets the last widget that received a reorder event.

Additional Inherited Members
Public Types inherited from hdi::core::Widget
enum	Type { UnknownType = 0 , BoxType = 10 , ButtonType = 20 , CheckboxType = 30 , ColumnViewType = 40 , ComboBoxType = 50 , ColorWellType = 60 , CustomType = 70 , DividerType = 80 , HierarchicalColumnViewType = 85 , HierarchicalViewType = 90 , LabelType = 100 , ListViewType = 110 , PopupMenuType = 120 , RadioButtonType = 130 , SliderType = 140 , StepperType = 150 , TextFieldType = 160 , TextViewType = 170 , WebViewType = 180 }
	Supported widget types.
Protected Member Functions inherited from hdi::core::Widget
void *	_impl () const
	Internal use only.
	Widget ()
	Constructs an empty Widget object.
	Widget (const Widget &w_)
	Constructs a new Widget object from an existing Widget object (copy constructor).
	Widget (pui::Widget *&)
	Internal use only.
virtual Widget &	operator= (const Widget &)
	Internal use only.
Protected Attributes inherited from hdi::core::Widget
void *	_data
	Private implementation data.

Detailed Description

Class for color well widgets, which form a clickable square area that represents a color.

Constructor & Destructor Documentation

◆ ColorWell() [1/3]

hdi::core::ColorWell::ColorWell ( )

Constructs an empty ColorWell object.

Author: GW

Date: 09/2013

Note: To test if a ColorWell object is empty, call isEmpty() on it; Empty ColorWell objects do not relate to any actual UI widget; they are designed to be "receivers" of some other ColorWell object via the overloaded assignment operator. Empty ColorWell objects are useless until such time (though it is safe to call any of their methods).

◆ ColorWell() [2/3]

hdi::core::ColorWell::ColorWell ( const ColorWell & colorwell_ )

Constructs a new ColorWell object from an existing ColorWell object (copy constructor).

Author: GW

Date: 09/2013

Parameters

colorwell_ Existing ColorWell object

◆ ColorWell() [3/3]

hdi::core::ColorWell::ColorWell	(	const Rect &	frame_,
		const PluginColor &	color_ )

Constructs a color well.

Author: GW

Date: 09/2013

Parameters

frame_	Dimensions and top-left location of the color well, in 1x resolution coordinates
color_	Initial value of the color well

Note: The type of color with which a ColorWell is "seeded" (the color it has before the color picker is shown) will affect the type of color that is reported by the currentColor() method (e.g. in a value-changed callback). It is recommended that you set the current color of a color well with a color whose type matches that of the current document's color model.

◆ ~ColorWell()

virtual hdi::core::ColorWell::~ColorWell ( )

virtual

ColorWell destructor.

Author: GW

Date: 09/2013

Member Function Documentation

◆ clone()

virtual ColorWell * hdi::core::ColorWell::clone ( ) const

virtual

Convenience method to clone a ColorWell object on the heap.

Author: GW

Date: 10/2013

Returns: A pointer to the new ColorWell object

Note: If you subclass ColorWell, you MUST overload this method yourself! If you don't and/or your clone() method does not return an instance of your ColorWell subclass, you will experience "object slicing" when adding the widget to a window.

Warning: The caller must manage the memory for the returned ColorWell object.

Implements hdi::core::Widget.

◆ colorPickerShowing()

bool hdi::core::ColorWell::colorPickerShowing ( )

static

Gets whether any color picker dialog is currently showing due to a color well being clicked or the showColorPicker() method being called.

Author: GW

Date: 12/2015

Returns: true for color picker dialog showing, false otherwise

◆ currentColor()

virtual PluginColor hdi::core::ColorWell::currentColor ( ) const

virtual

Gets the current value of the color well.

Author: GW

Date: 09/2013

Returns: An ArtColor object representing the current color of the color well

◆ duplicate()

virtual ColorWell * hdi::core::ColorWell::duplicate ( ) const

virtual

Convenience method to duplicate a ColorWell object, creating a new and identical UI element to the target (but not belonging to the same containing window).

Author: GW

Date: 11/2013

Returns: A pointer to the new ColorWell object (and new UI element)

Warning: The caller must manage the memory for the returned ColorWell object.

Implements hdi::core::Widget.

◆ operator=()

virtual ColorWell & hdi::core::ColorWell::operator= ( const ColorWell & rhs_ )

virtual

Allows one ColorWell object to be assigned from another.

Author: GW

Date: 10/2013

Parameters

rhs_	Righthand side of the = operator; the object to copy values from

Returns: The target ColorWell object, but with its value updated to match that of rhs_

◆ setCurrentColor()

virtual void hdi::core::ColorWell::setCurrentColor ( const PluginColor & color_ )

virtual

Sets the current value of the color well.

Author: GW

Date: 09/2013

Parameters

color_ New color values for the color well

Note: The type of color with which a ColorWell is "seeded" (the color it has before the color picker is shown) will affect the type of color that is reported by the currentColor() method (e.g. in a value-changed callback). It is recommended that you set the current color of a color well with a color whose type matches that of the current document's color model.

◆ setValueChangedCallback()

virtual void hdi::core::ColorWell::setValueChangedCallback ( const Callback & callback_ )

virtual

Sets the value changed callback.

Author: GW

Date: 09/2013

Parameters

callback_ New callback for when the color well's value has changed

◆ showColorPicker()

bool hdi::core::ColorWell::showColorPicker	(	const PluginColor &	inColor_,
		PluginColor &	outColor__ )

static

Shows a color picker and provides the chosen color, unless the user canceled.

Author: GW

Date: 01/2025

Parameters

inColor_	The initial color to display in the picker
outColor__	Return-by-refence for the color chosen by the user

Returns: true if a color was chosen, false otherwise; ignore the color__ param value if false is returned

◆ valueChanged()

virtual void hdi::core::ColorWell::valueChanged ( )

virtual

Simulates the color well having its value changed.

Author: GW

Date: 09/2013

◆ valueChangedCallback()

virtual Callback *const hdi::core::ColorWell::valueChangedCallback ( ) const

virtual

Gets the value changed callback for the color well.

Author: GW

Date: 09/2013

Returns: A pointer to the currently registered value changed callback

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ColorWell() [1/3]

◆ ColorWell() [2/3]

◆ ColorWell() [3/3]

◆ ~ColorWell()

Member Function Documentation

◆ clone()

◆ colorPickerShowing()

◆ currentColor()

◆ duplicate()

◆ operator=()

◆ setCurrentColor()

◆ setValueChangedCallback()

◆ showColorPicker()

◆ valueChanged()

◆ valueChangedCallback()