A toggle button that displays images for each state. More...

Inheritance diagram for PLGui::BitmapToggleButton:

[legend]

Public Member Functions
PLGUI_API	BitmapToggleButton (Widget *pParent=nullptr)
	Constructor.
virtual PLGUI_API	~BitmapToggleButton ()
	Destructor.
PLGUI_API const Image &	GetImageDisabled () const
	Get image for disabled-state.
PLGUI_API void	SetImageDisabled (const Image &cImage)
	Set image for disabled-state.
PLGUI_API const Image &	GetImageUnselected (ECheckState nChecked) const
	Get image for unselected state.
PLGUI_API void	SetImageUnselected (ECheckState nChecked, const Image &cImage)
	Set image for unselected state.
PLGUI_API const Image &	GetImageSelected (ECheckState nChecked) const
	Get image for selected state.
PLGUI_API void	SetImageSelected (ECheckState nChecked, const Image &cImage)
	Set image for selected state.

Detailed Description

A toggle button that displays images for each state.

Constructor & Destructor Documentation

PLGUI_API PLGui::BitmapToggleButton::BitmapToggleButton ( Widget * pParent = nullptr )

Constructor.

Parameters:

[in] pParent Pointer to the parent widget

virtual PLGUI_API PLGui::BitmapToggleButton::~BitmapToggleButton ( ) [virtual]

Destructor.

PLGUI_API const Image& PLGui::BitmapToggleButton::GetImageDisabled ( ) const

Get image for disabled-state.

PLGUI_API void PLGui::BitmapToggleButton::SetImageDisabled ( const Image & cImage )

Set image for disabled-state.

Parameters:

[in] cImage Image that is displayed when the button is disabled

PLGUI_API const Image& PLGui::BitmapToggleButton::GetImageUnselected ( ECheckState nChecked ) const

Get image for unselected state.

Parameters:

[in] nChecked Check-state for which to set the image

PLGUI_API void PLGui::BitmapToggleButton::SetImageUnselected	(	ECheckState	nChecked,
		const Image &	cImage
	)

Set image for unselected state.

Parameters:

[in]	nChecked	Check-state for which to set the image
[in]	cImage	Image that is displayed when the button is not selected

PLGUI_API const Image& PLGui::BitmapToggleButton::GetImageSelected ( ECheckState nChecked ) const

Get image for selected state.

Parameters:

[in] nChecked Check-state for which to set the image

PLGUI_API void PLGui::BitmapToggleButton::SetImageSelected	(	ECheckState	nChecked,
		const Image &	cImage
	)

Set image for selected state.

Parameters:

[in]	nChecked	Check-state for which to set the image
[in]	cImage	Image that is displayed when the button is selected

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