PixelLightAPI  .
Public Member Functions
PLGui::BitmapButton Class Reference

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

#include <BitmapButton.h>

Inheritance diagram for PLGui::BitmapButton:
Inheritance graph
[legend]

List of all members.

Public Member Functions

PLGUI_API BitmapButton (Widget *pParent=nullptr)
 Constructor.
virtual PLGUI_API ~BitmapButton ()
 Destructor.
PLGUI_API const ImageGetImageEnabled () const
 Get image for enabled-state.
PLGUI_API void SetImageEnabled (const Image &cImage)
 Set image for enabled-state.
PLGUI_API const ImageGetImageDisabled () const
 Get image for disabled-state.
PLGUI_API void SetImageDisabled (const Image &cImage)
 Set image for disabled-state.
PLGUI_API const ImageGetImageSelected () const
 Get image for selected-state.
PLGUI_API void SetImageSelected (const Image &cImage)
 Set image for selected-state.
PLGUI_API const ImageGetImagePressed () const
 Get image for pressed-state.
PLGUI_API void SetImagePressed (const Image &cImage)
 Set image for pressed-state.

Detailed Description

A button that displays images for each state.


Constructor & Destructor Documentation

PLGUI_API PLGui::BitmapButton::BitmapButton ( Widget pParent = nullptr)

Constructor.

Parameters:
[in]pParentPointer to the parent widget
virtual PLGUI_API PLGui::BitmapButton::~BitmapButton ( ) [virtual]

Destructor.


Member Function Documentation

PLGUI_API const Image& PLGui::BitmapButton::GetImageEnabled ( ) const

Get image for enabled-state.

Returns:
Image that is displayed when the button is enabled
PLGUI_API void PLGui::BitmapButton::SetImageEnabled ( const Image cImage)

Set image for enabled-state.

Parameters:
[in]cImageImage that is displayed when the button is enabled
PLGUI_API const Image& PLGui::BitmapButton::GetImageDisabled ( ) const

Get image for disabled-state.

Returns:
Image that is displayed when the button is disabled
PLGUI_API void PLGui::BitmapButton::SetImageDisabled ( const Image cImage)

Set image for disabled-state.

Parameters:
[in]cImageImage that is displayed when the button is disabled
PLGUI_API const Image& PLGui::BitmapButton::GetImageSelected ( ) const

Get image for selected-state.

Returns:
Image that is displayed when the button is selected
PLGUI_API void PLGui::BitmapButton::SetImageSelected ( const Image cImage)

Set image for selected-state.

Parameters:
[in]cImageImage that is displayed when the button is selected
PLGUI_API const Image& PLGui::BitmapButton::GetImagePressed ( ) const

Get image for pressed-state.

Returns:
Image that is displayed when the button is pressed
PLGUI_API void PLGui::BitmapButton::SetImagePressed ( const Image cImage)

Set image for pressed-state.

Parameters:
[in]cImageImage that is displayed when the button is pressed

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


PixelLight PixelLight 0.9.11-R1
Copyright (C) 2002-2012 by The PixelLight Team
Last modified Thu Feb 23 2012 14:09:33
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported