STD_BITMAP_BUTTON Class Reference

A bitmap button widget that behaves like a standard dialog button except with an icon. More...

#include <std_bitmap_button.h>

Inheritance diagram for STD_BITMAP_BUTTON:

Public Member Functions
	STD_BITMAP_BUTTON (wxWindow *aParent, wxWindowID aId, const wxBitmap &aDummyBitmap, const wxPoint &aPos=wxDefaultPosition, const wxSize &aSize=wxDefaultSize, int aStyle=0)
	~STD_BITMAP_BUTTON ()
void	SetBitmap (const wxBitmap &aBmp)
bool	Enable (bool aEnable=true) override

Protected Member Functions
void	OnKillFocus (wxFocusEvent &aEvent)
void	OnMouseLeave (wxMouseEvent &aEvent)
void	OnMouseEnter (wxMouseEvent &aEvent)
void	OnLeftButtonUp (wxMouseEvent &aEvent)
void	OnLeftButtonDown (wxMouseEvent &aEvent)
void	OnPaint (wxPaintEvent &WXUNUSED(aEvent))
void	onThemeChanged (wxSysColourChangedEvent &aEvent)

Private Attributes
int	m_stateButton = 0
bool	m_bIsEnable = true
wxBitmap	m_bitmap

Detailed Description

A bitmap button widget that behaves like a standard dialog button except with an icon.

Specifically:

• It has a border
• It has no hover/focused state

In wxWidgets 3.2 the native button control is used on Mac for wxBitmapButton with or without text. Said widget has margins that are more than twice what previous versions had. This class allows our bitmap buttons to match the layout of our SPLIT_BUTTON.

Definition at line 44 of file std_bitmap_button.h.

Constructor & Destructor Documentation

STD_BITMAP_BUTTON()

STD_BITMAP_BUTTON::STD_BITMAP_BUTTON	(	wxWindow *	aParent,
		wxWindowID	aId,
		const wxBitmap &	aDummyBitmap,
		const wxPoint &	aPos = wxDefaultPosition,
		const wxSize &	aSize = wxDefaultSize,
		int	aStyle = 0
	)

Definition at line 36 of file std_bitmap_button.cpp.

 :
 wxPanel( aParent, aId, aPos, aSize, aStyle, wxS( "StdBitmapButton" ) )
{
 if( aSize == wxDefaultSize )
 {
 #if wxCHECK_VERSION( 3, 1, 3 )
 wxSize defaultSize = wxButton::GetDefaultSize( aParent );
 #else
 wxSize defaultSize = wxButton::GetDefaultSize();
 #endif
 
 SetMinSize( wxSize( defaultSize.GetWidth() + 1, defaultSize.GetHeight() + 1 ) );
 }
 
 Bind( wxEVT_PAINT, &STD_BITMAP_BUTTON::OnPaint, this );
 Bind( wxEVT_LEFT_UP, &STD_BITMAP_BUTTON::OnLeftButtonUp, this );
 Bind( wxEVT_LEFT_DOWN, &STD_BITMAP_BUTTON::OnLeftButtonDown, this );
 Bind( wxEVT_KILL_FOCUS, &STD_BITMAP_BUTTON::OnKillFocus, this );
 Bind( wxEVT_LEAVE_WINDOW, &STD_BITMAP_BUTTON::OnMouseLeave, this );
 Bind( wxEVT_ENTER_WINDOW, &STD_BITMAP_BUTTON::OnMouseEnter, this );
 
 Bind( wxEVT_SYS_COLOUR_CHANGED,
 wxSysColourChangedEventHandler( STD_BITMAP_BUTTON::onThemeChanged ),
 this );
}

References defaultSize(), OnKillFocus(), OnLeftButtonDown(), OnLeftButtonUp(), OnMouseEnter(), OnMouseLeave(), OnPaint(), and onThemeChanged().

~STD_BITMAP_BUTTON()

STD_BITMAP_BUTTON::~STD_BITMAP_BUTTON

(

)

Definition at line 65 of file std_bitmap_button.cpp.

{
}

Member Function Documentation

Enable()

bool STD_BITMAP_BUTTON::Enable ( bool  aEnable = true )

override

Definition at line 220 of file std_bitmap_button.cpp.

{
 m_bIsEnable = aEnable;
 wxPanel::Enable( m_bIsEnable );
 
 if( m_bIsEnable && m_stateButton == wxCONTROL_DISABLED )
 {
 m_stateButton = 0;
 Refresh();
 }
 
 if( !m_bIsEnable && m_stateButton != wxCONTROL_DISABLED )
 {
 m_stateButton = wxCONTROL_DISABLED;
 Refresh();
 }
 
 return aEnable;
}

References m_bIsEnable, m_stateButton, and Refresh().

Referenced by DIALOG_PAGES_SETTINGS::EnableWksFileNamePicker(), DIALOG_MIGRATE_SETTINGS::OnPrevVerSelected(), DIALOG_NET_INSPECTOR::onSelChanged(), PANEL_FP_PROPERTIES_3D_MODEL::OnUpdateUI(), PANEL_COMMON_SETTINGS::setPdfViewerPathState(), and PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow().

OnKillFocus()

void STD_BITMAP_BUTTON::OnKillFocus ( wxFocusEvent &  aEvent )

protected

Definition at line 84 of file std_bitmap_button.cpp.

{
 if( m_stateButton != 0 )
 {
 m_stateButton = 0;
 Refresh();
 }
 
 aEvent.Skip();
}

References m_stateButton, and Refresh().

Referenced by STD_BITMAP_BUTTON().

OnLeftButtonDown()

void STD_BITMAP_BUTTON::OnLeftButtonDown ( wxMouseEvent &  aEvent )

protected

Definition at line 141 of file std_bitmap_button.cpp.

{
 m_stateButton = wxCONTROL_PRESSED;
 Refresh();
 
 aEvent.Skip();
}

References m_stateButton, and Refresh().

Referenced by STD_BITMAP_BUTTON().

OnLeftButtonUp()

void STD_BITMAP_BUTTON::OnLeftButtonUp ( wxMouseEvent &  aEvent )

protected

Definition at line 120 of file std_bitmap_button.cpp.

{
 m_stateButton = 0;
 
 Refresh();
 
 wxEvtHandler* pEventHandler = GetEventHandler();
 wxASSERT( pEventHandler );
 
 pEventHandler->CallAfter(
 [=]()
 {
 wxCommandEvent evt( wxEVT_BUTTON, GetId() );
 evt.SetEventObject( this );
 GetEventHandler()->ProcessEvent( evt );
 } );
 
 aEvent.Skip();
}

References m_stateButton, and Refresh().

Referenced by STD_BITMAP_BUTTON().

OnMouseEnter()

void STD_BITMAP_BUTTON::OnMouseEnter ( wxMouseEvent &  aEvent )

protected

Definition at line 108 of file std_bitmap_button.cpp.

{
 if( m_stateButton != wxCONTROL_CURRENT )
 {
 m_stateButton = wxCONTROL_CURRENT;
 Refresh();
 }
 
 aEvent.Skip();
}

References m_stateButton, and Refresh().

Referenced by STD_BITMAP_BUTTON().

OnMouseLeave()

void STD_BITMAP_BUTTON::OnMouseLeave ( wxMouseEvent &  aEvent )

protected

Definition at line 96 of file std_bitmap_button.cpp.

{
 if( m_stateButton != 0 )
 {
 m_stateButton = 0;
 Refresh();
 }
 
 aEvent.Skip();
}

References m_stateButton, and Refresh().

Referenced by STD_BITMAP_BUTTON().

OnPaint()

void STD_BITMAP_BUTTON::OnPaint ( wxPaintEvent &  WXUNUSEDaEvent )

protected

Definition at line 150 of file std_bitmap_button.cpp.

{
 wxPaintDC dc( this );
 wxSize size = GetSize();
 
#ifdef __WXMAC__
 auto drawBackground =
 [&]( wxRect aRect )
 {
 // wxWidgets doesn't have much support for dark mode on OSX; none of the
 // system colours return the right values, nor does wxRendererNative draw
 // the borders correctly. So we add some empirically chosen hacks here.
 
 // NOTE: KEEP THESE HACKS IN SYNC WITH SPLIT_BUTTON
 
 wxColor fg = wxSystemSettings::GetColour( wxSYS_COLOUR_BTNTEXT );
 wxColor bg = wxSystemSettings::GetColour( wxSYS_COLOUR_BTNFACE );
 
 aRect.width += 1;
 aRect.height += 1;
 
 if( KIPLATFORM::UI::IsDarkTheme() )
 {
 bg = bg.ChangeLightness( m_bIsEnable ? 130 : 120 );
 dc.SetBrush( bg );
 dc.SetPen( bg );
 }
 else
 {
 bg = bg.ChangeLightness( m_bIsEnable ? 200 : 160 );
 dc.SetBrush( bg );
 fg = fg.ChangeLightness( 180 );
 dc.SetPen( fg );
 }
 
 dc.DrawRoundedRectangle( aRect, aRect.height / 4.0 );
 };
#endif
 
 wxRect r1;
 r1.x = 0;
 r1.y = 0;
 r1.width = size.GetWidth();
 r1.height = size.GetHeight();
 
#ifdef __WXMAC__
 // wxRendereNative doesn't handle dark mode on OSX.
 drawBackground( r1 );
#else
 #ifdef __WXMSW__
 r1.width += 1;
 #endif
 
 wxRendererNative::Get().DrawPushButton( this, dc, r1, m_stateButton );
#endif
 
 if( m_bitmap.IsOk() )
 {
 r1.x = ( size.GetWidth() - m_bitmap.GetWidth() ) / 2;
 
 if( r1.x < 0 )
 r1.x = 0;
 
 r1.y += ( size.GetHeight() - m_bitmap.GetHeight() ) / 2;
 
 dc.DrawBitmap( m_bIsEnable ? m_bitmap : m_bitmap.ConvertToDisabled(), r1.x, r1.y, true );
 }
}

References KIPLATFORM::UI::IsDarkTheme(), m_bIsEnable, m_bitmap, and m_stateButton.

Referenced by STD_BITMAP_BUTTON().

onThemeChanged()

void STD_BITMAP_BUTTON::onThemeChanged ( wxSysColourChangedEvent &  aEvent )

protected

Definition at line 70 of file std_bitmap_button.cpp.

{
 Refresh();
}

References Refresh().

Referenced by STD_BITMAP_BUTTON().

SetBitmap()

void STD_BITMAP_BUTTON::SetBitmap

(

const wxBitmap &

aBmp

)

Definition at line 76 of file std_bitmap_button.cpp.

{
 m_bitmap = aBmp;
 
 SetMinSize( wxSize( m_bitmap.GetWidth() + 8, m_bitmap.GetHeight() + 8 ) );
}

References m_bitmap.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_IMPORT_SETTINGS::DIALOG_IMPORT_SETTINGS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_MANAGE_REPOSITORIES::DIALOG_MANAGE_REPOSITORIES(), DIALOG_MIGRATE_SETTINGS::DIALOG_MIGRATE_SETTINGS(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCH_IMPORT_SETTINGS::DIALOG_SCH_IMPORT_SETTINGS(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SIM_MODEL< T_symbol, T_field >::DIALOG_SIM_MODEL(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TEMPLATE_SELECTOR::DIALOG_TEMPLATE_SELECTOR(), DIALOG_USER_DEFINED_SIGNALS::DIALOG_USER_DEFINED_SIGNALS(), DIALOG_PLOT::init_Dialog(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), DIALOG_GENDRILL::InitDisplayParams(), PANEL_COMMON_SETTINGS::PANEL_COMMON_SETTINGS(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PCBNEW_ACTION_PLUGINS::PANEL_PCBNEW_ACTION_PLUGINS(), PANEL_RF_ATTENUATORS::PANEL_RF_ATTENUATORS(), PANEL_SETUP_BUSES::PANEL_SETUP_BUSES(), PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), PANEL_SETUP_TRACKS_AND_VIAS::PANEL_SETUP_TRACKS_AND_VIAS(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), PANEL_TEMPLATE_FIELDNAMES::PANEL_TEMPLATE_FIELDNAMES(), PANEL_TEXT_VARIABLES::PANEL_TEXT_VARIABLES(), PANEL_TRANSLINE::PANEL_TRANSLINE(), PANEL_FP_EDITOR_DEFAULTS::Show(), PANEL_RF_ATTENUATORS::ThemeChanged(), PANEL_TRANSLINE::ThemeChanged(), and TUNER_SLIDER::TUNER_SLIDER().

Member Data Documentation

m_bIsEnable

bool STD_BITMAP_BUTTON::m_bIsEnable = true

private

Definition at line 68 of file std_bitmap_button.h.

Referenced by Enable(), and OnPaint().

m_bitmap

wxBitmap STD_BITMAP_BUTTON::m_bitmap

private

Definition at line 69 of file std_bitmap_button.h.

Referenced by OnPaint(), and SetBitmap().

m_stateButton

int STD_BITMAP_BUTTON::m_stateButton = 0

private

Definition at line 67 of file std_bitmap_button.h.

Referenced by Enable(), OnKillFocus(), OnLeftButtonDown(), OnLeftButtonUp(), OnMouseEnter(), OnMouseLeave(), and OnPaint().

---

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

• std_bitmap_button.h
• std_bitmap_button.cpp