PixelLightAPI  .
Public Member Functions | Public Attributes | Protected Attributes
PLGui::ButtonGroup Class Reference

Manages a button group. More...

#include <ButtonGroup.h>

List of all members.

Public Member Functions

PLGUI_API ButtonGroup ()
 Constructor.
virtual PLGUI_API ~ButtonGroup ()
 Destructor.
PLGUI_API bool IsExclusive () const
 Check if the button activation is exclusive.
PLGUI_API void SetExclusive (bool bExclusive)
 Set if the button activation is exclusive.
PLGUI_API void Activate (AbstractToggleButton &cButton)
 Activates a certain button.

Public Attributes

PLCore::Event
< AbstractToggleButton * > 
EventActivate

Protected Attributes

bool m_bExclusive
AbstractToggleButtonm_pButton

Detailed Description

Manages a button group.


Constructor & Destructor Documentation

Constructor.

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

Destructor.


Member Function Documentation

PLGUI_API bool PLGui::ButtonGroup::IsExclusive ( ) const

Check if the button activation is exclusive.

Returns:
'true', if the button activation is exclusive, else 'false'
Remarks:
If the button activation is exclusive, only one button can be active at the same time
PLGUI_API void PLGui::ButtonGroup::SetExclusive ( bool  bExclusive)

Set if the button activation is exclusive.

Parameters:
[in]bExclusive'true', if the button activation is exclusive, else 'false'
PLGUI_API void PLGui::ButtonGroup::Activate ( AbstractToggleButton cButton)

Activates a certain button.

Parameters:
[in]cButtonButton that is being activated

Member Data Documentation

If 'true', only one button can be activated at the same time

Button that is currently activated


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:32
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported