KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
COLOR_SWATCH Class Reference

A simple color swatch of the kind used to set layer colors. More...

#include <color_swatch.h>

Inheritance diagram for COLOR_SWATCH:

Public Member Functions

 COLOR_SWATCH (wxWindow *aParent, const KIGFX::COLOR4D &aColor, int aID, const KIGFX::COLOR4D &aBackground, const KIGFX::COLOR4D &aDefault, SWATCH_SIZE aSwatchType, bool aTriggerWithSingleClick=false)
 Construct a COLOR_SWATCH. More...
 
 COLOR_SWATCH (wxWindow *aParent, wxWindowID aId, const wxPoint &aPos=wxDefaultPosition, const wxSize &aSize=wxDefaultSize, long aStyle=0)
 constructor for wxFormBuilder More...
 
void SetSwatchColor (const KIGFX::COLOR4D &aColor, bool aSendEvent)
 Set the current swatch color directly. More...
 
void SetDefaultColor (const KIGFX::COLOR4D &aColor)
 Sets the color that will be chosen with the "Reset to Default" button in the chooser. More...
 
void SetSwatchBackground (const KIGFX::COLOR4D &aBackground)
 Set the swatch background color. More...
 
void SetUserColors (CUSTOM_COLORS_LIST *aUserColors)
 Fetch a reference to the user colors list. More...
 
KIGFX::COLOR4D GetSwatchColor () const
 
void SetWindowID (wxWindowID aId)
 Updates the window ID of this control and its children. More...
 
void GetNewSwatchColor ()
 Prompt for a new colour, using the colour picker dialog. More...
 
void SetReadOnly (bool aReadOnly=true)
 
bool IsReadOnly () const
 
void SetSupportsOpacity (bool aSupportsOpacity)
 
void SetReadOnlyCallback (std::function< void()> aCallback)
 Registers a handler for when the user tries to interact with a read-only swatch. More...
 
void OnDarkModeToggle ()
 Respond to a change in the OS's DarkMode setting. More...
 

Static Public Member Functions

static wxBitmap MakeBitmap (const KIGFX::COLOR4D &aColor, const KIGFX::COLOR4D &aBackground, const wxSize &aSize, const wxSize &aCheckerboardSize, const KIGFX::COLOR4D &aCheckerboardBackground)
 
static void RenderToDC (wxDC *aDC, const KIGFX::COLOR4D &aColor, const KIGFX::COLOR4D &aBackground, const wxRect &aRect, const wxSize &aCheckerboardSize, const KIGFX::COLOR4D &aCheckerboardBackground)
 

Private Member Functions

void setupEvents (bool aTriggerWithSingleClick)
 
void rePostEvent (wxEvent &aEvent)
 Pass unwanted events on to listeners of this object. More...
 

Private Attributes

KIGFX::COLOR4D m_color
 
KIGFX::COLOR4D m_background
 
KIGFX::COLOR4D m_default
 
CUSTOM_COLORS_LIST * m_userColors
 
wxStaticBitmap * m_swatch
 
wxSize m_size
 
wxSize m_checkerboardSize
 
KIGFX::COLOR4D m_checkerboardBg
 
bool m_readOnly
 A read-only swatch won't show the color chooser dialog but otherwise works normally. More...
 
std::function< void()> m_readOnlyCallback
 
bool m_supportsOpacity
 If opacity is not supported the color chooser dialog will be displayed without it. More...
 

Detailed Description

A simple color swatch of the kind used to set layer colors.

Definition at line 56 of file color_swatch.h.

Constructor & Destructor Documentation

◆ COLOR_SWATCH() [1/2]

COLOR_SWATCH::COLOR_SWATCH ( wxWindow *  aParent,
const KIGFX::COLOR4D &  aColor,
int  aID,
const KIGFX::COLOR4D &  aBackground,
const KIGFX::COLOR4D &  aDefault,
SWATCH_SIZE  aSwatchType,
bool  aTriggerWithSingleClick = false 
)

Construct a COLOR_SWATCH.

Parameters
aParentparent window
aColorinitial swatch color
aIDid to use when sending swatch events

Definition at line 107 of file color_swatch.cpp.

References CHECKERBOARD_SIZE_DU(), DPI_SCALING_COMMON::GetContentScaleFactor(), m_checkerboardBg, m_checkerboardSize, m_size, m_swatch, MakeBitmap(), setupEvents(), SWATCH_EXPAND, SWATCH_LARGE, SWATCH_MEDIUM, SWATCH_SIZE_LARGE_DU(), SWATCH_SIZE_MEDIUM_DU(), SWATCH_SIZE_SMALL_DU(), and SWATCH_SMALL.

◆ COLOR_SWATCH() [2/2]

COLOR_SWATCH::COLOR_SWATCH ( wxWindow *  aParent,
wxWindowID  aId,
const wxPoint &  aPos = wxDefaultPosition,
const wxSize &  aSize = wxDefaultSize,
long  aStyle = 0 
)

constructor for wxFormBuilder

Definition at line 154 of file color_swatch.cpp.

References CHECKERBOARD_SIZE_DU(), m_checkerboardBg, m_checkerboardSize, m_size, m_swatch, MakeBitmap(), setupEvents(), and SWATCH_SIZE_MEDIUM_DU().

Member Function Documentation

◆ GetNewSwatchColor()

void COLOR_SWATCH::GetNewSwatchColor ( )

Prompt for a new colour, using the colour picker dialog.

A colour change event will be sent if it's set.

Definition at line 278 of file color_swatch.cpp.

References DIALOG_COLOR_PICKER::GetColor(), m_background, m_checkerboardBg, m_checkerboardSize, m_color, m_default, m_readOnly, m_readOnlyCallback, m_size, m_supportsOpacity, m_swatch, m_userColors, MakeBitmap(), and sendSwatchChangeEvent().

Referenced by DIALOG_LIB_SHAPE_PROPERTIES::onFill(), APPEARANCE_CONTROLS::onNetclassContextMenu(), LAYER_WIDGET::OnRightDownRender(), and setupEvents().

◆ GetSwatchColor()

COLOR4D COLOR_SWATCH::GetSwatchColor ( ) const
Returns
the current swatch color

Definition at line 272 of file color_swatch.cpp.

References m_color.

Referenced by PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DIALOG_LIB_SHAPE_PROPERTIES::onBorderSwatch(), PANEL_COLOR_SETTINGS::OnColorChanged(), APPEARANCE_CONTROLS_3D::onColorSwatchChanged(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), LAYER_WIDGET::OnLayerSwatchChanged(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), LAYER_WIDGET::OnRenderSwatchChanged(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PANEL_3D_OPENGL_OPTIONS::TransferDataFromWindow(), PANEL_3D_RAYTRACING_OPTIONS::TransferDataFromWindow(), DIALOG_FIELD_PROPERTIES::TransferDataFromWindow(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_LINE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_WIRE_BUS_PROPERTIES::TransferDataFromWindow(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataFromWindow(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsReadOnly()

bool COLOR_SWATCH::IsReadOnly ( ) const
inline

Definition at line 120 of file color_swatch.h.

References m_readOnly.

◆ MakeBitmap()

wxBitmap COLOR_SWATCH::MakeBitmap ( const KIGFX::COLOR4D &  aColor,
const KIGFX::COLOR4D &  aBackground,
const wxSize &  aSize,
const wxSize &  aCheckerboardSize,
const KIGFX::COLOR4D &  aCheckerboardBackground 
)
static

Definition at line 36 of file color_swatch.cpp.

References RenderToDC().

Referenced by COLOR_SWATCH(), GRID_CELL_COLOR_RENDERER::Draw(), GetNewSwatchColor(), DIALOG_COLOR_PICKER::initDefinedColors(), OnDarkModeToggle(), SetSwatchBackground(), SetSwatchColor(), ZONE_SETTINGS::SetupLayersList(), and DIALOG_COLOR_PICKER::updatePreview().

◆ OnDarkModeToggle()

void COLOR_SWATCH::OnDarkModeToggle ( )

Respond to a change in the OS's DarkMode setting.

Definition at line 309 of file color_swatch.cpp.

References m_background, m_checkerboardBg, m_checkerboardSize, m_color, m_size, m_swatch, and MakeBitmap().

◆ RenderToDC()

void COLOR_SWATCH::RenderToDC ( wxDC *  aDC,
const KIGFX::COLOR4D &  aColor,
const KIGFX::COLOR4D &  aBackground,
const wxRect &  aRect,
const wxSize &  aCheckerboardSize,
const KIGFX::COLOR4D &  aCheckerboardBackground 
)
static

Definition at line 51 of file color_swatch.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::Brightened(), KIGFX::COLOR4D::Darkened(), KIGFX::COLOR4D::GetBrightness(), and KIGFX::COLOR4D::ToColour().

Referenced by MakeBitmap(), and PG_CELL_RENDERER::Render().

◆ rePostEvent()

void COLOR_SWATCH::rePostEvent ( wxEvent &  aEvent)
private

Pass unwanted events on to listeners of this object.

Definition at line 228 of file color_swatch.cpp.

Referenced by setupEvents().

◆ SetDefaultColor()

void COLOR_SWATCH::SetDefaultColor ( const KIGFX::COLOR4D &  aColor)

Sets the color that will be chosen with the "Reset to Default" button in the chooser.

Definition at line 258 of file color_swatch.cpp.

References m_default.

Referenced by DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), PANEL_3D_OPENGL_OPTIONS::PANEL_3D_OPENGL_OPTIONS(), PANEL_EESCHEMA_EDITING_OPTIONS::PANEL_EESCHEMA_EDITING_OPTIONS(), PROPERTIES_FRAME::PROPERTIES_FRAME(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ SetReadOnly()

void COLOR_SWATCH::SetReadOnly ( bool  aReadOnly = true)
inline

Definition at line 119 of file color_swatch.h.

References m_readOnly.

Referenced by APPEARANCE_CONTROLS::rebuildLayers().

◆ SetReadOnlyCallback()

void COLOR_SWATCH::SetReadOnlyCallback ( std::function< void()>  aCallback)
inline

Registers a handler for when the user tries to interact with a read-only swatch.

Definition at line 125 of file color_swatch.h.

References m_readOnlyCallback.

Referenced by APPEARANCE_CONTROLS::rebuildLayers(), and APPEARANCE_CONTROLS::rebuildObjects().

◆ SetSupportsOpacity()

void COLOR_SWATCH::SetSupportsOpacity ( bool  aSupportsOpacity)
inline

Definition at line 122 of file color_swatch.h.

References m_supportsOpacity.

Referenced by PANEL_3D_OPENGL_OPTIONS::PANEL_3D_OPENGL_OPTIONS().

◆ SetSwatchBackground()

void COLOR_SWATCH::SetSwatchBackground ( const KIGFX::COLOR4D &  aBackground)

Set the swatch background color.

Definition at line 264 of file color_swatch.cpp.

References m_background, m_checkerboardBg, m_checkerboardSize, m_color, m_size, m_swatch, and MakeBitmap().

Referenced by DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), LAYER_WIDGET::OnRenderSwatchChanged(), PROPERTIES_FRAME::PROPERTIES_FRAME(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ SetSwatchColor()

void COLOR_SWATCH::SetSwatchColor ( const KIGFX::COLOR4D &  aColor,
bool  aSendEvent 
)

Set the current swatch color directly.

Definition at line 246 of file color_swatch.cpp.

References m_background, m_checkerboardBg, m_checkerboardSize, m_color, m_size, m_swatch, MakeBitmap(), and sendSwatchChangeEvent().

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), PANEL_3D_OPENGL_OPTIONS::loadSettings(), DIALOG_LIB_SHAPE_PROPERTIES::onBorderSwatch(), DIALOG_LIB_SHAPE_PROPERTIES::onFill(), DIALOG_JUNCTION_PROPS::resetDefaults(), DIALOG_LINE_PROPERTIES::resetDefaults(), DIALOG_WIRE_BUS_PROPERTIES::resetDefaults(), PANEL_COLOR_SETTINGS::ResetPanel(), DIALOG_FIELD_PROPERTIES::TransferDataToWindow(), DIALOG_JUNCTION_PROPS::TransferDataToWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_LINE_PROPERTIES::TransferDataToWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_WIRE_BUS_PROPERTIES::TransferDataToWindow().

◆ setupEvents()

void COLOR_SWATCH::setupEvents ( bool  aTriggerWithSingleClick)
private

Definition at line 184 of file color_swatch.cpp.

References GetNewSwatchColor(), m_swatch, and rePostEvent().

Referenced by COLOR_SWATCH().

◆ SetUserColors()

void COLOR_SWATCH::SetUserColors ( CUSTOM_COLORS_LIST *  aUserColors)
inline

Fetch a reference to the user colors list.

Definition at line 95 of file color_swatch.h.

References m_userColors.

◆ SetWindowID()

void COLOR_SWATCH::SetWindowID ( wxWindowID  aId)
inline

Updates the window ID of this control and its children.

Parameters
aIdnew Window ID to set

Definition at line 106 of file color_swatch.h.

References m_swatch.

Member Data Documentation

◆ m_background

KIGFX::COLOR4D COLOR_SWATCH::m_background
private

Definition at line 148 of file color_swatch.h.

Referenced by GetNewSwatchColor(), OnDarkModeToggle(), SetSwatchBackground(), and SetSwatchColor().

◆ m_checkerboardBg

KIGFX::COLOR4D COLOR_SWATCH::m_checkerboardBg
private

Definition at line 156 of file color_swatch.h.

Referenced by COLOR_SWATCH(), GetNewSwatchColor(), OnDarkModeToggle(), SetSwatchBackground(), and SetSwatchColor().

◆ m_checkerboardSize

wxSize COLOR_SWATCH::m_checkerboardSize
private

Definition at line 155 of file color_swatch.h.

Referenced by COLOR_SWATCH(), GetNewSwatchColor(), OnDarkModeToggle(), SetSwatchBackground(), and SetSwatchColor().

◆ m_color

KIGFX::COLOR4D COLOR_SWATCH::m_color
private

Definition at line 147 of file color_swatch.h.

Referenced by GetNewSwatchColor(), GetSwatchColor(), OnDarkModeToggle(), SetSwatchBackground(), and SetSwatchColor().

◆ m_default

KIGFX::COLOR4D COLOR_SWATCH::m_default
private

Definition at line 149 of file color_swatch.h.

Referenced by GetNewSwatchColor(), and SetDefaultColor().

◆ m_readOnly

bool COLOR_SWATCH::m_readOnly
private

A read-only swatch won't show the color chooser dialog but otherwise works normally.

Definition at line 159 of file color_swatch.h.

Referenced by GetNewSwatchColor(), IsReadOnly(), and SetReadOnly().

◆ m_readOnlyCallback

std::function<void()> COLOR_SWATCH::m_readOnlyCallback
private

Definition at line 160 of file color_swatch.h.

Referenced by GetNewSwatchColor(), and SetReadOnlyCallback().

◆ m_size

wxSize COLOR_SWATCH::m_size
private

Definition at line 154 of file color_swatch.h.

Referenced by COLOR_SWATCH(), GetNewSwatchColor(), OnDarkModeToggle(), SetSwatchBackground(), and SetSwatchColor().

◆ m_supportsOpacity

bool COLOR_SWATCH::m_supportsOpacity
private

If opacity is not supported the color chooser dialog will be displayed without it.

Definition at line 163 of file color_swatch.h.

Referenced by GetNewSwatchColor(), and SetSupportsOpacity().

◆ m_swatch

wxStaticBitmap* COLOR_SWATCH::m_swatch
private

Definition at line 152 of file color_swatch.h.

Referenced by COLOR_SWATCH(), GetNewSwatchColor(), OnDarkModeToggle(), SetSwatchBackground(), SetSwatchColor(), setupEvents(), and SetWindowID().

◆ m_userColors

CUSTOM_COLORS_LIST* COLOR_SWATCH::m_userColors
private

Definition at line 150 of file color_swatch.h.

Referenced by GetNewSwatchColor(), and SetUserColors().

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