A ComboBox descendant class to select RGB colors. More...

#include <ColorComboBox.h>

Inheritance diagram for pcl::ColorComboBox:

Public Types
using	color_event_handler = void(Control::*)(ColorComboBox &sender, RGBA color)

Public Types inherited from pcl::ComboBox
using	edit_event_handler = void(Control::*)(ComboBox &sender)

using	item_event_handler = void(Control::*)(ComboBox &sender, int itemIndex)

Public Types inherited from pcl::Control
using	child_event_handler = void(Control::*)(Control &sender, Control &child)

using	close_event_handler = void(Control::*)(Control &sender, bool &allowClose)

using	event_handler = void(Control::*)(Control &sender)

using	file_drag_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const StringList &files, unsigned modifiers, bool &wantsFiles)

using	file_drop_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const StringList &files, unsigned modifiers)

using	keyboard_event_handler = void(Control::*)(Control &sender, int key, unsigned modifiers, bool &wantsKey)

using	mouse_button_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, int button, unsigned buttons, unsigned modifiers)

using	mouse_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, unsigned buttons, unsigned modifiers)

using	mouse_wheel_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, int delta, unsigned buttons, unsigned modifiers)

using	move_event_handler = void(Control::*)(Control &sender, const pcl::Point &newPos, const pcl::Point &oldPos)

using	paint_event_handler = void(Control::*)(Control &sender, const pcl::Rect &updateRect)

using	resize_event_handler = void(Control::*)(Control &sender, int newWidth, int newHeight, int oldWidth, int oldHeight)

using	view_drag_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const View &view, unsigned modifiers, bool &wantsView)

using	view_drop_event_handler = void(Control::*)(Control &sender, const pcl::Point &pos, const View &view, unsigned modifiers)

Public Member Functions
	ColorComboBox (Control &parent=Control::Null())

	~ColorComboBox () override

RGBA	CurrentColor () const

RGBA	CustomColor () const

bool	HasCustomColor () const

void	OnColorHighlighted (color_event_handler handler, Control &receiver)

void	OnColorSelected (color_event_handler handler, Control &receiver)

void	OnCustomColorDefined (color_event_handler handler, Control &receiver)

void	SetCurrentColor (RGBA color)

Public Member Functions inherited from pcl::ComboBox
	ComboBox (Control &parent=Control::Null())

	~ComboBox () override

void	AddItem (const String &text, const Bitmap &icon=Bitmap::Null())

template<class C >
void	AddItems (const C &c)

template<class FI >
void	AddItems (FI i, FI j)

void	Clear ()

void	ClearEditText ()

void	ClearItemIcon (int index)

void	ClearItemText (int index)

int	CurrentItem () const

void	DisableAutoCompletion (bool disable=true)

void	DisableEdit (bool disable=true)

String	EditText () const

void	EnableAutoCompletion (bool=true)

void	EnableEdit (bool=true)

int	FindItem (const String &text, int fromIdx=0, bool exactMatch=false, bool caseSensitive=false) const

void	GetIconSize (int &width, int &height) const

void	GetScaledIconSize (int &width, int &height) const

void	HideList ()

int	IconHeight () const

int	IconWidth () const

void	InsertItem (int index, const String &text, const Bitmap &icon=Bitmap::Null())

template<class C >
void	InsertItems (int index, const C &c)

template<class FI >
void	InsertItems (int index, FI i, FI j)

bool	IsAutoCompletionEnabled () const

bool	IsEditEnabled () const

Bitmap	ItemIcon (int index) const

String	ItemText (int index) const

int	MaxVisibleItemCount () const

int	MinItemCharWidth () const

int	NumberOfItems () const

void	OnEditTextUpdated (edit_event_handler handler, Control &receiver)

void	OnItemHighlighted (item_event_handler handler, Control &receiver)

void	OnItemSelected (item_event_handler handler, Control &receiver)

void	RemoveItem (int index)

int	ScaledIconHeight () const

int	ScaledIconWidth () const

void	SetCurrentItem (int index)

void	SetEditText (const String &)

void	SetIconSize (int size)

void	SetIconSize (int width, int height)

void	SetItemIcon (int index, const Bitmap &)

void	SetItemText (int index, const String &)

void	SetMaxVisibleItemCount (int)

void	SetMinItemCharWidth (int)

void	SetScaledIconSize (int size)

void	SetScaledIconSize (int width, int height)

void	ShowList ()

Public Member Functions inherited from pcl::Control
	Control (const Control &)=delete

	Control (Control &&)=delete

	Control (Control &parent=Null(), uint32=0)

	~Control () override

void	ActivateRealTimePreview ()

void	ActivateTrackView ()

void	ActivateWindow ()

void	AdjustToContents ()

RGBA	AlternateCanvasColor () const

RGBA	BackgroundColor () const

pcl::Rect	BoundsRect () const

void	BringToFront ()

RGBA	ButtonColor () const

RGBA	ButtonTextColor () const

bool	CanUpdate () const

RGBA	CanvasColor ()

Control &	ChildByPos (const pcl::Point &p) const

Control &	ChildByPos (int x, int y) const

pcl::Rect	ChildrenRect () const

Control &	ChildToFocus () const

void	ClearInfoText ()

int	ClientHeight () const

pcl::Rect	ClientRect () const

int	ClientWidth () const

void	ControlToLocal (const Control &, int &x, int &y) const

pcl::Point	ControlToLocal (const Control &w, const pcl::Point &p) const

pcl::Cursor	Cursor () const

void	DeactivateRealTimePreview ()

void	DeactivateTrackView ()

void	Disable (bool disabled=true)

void	DisableExpansion (bool horzDisable=true, bool vertDisable=true)

void	DisableMouseTracking (bool disable=true)

void	DisableUpdates (bool disable=true)

double	DisplayPixelRatio () const

virtual void	Enable (bool enabled=true)

void	EnableExpansion (bool horzEnable=true, bool vertEnable=true)

void	EnableMouseTracking (bool=true)

void	EnableUpdates (bool enable=true)

void	EnsureLayoutUpdated ()

void	EnsureUnique () override

void	Focus (bool focus=true)

Control &	FocusedChild () const

FocusStyles	FocusStyle () const

pcl::Font	Font () const

RGBA	ForegroundColor () const

int	FrameHeight () const

pcl::Rect	FrameRect () const

int	FrameWidth () const

pcl::Cursor	GetCursor () const

pcl::Font	GetFont () const

void	GetMaxSize (int &w, int &h) const

void	GetMinSize (int &w, int &h) const

void	GetScaledMaxSize (int &w, int &h) const

void	GetScaledMinSize (int &w, int &h) const

pcl::Sizer	GetSizer () const

pcl::Point	GlobalToLocal (const pcl::Point &p) const

void	GlobalToLocal (int &x, int &y) const

int	Height () const

void	Hide ()

RGBA	HighlightColor () const

RGBA	HighlightedTextColor () const

String	InfoText () const

bool	IsActiveWindow () const

bool	IsAncestorOf (const Control &) const

virtual bool	IsEnabled () const

bool	IsFixedHeight () const

bool	IsFixedWidth () const

bool	IsFocused () const

bool	IsHidden () const

bool	IsHorizontalExpansionEnabled () const

bool	IsMaximized () const

bool	IsMinimized () const

bool	IsModal () const

bool	IsMouseTrackingEnabled () const

bool	IsRealTimePreviewActive () const

bool	IsTrackViewActive () const

bool	IsUnderMouse () const

bool	IsVerticalExpansionEnabled () const

bool	IsVisible () const

bool	IsWindow () const

void	LocalToControl (const Control &, int &x, int &y) const

pcl::Point	LocalToControl (const Control &w, const pcl::Point &p) const

pcl::Point	LocalToGlobal (const pcl::Point &p) const

void	LocalToGlobal (int &x, int &y) const

pcl::Point	LocalToParent (const pcl::Point &p) const

void	LocalToParent (int &x, int &y) const

int	LogicalPixelsToPhysical (int size) const

int	LogicalPixelsToResource (int size) const

int	MaxHeight () const

int	MaxWidth () const

int	MinHeight () const

int	MinWidth () const

void	Move (const pcl::Point &p)

void	Move (int x, int y)

Control &	NextSiblingToFocus () const

void	OnChildCreate (child_event_handler, Control &)

void	OnChildDestroy (child_event_handler, Control &)

void	OnClose (close_event_handler, Control &)

void	OnDestroy (event_handler, Control &)

void	OnEnter (event_handler, Control &)

void	OnFileDrag (file_drag_event_handler, Control &)

void	OnFileDrop (file_drop_event_handler, Control &)

void	OnGetFocus (event_handler, Control &)

void	OnHide (event_handler, Control &)

void	OnKeyPress (keyboard_event_handler, Control &)

void	OnKeyRelease (keyboard_event_handler, Control &)

void	OnLeave (event_handler, Control &)

void	OnLoseFocus (event_handler, Control &)

void	OnMouseDoubleClick (mouse_event_handler, Control &)

void	OnMouseMove (mouse_event_handler, Control &)

void	OnMousePress (mouse_button_event_handler, Control &)

void	OnMouseRelease (mouse_button_event_handler, Control &)

void	OnMouseWheel (mouse_wheel_event_handler, Control &)

void	OnMove (move_event_handler, Control &)

void	OnPaint (paint_event_handler, Control &)

void	OnResize (resize_event_handler, Control &)

void	OnShow (event_handler, Control &)

void	OnViewDrag (view_drag_event_handler, Control &)

void	OnViewDrop (view_drop_event_handler, Control &)

Control &	operator= (const Control &)=delete

Control &	operator= (Control &&)=delete

Control &	Parent () const

pcl::Point	ParentToLocal (const pcl::Point &p) const

void	ParentToLocal (int &x, int &y) const

int	PhysicalPixelsToLogical (int size) const

pcl::Point	Position () const

void	Repaint ()

void	Repaint (const pcl::Rect &r)

void	Repaint (int x0, int y0, int x1, int y1)

void	Resize (int w, int h)

double	ResourcePixelRatio () const

int	ResourcePixelsToLogical (int size) const

void	Restyle ()

Point	ScaledCursorHotSpot (const Point &hotSpot) const

Point	ScaledCursorHotSpot (int xHot, int yHot) const

int	ScaledMaxHeight () const

int	ScaledMaxWidth () const

int	ScaledMinHeight () const

int	ScaledMinWidth () const

template<class R >
String	ScaledResource (R resource) const

template<class S >
String	ScaledStyleSheet (S cssCode, int fontDPI=0) const

void	Scroll (const pcl::Point &d)

void	Scroll (const pcl::Point &d, const pcl::Rect &r)

void	Scroll (int dx, int dy)

void	Scroll (int dx, int dy, int x0, int y0, int x1, int y1)

void	SendToBack ()

void	SetAlternateCanvasColor (RGBA)

void	SetBackgroundColor (RGBA)

void	SetButtonColor (RGBA)

void	SetButtonTextColor (RGBA)

void	SetCanvasColor (RGBA)

void	SetChildToFocus (Control &)

void	SetClientRect (const pcl::Rect &r)

void	SetClientRect (int x0, int y0, int x1, int y1)

void	SetCursor (const pcl::Cursor &)

void	SetCursorToParent ()

void	SetFixedHeight ()

void	SetFixedHeight (int h)

void	SetFixedSize ()

void	SetFixedSize (int w, int h)

void	SetFixedWidth ()

void	SetFixedWidth (int w)

void	SetFocusStyle (FocusStyles)

void	SetFont (const pcl::Font &)

void	SetForegroundColor (RGBA)

void	SetHighlightColor (RGBA)

void	SetHighlightedTextColor (RGBA)

void	SetInfoText (const String &)

void	SetMaxHeight ()

void	SetMaxHeight (int h)

void	SetMaxSize ()

void	SetMaxSize (int w, int h)

void	SetMaxWidth ()

void	SetMaxWidth (int w)

void	SetMinHeight ()

void	SetMinHeight (int h)

void	SetMinSize ()

void	SetMinSize (int w, int h)

void	SetMinWidth ()

void	SetMinWidth (int w)

void	SetNextSiblingToFocus (Control &)

void	SetParent (Control &)

void	SetRealTimePreviewActive (bool=true)

void	SetScaledFixedHeight (int h)

void	SetScaledFixedSize (int w, int h)

void	SetScaledFixedWidth (int w)

void	SetScaledMaxHeight (int h)

void	SetScaledMaxSize (int w, int h)

void	SetScaledMaxWidth (int w)

void	SetScaledMinHeight (int h)

void	SetScaledMinSize (int w, int h)

void	SetScaledMinWidth (int w)

void	SetSizer (pcl::Sizer &)

void	SetStyleSheet (const String &css)

void	SetTextColor (RGBA)

void	SetToolTip (const String &)

void	SetTrackViewActive (bool=true)

void	SetVariableHeight ()

void	SetVariableSize ()

void	SetVariableWidth ()

void	SetVisible (bool visible)

void	SetWindowOpacity (double)

void	SetWindowTitle (const String &)

void	Show ()

pcl::Sizer	Sizer () const

void	StackUnder (Control &)

String	StyleSheet () const

RGBA	TextColor () const

String	ToolTip () const

void	Unfocus ()

void	Update ()

void	Update (const pcl::Rect &r)

void	Update (int x0, int y0, int x1, int y1)

pcl::Rect	VisibleRect () const

int	Width () const

Control &	Window () const

double	WindowOpacity () const

String	WindowTitle () const

int	X () const

int	Y () const

Public Member Functions inherited from pcl::UIObject
virtual	~UIObject () noexcept(false)

bool	IsAlias () const

bool	IsGarbage () const

bool	IsNull () const

bool	IsSameObject (const UIObject &o) const

bool	IsUnique () const

String	ObjectId () const

IsoString	ObjectType () const

bool	operator< (const UIObject &o) const

bool	operator== (const UIObject &o) const

size_type	RefCount () const

void	SetObjectId (const String &id)

Additional Inherited Members
Static Public Member Functions inherited from pcl::Control
static void	HideToolTip ()

static Control &	Null ()

static void	ShowToolTip (const Point &pos, const String &text, const Control &control=Control::Null(), const Rect &rect=Rect(0))

static void	ShowToolTip (int x, int y, const String &text, const Control &control=Control::Null(), const Rect &rect=Rect(0))

static String	ToolTipText ()

Static Public Member Functions inherited from pcl::UIObject
static UIObject &	Null ()

Protected Member Functions inherited from pcl::UIObject
	UIObject ()=default

	UIObject (const UIObject &x)

	UIObject (UIObject &&x)

UIObject &	operator= (const UIObject &x)

UIObject &	operator= (UIObject &&x)

Detailed Description

ColorComboBox is a utility class that provides a simple list with the full set of CSS3 standard colors. This includes 143 ComboBox items that are automatically shared by all existing ColorComboBox instances. Thanks to this implicit sharing mechanism, a module can define a large number of ColorComboBox controls without consuming too much resources on any supported platform.

The list of items corresponding to CSS3 colors is sorted by hue value (in the HSV or HSI color ordering systems). This makes it much easier the task of selecting colors since similar hues are grouped visually.

In addition to CSS3 standard colors, a single custom color item can be defined for a ColorComboBox object. The custom color item is automatically managed by ColorComboBox and appended to the end of standard items.

See also: pcl/Color.h, ComboBox

Definition at line 91 of file ColorComboBox.h.

Constructor & Destructor Documentation

◆ ColorComboBox()

pcl::ColorComboBox::ColorComboBox ( Control & parent = Control::Null() )

Constructs a ColorComboBox as a child control of parent.

A standard set of ComboBox items is created for the full set of CSS3 colors. This includes 143 color items.

◆ ~ColorComboBox()

pcl::ColorComboBox::~ColorComboBox ( )

inlineoverride

Destroys a ColorComboBox control.

Definition at line 106 of file ColorComboBox.h.

Member Function Documentation

◆ CurrentColor()

RGBA pcl::ColorComboBox::CurrentColor ( ) const

Returns the RGB color value that corresponds to the currently selected ComboBox item, or zero if no item is currently selected.

See also: SetCurrentColor(), CustomColor(), HasCustomColor()

◆ CustomColor()

RGBA pcl::ColorComboBox::CustomColor ( ) const

inline

Returns the current custom color in this ColorComboBox, or zero if no custom color has been defined.

To set a new custom color, call SetCurrentColor() with the desired custom color value.

See also: HasCustomColor(), CurrentColor(), SetCurrentColor()

Definition at line 141 of file ColorComboBox.h.

◆ HasCustomColor()

bool pcl::ColorComboBox::HasCustomColor ( ) const

inline

Returns true iff a custom color item has been defined in this ColorComboBox control.

This is a convenience member function, equivalent to: CustomColor() != 0.

See also: CustomColor(), CurrentColor(), SetCurrentColor()

Definition at line 155 of file ColorComboBox.h.

◆ SetCurrentColor()

void pcl::ColorComboBox::SetCurrentColor ( RGBA color )

Selects a ComboBox item corresponding to the specified color.

If the specified color doesn't correspond to a standard CSS color, it replaces the existing custom color item in this ColorComboBox, or a new one is created if there is no custom color item yet.

Note: The alpha (transparency) component of the specified color is always ignored. ColorComboBox only includes opaque colors (alpha=0xff).

See also: CurrentColor(), CustomColor(), HasCustomColor()

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

ColorComboBox.h

Public Types

Public Member Functions

Additional Inherited Members