gadget_w_boolean.h

Go to the documentation of this file.

/*
    File        : gadget_w_boolean.h
    Date        : 19-Sep-02
    Description : Class to represent a toolbox gadget that has a boolean value.

    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 gadget_w_boolean_h
#define gadget_w_boolean_h

// Include oslib header files
#include "oslib/macros.h"
#include "oslib/types.h"

// A class to represent a gadget with a boolean value
class gadget_w_boolean
{
public:

    /*
        Parameters  : value - The value to set.
        Returns     : void
        Description : Set the value of this gadget.
    */
    void set_value(bool value);

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

    /*
        Parameters  : void
        Returns     : bool  - The value
        Description : Get the value of this gadget.
    */
    bool get_value() const;

    /*
        Parameters  : void
        Returns     : int   - The value.
        Description : Get the value of this gadget.
    */
    bool operator()() const;

protected:

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

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

/*
    Parameters  : value - The value to set.
    Returns     : void
    Description : Set the value of this gadget.
*/
inline void gadget_w_boolean::set_value(bool value)
{
    _set_value(BOOL(value));
}

/*
    Parameters  : value             - The value to set.
    Returns     : gadget_w_boolean  - This object.
    Description : Set the value of this gadget. To reduce flicker the value
                  is not updated unless it has changed.
*/
inline gadget_w_boolean &gadget_w_boolean::operator=(bool value)
{
    value = BOOL(value);
    if (value != _get_value()) _set_value(value);
    return *this;
}

/*
    Parameters  : void
    Returns     : bool  - The value
    Description : Get the value of this gadget.
*/
inline bool gadget_w_boolean::get_value() const
{
    return _get_value();
}

/*
    Parameters  : void
    Returns     : bool  - The value.
    Description : Get the value of this gadget.
*/
inline bool gadget_w_boolean::operator()() const
{
    return _get_value();
}

#endif

---