This is a class designed to facilitate operations across an entire group of RadioButtons. More...

#include <radiobutton.h>

Collaboration diagram for Mezzanine::UI::RadioButtonGroup:

Public Types
typedef RadioButtonContainer::const_iterator	ConstRadioButtonIterator
	Const Iterator type for RadioButton instances stored by this class.

typedef std::vector < RadioButton * >	RadioButtonContainer
	Basic container type for RadioButton storage by this class.

typedef RadioButtonContainer::iterator	RadioButtonIterator
	Iterator type for RadioButton instances stored by this class.

Public Member Functions
	RadioButtonGroup ()
	Class constructor.

	~RadioButtonGroup ()
	Class destructor.

void	_NotifyButtonSelected (RadioButton *Selected)
	Notifies this group a button has been selected. More...

void	AddButtonToGroup (RadioButton *ToAdd)
	Adds a RadioButton to this group. More...

void	DeselectOtherButtons (RadioButton *Exclude)
	Deselects all but one (or just all) button(s) in this group. More...

Whole	GetNumButtons () const
	Gets the number of buttons in this group. More...

RadioButtonIterator	RadioButtonBegin ()
	Gets an iterator to the first RadioButton. More...

ConstRadioButtonIterator	RadioButtonBegin () const
	Gets a const iterator to the first RadioButton. More...

RadioButtonIterator	RadioButtonEnd ()
	Gets an iterator to one passed the last RadioButton. More...

ConstRadioButtonIterator	RadioButtonEnd () const
	Gets an iterator to one passed the last RadioButton. More...

void	RemoveButtonFromGroup (RadioButton *ToRemove)
	Removes a RadioButton from this group. More...

void	SelectButton (RadioButton *ToSelect)
	Makes a RadioButton in this group the selection, deselecting all other RadioButtons in the group. More...

Protected Attributes
RadioButton *	CurrentSelection
	A pointer to the RadioButton that is the current selection, or NULL if none are selected. More...

RadioButtonContainer	GroupButtons
	A container storing all the RadioButtons belonging to this group. More...

Detailed Description

This is a class designed to facilitate operations across an entire group of RadioButtons.

Definition at line 54 of file radiobutton.h.

Member Function Documentation

void Mezzanine::UI::RadioButtonGroup::_NotifyButtonSelected ( RadioButton * Selected)

Notifies this group a button has been selected.

Definition at line 124 of file radiobutton.cpp.

void Mezzanine::UI::RadioButtonGroup::AddButtonToGroup ( RadioButton * ToAdd)

Adds a RadioButton to this group.

Parameters

ToAdd A pointer to the RadioButton to be added to this group.

Definition at line 69 of file radiobutton.cpp.

void Mezzanine::UI::RadioButtonGroup::DeselectOtherButtons ( RadioButton * Exclude)

Deselects all but one (or just all) button(s) in this group.

Note: You can pass in NULL to deselect all buttons in this group.

Parameters

Exclude The Button that will be excluded from forced deselection.

Definition at line 99 of file radiobutton.cpp.

Whole Mezzanine::UI::RadioButtonGroup::GetNumButtons ( ) const

Gets the number of buttons in this group.

Returns: Returns a Whole representing the number of buttons that belong to this group.

Definition at line 77 of file radiobutton.cpp.

RadioButtonGroup::RadioButtonIterator Mezzanine::UI::RadioButtonGroup::RadioButtonBegin ( )

Gets an iterator to the first RadioButton.

Returns: Returns an iterator to the first RadioButton being stored by this renderable.

Definition at line 109 of file radiobutton.cpp.

RadioButtonGroup::ConstRadioButtonIterator Mezzanine::UI::RadioButtonGroup::RadioButtonBegin ( ) const

Gets a const iterator to the first RadioButton.

Returns: Returns a const iterator to the first RadioButton being stored by this renderable.

Definition at line 115 of file radiobutton.cpp.

RadioButtonGroup::RadioButtonIterator Mezzanine::UI::RadioButtonGroup::RadioButtonEnd ( )

Gets an iterator to one passed the last RadioButton.

Returns: Returns an iterator to one passed the last RadioButton being stored by this renderable.

Definition at line 112 of file radiobutton.cpp.

RadioButtonGroup::ConstRadioButtonIterator Mezzanine::UI::RadioButtonGroup::RadioButtonEnd ( ) const

Gets an iterator to one passed the last RadioButton.

Returns: Returns an iterator to one passed the last RadioButton being stored by this renderable.

Definition at line 118 of file radiobutton.cpp.

void Mezzanine::UI::RadioButtonGroup::RemoveButtonFromGroup ( RadioButton * ToRemove)

Removes a RadioButton from this group.

Parameters

ToRemove A pointer to the RadioButton to be removed from this group.

Definition at line 82 of file radiobutton.cpp.

void Mezzanine::UI::RadioButtonGroup::SelectButton ( RadioButton * ToSelect)

Makes a RadioButton in this group the selection, deselecting all other RadioButtons in the group.

Note: You can pass in NULL to ensure none of the RadioButtons in this group are selected.

Parameters

ToSelect A pointer to the RadioButton in this group that will be selected.

Definition at line 90 of file radiobutton.cpp.

Member Data Documentation

RadioButton* Mezzanine::UI::RadioButtonGroup::CurrentSelection

protected

A pointer to the RadioButton that is the current selection, or NULL if none are selected.

Definition at line 69 of file radiobutton.h.

RadioButtonContainer Mezzanine::UI::RadioButtonGroup::GroupButtons

protected

A container storing all the RadioButtons belonging to this group.

Definition at line 66 of file radiobutton.h.

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

/home/sqeaky/Code/Mezzanine/Mezzanine/src/UI/radiobutton.h
/home/sqeaky/Code/Mezzanine/Mezzanine/src/UI/radiobutton.cpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation