COLOR_SWATCH Class Reference

Class representing 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, KIGFX::COLOR4D aColor, int aID, KIGFX::COLOR4D aBackground, const KIGFX::COLOR4D aDefault, SWATCH_SIZE aSwatchType)
	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 (KIGFX::COLOR4D aColor, bool aSendEvent)
	Set the current swatch color directly. More...
void	SetDefaultColor (KIGFX::COLOR4D aColor)
	Sets the color that will be chosen with the "Reset to Default" button in the chooser. More...
void	SetSwatchBackground (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	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...

Static Public Member Functions
static wxBitmap	MakeBitmap (KIGFX::COLOR4D aColor, KIGFX::COLOR4D aBackground, wxSize aSize, wxSize aCheckerboardSize, KIGFX::COLOR4D aCheckerboardBackground)
	Make a simple color swatch bitmap. More...

Private Member Functions
void	setupEvents ()
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

Class representing a simple color swatch, of the kind used to set layer colors.

Definition at line 57 of file color_swatch.h.

Constructor & Destructor Documentation

COLOR_SWATCH() [1/2]

COLOR_SWATCH::COLOR_SWATCH	(	wxWindow *	aParent,
		KIGFX::COLOR4D	aColor,
		int	aID,
		KIGFX::COLOR4D	aBackground,
		const KIGFX::COLOR4D	aDefault,
		SWATCH_SIZE	aSwatchType
	)

Construct a COLOR_SWATCH.

Parameters

aParent	parent window
aColor	initial swatch color
aID	id to use when sending swatch events

Definition at line 116 of file color_swatch.cpp.

                                                                              :
        wxPanel( aParent, aID ),
        m_color( aColor ),
        m_background( aBackground ),
        m_default( aDefault ),
        m_userColors( nullptr ),
        m_readOnly( false ),
        m_supportsOpacity( true )
{
    wxASSERT_MSG( aSwatchSize != SWATCH_EXPAND, "SWATCH_EXPAND not supported in COLOR_SWATCH" );

    switch( aSwatchSize )
    {
    case SWATCH_MEDIUM: m_size = ConvertDialogToPixels( SWATCH_SIZE_MEDIUM_DU ); break;
    case SWATCH_SMALL:  m_size = ConvertDialogToPixels( SWATCH_SIZE_SMALL_DU );  break;
    case SWATCH_LARGE:  m_size = ConvertDialogToPixels( SWATCH_SIZE_LARGE_DU );  break;
    case SWATCH_EXPAND: m_size = ConvertDialogToPixels( SWATCH_SIZE_LARGE_DU );  break;
    }

    m_checkerboardSize = ConvertDialogToPixels( CHECKERBOARD_SIZE_DU );
    m_checkerboardBg = aParent->GetBackgroundColour();

    auto sizer = new wxBoxSizer( wxHORIZONTAL );
    SetSizer( sizer );

    wxBitmap bitmap = COLOR_SWATCH::MakeBitmap( aColor, aBackground, m_size,
                                                m_checkerboardSize, m_checkerboardBg );
    m_swatch = new wxStaticBitmap( this, aID, bitmap );

    sizer->Add( m_swatch, 0, 0 );

    setupEvents();
}

References CHECKERBOARD_SIZE_DU(), 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 152 of file color_swatch.cpp.

                                                               :
        wxPanel( aParent, aID, aPos, aSize, aStyle ),
        m_userColors( nullptr ),
        m_readOnly( false ),
        m_supportsOpacity( true )
{
    if( aSize == wxDefaultSize )
        m_size = ConvertDialogToPixels( SWATCH_SIZE_MEDIUM_DU );
    else
        m_size = aSize;

    m_checkerboardSize = ConvertDialogToPixels( CHECKERBOARD_SIZE_DU );
    m_checkerboardBg = aParent->GetBackgroundColour();

    SetSize( m_size );

    auto sizer = new wxBoxSizer( wxHORIZONTAL );
    SetSizer( sizer );

    wxBitmap bitmap = COLOR_SWATCH::MakeBitmap( COLOR4D::UNSPECIFIED, COLOR4D::UNSPECIFIED,
                                                m_size, m_checkerboardSize, m_checkerboardBg );
    m_swatch = new wxStaticBitmap( this, aID, bitmap );

    sizer->Add( m_swatch, 0, 0 );

    setupEvents();
}

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 270 of file color_swatch.cpp.

{
    if( m_readOnly )
    {
        if( m_readOnlyCallback )
            m_readOnlyCallback();

        return;
    }

    DIALOG_COLOR_PICKER dialog( ::wxGetTopLevelParent( this ), m_color, m_supportsOpacity,
                                m_userColors, m_default );

    if( dialog.ShowModal() == wxID_OK )
    {
        COLOR4D newColor = dialog.GetColor();

        if( newColor != COLOR4D::UNSPECIFIED || m_default == COLOR4D::UNSPECIFIED )
        {
            m_color = newColor;

            wxBitmap bm = MakeBitmap( newColor, m_background, m_size, m_checkerboardSize,
                                      m_checkerboardBg );
            m_swatch->SetBitmap( bm );

            sendSwatchChangeEvent( *this );
        }
    }
}

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 APPEARANCE_CONTROLS::onNetclassContextMenu(), LAYER_WIDGET::OnRightDownLayer(), LAYER_WIDGET::OnRightDownRender(), and setupEvents().

GetSwatchColor()

COLOR4D COLOR_SWATCH::GetSwatchColor

(

)

const

Returns

the current swatch color

Definition at line 264 of file color_swatch.cpp.

{
    return m_color;
}

References m_color.

Referenced by PANEL_COLOR_SETTINGS::OnColorChanged(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), LAYER_WIDGET::OnLayerSwatchChanged(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PANEL_3D_COLORS::TransferDataFromWindow(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataFromWindow(), PANEL_3D_OPENGL_OPTIONS::TransferDataFromWindow(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

IsReadOnly()

bool COLOR_SWATCH::IsReadOnly ( ) const

inline

Definition at line 110 of file color_swatch.h.

{ return m_readOnly; }

References m_readOnly.

MakeBitmap()

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

static

Make a simple color swatch bitmap.

Parameters

aWindow

- window used as context for device-independent size

Definition at line 44 of file color_swatch.cpp.

{
    wxBitmap    bitmap( aSize );
    wxBrush     brush;
    wxPen       pen;
    wxMemoryDC  iconDC;

    iconDC.SelectObject( bitmap );
    brush.SetStyle( wxBRUSHSTYLE_SOLID );

    if( aColor == COLOR4D::UNSPECIFIED )
    {
        // Draw a checkerboard
        COLOR4D white;
        COLOR4D black;
        bool    rowCycle;

        if( aCheckerboardBackground.GetBrightness() > 0.4 )
        {
            white = COLOR4D::WHITE;
            black = white.Darkened( 0.15 );
            rowCycle = true;
        }
        else
        {
            black = COLOR4D::BLACK;
            white = black.Brightened( 0.15 );
            rowCycle = false;
        }

        for( int x = 0; x < aSize.x; x += aCheckerboardSize.x )
        {
            bool colCycle = rowCycle;

            for( int y = 0; y < aSize.y; y += aCheckerboardSize.y )
            {
                COLOR4D color = colCycle ? black : white;
                brush.SetColour( color.ToColour() );
                pen.SetColour( color.ToColour() );

                iconDC.SetBrush( brush );
                iconDC.SetPen( pen );
                iconDC.DrawRectangle( x, y, x + aCheckerboardSize.x, y + aCheckerboardSize.y );

                colCycle = !colCycle;
            }

            rowCycle = !rowCycle;
        }
    }
    else
    {
        brush.SetColour( aBackground.WithAlpha(1.0).ToColour() );
        pen.SetColour( aBackground.WithAlpha(1.0).ToColour() );

        iconDC.SetBrush( brush );
        iconDC.SetPen( pen );
        iconDC.DrawRectangle( 0, 0, aSize.x, aSize.y );

        brush.SetColour( aColor.ToColour() );
        pen.SetColour( aColor.ToColour() );

        iconDC.SetBrush( brush );
        iconDC.SetPen( pen );
        iconDC.DrawRectangle( 0, 0, aSize.x, aSize.y );
    }

    return bitmap;
}

References BLACK, KIGFX::COLOR4D::Brightened(), color, KIGFX::COLOR4D::Darkened(), KIGFX::COLOR4D::GetBrightness(), WHITE, and KIGFX::COLOR4D::WithAlpha().

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

rePostEvent()

void COLOR_SWATCH::rePostEvent ( wxEvent &  aEvent )

private

Pass unwanted events on to listeners of this object.

Definition at line 220 of file color_swatch.cpp.

{
    wxPostEvent( this, aEvent );
}

Referenced by setupEvents().

SetDefaultColor()

void COLOR_SWATCH::SetDefaultColor

(

KIGFX::COLOR4D

aColor

)

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

Definition at line 250 of file color_swatch.cpp.

{
    m_default = aColor;
}

References m_default.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LINE_WIRE_BUS_PROPERTIES::DIALOG_LINE_WIRE_BUS_PROPERTIES(), PANEL_3D_COLORS::PANEL_3D_COLORS(), PANEL_3D_OPENGL_OPTIONS::PANEL_3D_OPENGL_OPTIONS(), PANEL_EESCHEMA_EDITING_OPTIONS::PANEL_EESCHEMA_EDITING_OPTIONS(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

SetReadOnly()

void COLOR_SWATCH::SetReadOnly ( bool  aReadOnly = true )

inline

Definition at line 109 of file color_swatch.h.

{ m_readOnly = aReadOnly; }

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 115 of file color_swatch.h.

{ m_readOnlyCallback = aCallback; }

References m_readOnlyCallback.

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

SetSupportsOpacity()

void COLOR_SWATCH::SetSupportsOpacity ( bool  aSupportsOpacity )

inline

Definition at line 112 of file color_swatch.h.

{ m_supportsOpacity = aSupportsOpacity; }

References m_supportsOpacity.

Referenced by PANEL_3D_OPENGL_OPTIONS::PANEL_3D_OPENGL_OPTIONS().

SetSwatchBackground()

void COLOR_SWATCH::SetSwatchBackground

(

KIGFX::COLOR4D

aBackground

)

Set the swatch background color.

Definition at line 256 of file color_swatch.cpp.

{
    m_background = aBackground;
    wxBitmap bm = MakeBitmap( m_color, m_background, m_size, m_checkerboardSize, m_checkerboardBg );
    m_swatch->SetBitmap( bm );
}

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

Referenced by LAYER_WIDGET::OnRenderSwatchChanged(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataToWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

SetSwatchColor()

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

Set the current swatch color directly.

Definition at line 238 of file color_swatch.cpp.

{
    m_color = aColor;

    wxBitmap bm = MakeBitmap( m_color, m_background, m_size, m_checkerboardSize, m_checkerboardBg );
    m_swatch->SetBitmap( bm );

    if( aSendEvent )
        sendSwatchChangeEvent( *this );
}

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

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_JUNCTION_PROPS::resetDefaults(), DIALOG_LINE_WIRE_BUS_PROPERTIES::resetDefaults(), PANEL_COLOR_SETTINGS::ResetPanel(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataToWindow(), DIALOG_JUNCTION_PROPS::TransferDataToWindow(), PANEL_3D_COLORS::TransferDataToWindow(), PANEL_3D_OPENGL_OPTIONS::TransferDataToWindow(), DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataToWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

setupEvents()

void COLOR_SWATCH::setupEvents ( )

private

Definition at line 182 of file color_swatch.cpp.

{
    wxWindow* topLevelParent = GetParent();

    while( topLevelParent && !topLevelParent->IsTopLevel() )
        topLevelParent = topLevelParent->GetParent();

    if( topLevelParent && dynamic_cast<DIALOG_SHIM*>( topLevelParent ) )
    {
        m_swatch->Bind( wxEVT_LEFT_DOWN,
                        [this] ( wxMouseEvent& aEvt )
                        {
                            GetNewSwatchColor();
                        } );
    }
    else
    {
        // forward click to any other listeners, since we don't want them
        m_swatch->Bind( wxEVT_LEFT_DOWN, &COLOR_SWATCH::rePostEvent, this );

        // bind the events that trigger the dialog
        m_swatch->Bind( wxEVT_LEFT_DCLICK,
                        [this] ( wxMouseEvent& aEvt )
                        {
                            GetNewSwatchColor();
                        } );
    }

    m_swatch->Bind( wxEVT_MIDDLE_DOWN,
                    [this] ( wxMouseEvent& aEvt )
                    {
                        GetNewSwatchColor();
                    } );

    m_swatch->Bind( wxEVT_RIGHT_DOWN, &COLOR_SWATCH::rePostEvent, this );
}

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.

{ m_userColors = aUserColors; }

References m_userColors.

Referenced by PANEL_3D_COLORS::PANEL_3D_COLORS().

Member Data Documentation

m_background

KIGFX::COLOR4D COLOR_SWATCH::m_background

private

Definition at line 129 of file color_swatch.h.

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

m_checkerboardBg

KIGFX::COLOR4D COLOR_SWATCH::m_checkerboardBg

private

Definition at line 137 of file color_swatch.h.

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

m_checkerboardSize

wxSize COLOR_SWATCH::m_checkerboardSize

private

Definition at line 136 of file color_swatch.h.

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

m_color

KIGFX::COLOR4D COLOR_SWATCH::m_color

private

Definition at line 128 of file color_swatch.h.

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

m_default

KIGFX::COLOR4D COLOR_SWATCH::m_default

private

Definition at line 130 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 140 of file color_swatch.h.

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

m_readOnlyCallback

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

private

Definition at line 141 of file color_swatch.h.

Referenced by GetNewSwatchColor(), and SetReadOnlyCallback().

m_size

wxSize COLOR_SWATCH::m_size

private

Definition at line 135 of file color_swatch.h.

Referenced by COLOR_SWATCH(), GetNewSwatchColor(), 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 144 of file color_swatch.h.

Referenced by GetNewSwatchColor(), and SetSupportsOpacity().

m_swatch

wxStaticBitmap* COLOR_SWATCH::m_swatch

private

Definition at line 133 of file color_swatch.h.

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

m_userColors

CUSTOM_COLORS_LIST* COLOR_SWATCH::m_userColors

private

Definition at line 131 of file color_swatch.h.

Referenced by GetNewSwatchColor(), and SetUserColors().

---

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

• color_swatch.h
• color_swatch.cpp