LRadioGroup

LRadioGroup is a PowerPlant class that is used for managing a group of Controls by ensuring that only one Control in a group is "on" at any time. This is the standard behavior of a set of Radio Buttons.

Methods :

The methods in this class are:

LRadioGroup()	~LRadioGroup()
AddRadio()	GetCurrentRadioID()
ListenToMessage()

Data Members:

The data members in this class are:

mCurrentRadio

Operation:

Although you will normally use this class with StdRadioButton objects, the group members can be any kind of Control. Therefore, you can group your own custom Control objects. This class assumes the "off" value is zero, and the "on" value is one.

RadioGroup and its Controls have a Listener/Broadcaster relationship.

Source files:

(Support Classes)

LRadioGroup.h

LRadioGroup.cp

See also:

LControl

LListener

LRadioGroup()

Purpose:

The constructors create objects from the passed-in parameters.

Access:

Public

Prototype:

LRadioGroup();

LRadioGroup( LStream *inStream );

The stream constructor has the following parameter:

LStream*

inStream

A pointer to a stream object that contains the information to create the LRadioGroup object.

~LRadioGroup()

Purpose:

The destructor destroys the object.

Access:

Virtual, Public

Prototype:

virtual ~LRadioGroup();

AddRadio()

Purpose:

Adds a Control to a Radio Group.

If the Control is "on" it becomes the current radio, turning off the former current radio.

Access:

Virtual, Public

Prototype:

virtual void AddRadio( LControl *inRadio );

The parameter for this method is:

LControl*

inRadio

The pointer to the LControl object that we wish to add to.

Return:

None

GetCurrentRadioID()

Purpose:

Return the PaneID of the current RadioButton in the Group.

Access:

Virtual, Public

Prototype:

virtual PaneIDT GetCurrentRadioID();

None

Return:

PaneIDT

ListenToMessage()

Purpose:

React to Messages from Broadcasters, which must be the Controls in the group. This is a pure virtual method (ListenToMessage()) in the base class which you must override. Refer to the description there for more information.

mCurrentRadio

Purpose:

This data member holds the pointer to the current radio button.

Access:

Protected

Prototype:

LControl *mCurrentRadio;