color_swatch.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017-2024 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#ifndef COLOR_SWATCH__H_
#define COLOR_SWATCH__H_
 
#include <wx/bitmap.h>
#include <wx/gdicmn.h>
#include <wx/panel.h>
#include <wx/statbmp.h>
#include <wx/window.h>
 
#include <functional>
 
#include <gal/color4d.h>
#include <dialogs/dialog_color_picker.h>
 
enum SWATCH_SIZE
{
    SWATCH_SMALL,
    SWATCH_MEDIUM,
    SWATCH_LARGE,
    SWATCH_EXPAND
};
 
 
const static wxSize SWATCH_SIZE_SMALL_DU( 8, 6 );
const static wxSize SWATCH_SIZE_MEDIUM_DU( 24, 10 );
const static wxSize SWATCH_SIZE_LARGE_DU( 24, 16 );
const static wxSize CHECKERBOARD_SIZE_DU( 3, 3 );
 
 
class COLOR_SWATCH: public wxPanel
{
public:
 
    COLOR_SWATCH( wxWindow* aParent, const KIGFX::COLOR4D& aColor, int aID,
                  const KIGFX::COLOR4D& aBackground, const KIGFX::COLOR4D& aDefault,
                  SWATCH_SIZE aSwatchType, bool aTriggerWithSingleClick = false );
 
    COLOR_SWATCH( wxWindow *aParent, wxWindowID aId, const wxPoint &aPos = wxDefaultPosition,
                  const wxSize &aSize = wxDefaultSize, long aStyle = 0 );
 
    void SetSwatchColor( const KIGFX::COLOR4D& aColor, bool aSendEvent );
 
    void SetDefaultColor( const KIGFX::COLOR4D& aColor );
 
    void SetSwatchBackground( const KIGFX::COLOR4D& aBackground );
 
    void SetUserColors( CUSTOM_COLORS_LIST* aUserColors ) { m_userColors = aUserColors; }
 
    KIGFX::COLOR4D GetSwatchColor() const;
 
    void SetWindowID( wxWindowID aId )
    {
        SetId( aId );
        m_swatch->SetId( aId );
    }
 
    void GetNewSwatchColor();
 
    void SetReadOnly( bool aReadOnly = true ) { m_readOnly = aReadOnly; }
    bool IsReadOnly() const { return m_readOnly; }
 
    void SetSupportsOpacity( bool aSupportsOpacity ) { m_supportsOpacity = aSupportsOpacity; }
 
    void SetReadOnlyCallback( std::function<void()> aCallback ) { m_readOnlyCallback = aCallback; }
 
    void OnDarkModeToggle();
 
    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:
    void setupEvents( bool aTriggerWithSingleClick );
 
    wxBitmap makeBitmap();
 
    void rePostEvent( wxEvent& aEvent );
 
    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;
    std::function<void()> m_readOnlyCallback;
 
    bool                  m_supportsOpacity;
};
 
 
wxDECLARE_EVENT(COLOR_SWATCH_CHANGED, wxCommandEvent);
 
#endif // COLOR_SWATCH__H_