You may return to the Cvo Object Documenation Index from this document. This document contains the following sections describing the Cvo_Radio object:
Cvo_Radio
#include
<Cvo/Radio.h++>
new
Cvo_Radio ( )
The Cvo_Radio object allows Cvo objects to be grouped together. Its
purpose is to logically group objects which may be toggled on and
off, and insure that of the grouped objects, only one is toggled on
at a time. This will not affect the visual position of the objects
whatsoever. While any Cvo objects may be grouped together with a
Cvo_Radio object, only those which have functional ForceOn()
and
ForceOff()
members will be affected.
To use this object, you call the AddToggle()
member function for
each Cvo object you want the Cvo_Radio object to manage. The
Cvo_Radio object will receive the CvoButtonUpEvent
and
CvoButtonDownEvent
events for each registered object. Depending on
the event, the other registered objects will be toggled on or off
such that only one object is toggled on.
This object defines the following member functions.
Cvo_RadioList *AddToggle (
Cvo_Object *object,
void *data )
This function will add the object argument to the list of objects the Cvo_Radio object will manage. The pointer argument data will be stored in the Cvo_RadioList object.
void DeleteToggle (
Cvo_RadioList *toggle )
This function will remove the given argument from the list of objects
the Cvo_Radio object manages. The argument toggle should be a
Cvo_RadioList pointer returned from the AddToggle()
member
function.
Cvo_Object *Current (
)
This function returns a pointer to the object currently toggled on.
Cvo_RadioList *List (
)
This function returns a pointer to the Cvo_RadioList object containing the various Cvo objects the Cvo_Radio object is managing.
void RequireSelection (
BOOL required )
This function, when called with a True
value, will force one of the
managed objects to be toggled on via a call to its ForceOn()
member
function.
See the example source code for an example of how to use this object.
See the legend for information about the conventions used in this documentation.