optionbutton_c.h

Go to the documentation of this file.

/*
    File        : optionbutton_c.h
    Date        : 19-Sep-02
    Description : Class to represent an option button toolbox gadget.

    Copyright © 1995-2002 Alexander Thoukydides

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation; either version 2
    of the License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
*/

// Only include header file once
#ifndef optionbutton_c_h
#define optionbutton_c_h

// Include alexlib header files
#ifndef gadget_c_h
#include "gadget_c.h"
#endif
#ifndef optionbutton_b_h
#include "optionbutton_b.h"
#endif

// A class to represent an option button gadget
class optionbutton_c : public virtual gadget_b,
                       public gadget_c,
                       public optionbutton_b
{
public:

    /*
        Parameters  : component - The component ID of this option button.
                      object    - The object ID of this option button's parent
                                  window.
        Returns     : -
        Description : Constructor function. This does not create an
                      option button; it merely creates an object to represent
                      the option button.
    */
    optionbutton_c(toolbox_c component = toolbox_NULL_COMPONENT,
                   toolbox_o object = toolbox_NULL_OBJECT);

    /*
        Parameters  : value             - The value to set.
        Returns     : optionbutton_c    - This object.
        Description : Set the value of this gadget. To reduce flicker the value
                      is not updated unless it has changed.
    */
    optionbutton_c &operator=(bool value);

protected:

    /*
        Parameters  : value - The value to set.
        Returns     : void
        Description : Gadget specific function to set the value.
    */
    virtual void _set_value(bool value);

    /*
        Parameters  : void
        Returns     : bool  - The value
        Description : Gadget specific function to get the value.
    */
    virtual bool _get_value() const;

    /*
        Parameters  : event      - The toolbox event code.
        Returns     : void
        Description : Gadget specific function to set the toolbox event code
                      which will be raised for this gadget.
    */
    virtual void _set_event(bits event);

    /*
        Parameters  : void
        Returns     : bits  - The toolbox event code.
        Description : Gadget specific function to get the toolbox event code
                      which will be raised for this gadget.
    */
    virtual bits _get_event() const;

    /*
        Parameters  : text  - The text string to set.
        Returns     : void
        Description : Gadget specific function to set the text.
    */
    virtual void _set_text(const char *text);

    /*
        Parameters  : text      - Pointer to buffer to hold the text, or NULL
                                  to read the size of buffer required.
                      size      - The size of the buffer.
        Returns     : size_t    - Number of bytes written to the buffer, or
                                  the buffer size required if NULL passed.
        Description : Gadget specific function to get the text or the buffer
                      size required.
    */
    virtual size_t _get_text(char *text, size_t size) const;
};

/*
    Parameters  : component - The component ID of this option button.
                  object    - The object ID of this option button's parent
                              window.
    Returns     : -
    Description : Constructor function. This does not create an
                  option button; it merely creates an object to represent
                  the option button.
*/
inline optionbutton_c::optionbutton_c(toolbox_c component, toolbox_o object)
: gadget_c(component, object) {}

#endif

---