/*
 RADIOBTN.DOX

 License CC0 PUBLIC DOMAIN

 To the extent possible under law, Mark J. Olesen has waived all copyright
 and related or neighboring rights to FDOSTUI Library. This work is published
 from: United States.
*/

/*! \file radiobtn.hpp
\brief contains radio button class
*/

/*! \class radiobutton radiobtn.hpp
\brief radio button widget

Check button widget, which contains the state of on or off.
A radio button can belong to a group of other radio buttons.
Only one button at a time may contain the on state.

The radio group is implemented as a doubly linked list.
Each radiobutton contains a pointer to the next and previous
radiobutton in the grouop. Data  members are made public,
however, the should only be used internally.

*/


/*!
\fn radiobutton::radiobutton(
        int const                       i_pos_x,
        int const                       i_pos_y,
        unsigned int const              i_len_x,
        unsigned int const              i_len_y)
\brief constructor 
\param[in] i_pos_x x position to place widget
\param[in] i_pos_y y position to place widget
\param[in] i_len_x x length of widget
\param[in] i_len_y y length of widget
\returns none
*/

    
/*!
\fn virtual radiobutton::~radiobutton()
\brief destructor
\returns none
*/

/*!
\fn bool radiobutton::join(
        radiobutton*const               i_radiobutton)
\brief adds a radio button to this buttons group
\param[in] i_radiobutton button to add
\returns false radiobutton could not be added to group
\returns true radiobutton added to group

A radiobutton can only belong to one group. In addition,
the radiobutton must have been added to this parent widget.
*/

/*!
\fn virtual void radiobutton::toggled()
\brief handler when the button has been toggled

This method will synchronize radiobutton widgets so only one is selected.
*/

/*!
\var radiobutton::m_next
	next radiobutton in group
*/


/*!
\var radiobutton::m_prev
	previous radiobutton in group
*/

