checkbtn.dox 1.49 KB
Newer Older
Ercan Ersoy's avatar
Ercan Ersoy committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
/*
 CHECKBTN.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 checkbtn.hpp
\brief contains checkbutton class
*/

/*! \class checkbutton checkbtn.hpp
\brief check button widget

Button widget, which contains a state of checked or unchecked. 
Displays the state on screen in the form of a check mark.
*/

/*!
\fn checkbutton::checkbutton(
        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 checkbutton::~checkbutton()
\brief destructor
\returns none
*/

/*!
\fn void checkbutton::clear_state()
\brief sets the state to unchecked

If the state changes to unchecked, the widget will be redrawn,
and the toggled method will be invoked.

A signal is not emitted.
*/

/*!
\fn bool checkbutton::get_state() const
\brief get current state
\returns false not checked
\returns true checked
*/

/*!
\fn void checkbutton::set_state()
\brief sets the state to checked

If the state changed to checked, the widget will be redrawn,
and the toggle method will be invoked.

A signal is not emitted.
*/