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 wxBitmapBundle &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
wxBitmapBundle	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 41 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 33 of file std_bitmap_button.cpp.

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

~STD_BITMAP_BUTTON()

STD_BITMAP_BUTTON::~STD_BITMAP_BUTTON

(

)

Definition at line 61 of file std_bitmap_button.cpp.

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

Member Function Documentation

Enable()

bool STD_BITMAP_BUTTON::Enable ( bool aEnable = true )

override

Definition at line 255 of file std_bitmap_button.cpp.

References m_bIsEnable, and m_stateButton.

OnKillFocus()

void STD_BITMAP_BUTTON::OnKillFocus ( wxFocusEvent & aEvent )

protected

Definition at line 110 of file std_bitmap_button.cpp.

References m_stateButton.

Referenced by STD_BITMAP_BUTTON(), and ~STD_BITMAP_BUTTON().

OnLeftButtonDown()

void STD_BITMAP_BUTTON::OnLeftButtonDown ( wxMouseEvent & aEvent )

protected

Definition at line 167 of file std_bitmap_button.cpp.

References m_stateButton.

Referenced by STD_BITMAP_BUTTON(), and ~STD_BITMAP_BUTTON().

OnLeftButtonUp()

void STD_BITMAP_BUTTON::OnLeftButtonUp ( wxMouseEvent & aEvent )

protected

Definition at line 146 of file std_bitmap_button.cpp.

References m_stateButton.

Referenced by STD_BITMAP_BUTTON(), and ~STD_BITMAP_BUTTON().

OnMouseEnter()

void STD_BITMAP_BUTTON::OnMouseEnter ( wxMouseEvent & aEvent )

protected

Definition at line 134 of file std_bitmap_button.cpp.

References m_stateButton.

Referenced by STD_BITMAP_BUTTON(), and ~STD_BITMAP_BUTTON().

OnMouseLeave()

void STD_BITMAP_BUTTON::OnMouseLeave ( wxMouseEvent & aEvent )

protected

Definition at line 122 of file std_bitmap_button.cpp.

References m_stateButton.

Referenced by STD_BITMAP_BUTTON(), and ~STD_BITMAP_BUTTON().

OnPaint()

void STD_BITMAP_BUTTON::OnPaint ( wxPaintEvent & WXUNUSEDaEvent )

protected

Definition at line 176 of file std_bitmap_button.cpp.

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

Referenced by STD_BITMAP_BUTTON(), and ~STD_BITMAP_BUTTON().

onThemeChanged()

void STD_BITMAP_BUTTON::onThemeChanged ( wxSysColourChangedEvent & aEvent )

protected

Definition at line 75 of file std_bitmap_button.cpp.

Referenced by STD_BITMAP_BUTTON(), and ~STD_BITMAP_BUTTON().

SetBitmap()

void STD_BITMAP_BUTTON::SetBitmap

(

const wxBitmapBundle &

aBmp

)

Definition at line 81 of file std_bitmap_button.cpp.

References m_bitmap, and minSize.

Member Data Documentation

m_bIsEnable

bool STD_BITMAP_BUTTON::m_bIsEnable = true

private

Definition at line 65 of file std_bitmap_button.h.

Referenced by Enable(), and OnPaint().

m_bitmap

wxBitmapBundle STD_BITMAP_BUTTON::m_bitmap

private

Definition at line 66 of file std_bitmap_button.h.

Referenced by OnPaint(), and SetBitmap().

m_stateButton

int STD_BITMAP_BUTTON::m_stateButton = 0

private

Definition at line 64 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