actionbutton_c.h

Go to the documentation of this file.

/*
    File        : actionbutton_c.h
    Date        : 19-Sep-02
    Description : Class to represent an action 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 actionbutton_c_h
#define actionbutton_c_h

// Include alexlib header files
#ifndef actionbutton_b_h
#include "actionbutton_b.h"
#endif
#ifndef gadget_c_h
#include "gadget_c.h"
#endif
#ifndef gadget_w_show_c_h
#include "gadget_w_show_c.h"
#endif

// A class to represent an action button gadget
class actionbutton_c : public virtual gadget_b,
                       public gadget_c,
                       public actionbutton_b,
                       public gadget_w_show_c
{
public:

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

protected:

    /*
        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  : object    - The object to show.
        Returns     : void
        Description : Gadget specific function to set the object to show.
    */
    virtual void _set_show(toolbox_o object);

    /*
        Parameters  : void
        Returns     : toolbox_o - The object to show.
        Description : Gadget specific function to get the object to show.
    */
    virtual toolbox_o _get_show() const;
};

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

/*
    Parameters  : object    - The object to show.
    Returns     : void
    Description : Gadget specific function to set the object to show.
*/
inline void actionbutton_c::_set_show(toolbox_o object)
{
    actionbutton_set_click_show(0, actionbutton_c::object, component,
                                object, get_is_menu());
}

/*
    Parameters  : void
    Returns     : toolbox_o - The object to show.
    Description : Gadget specific function to get the object to show.
*/
inline toolbox_o actionbutton_c::_get_show() const
{
    return actionbutton_get_click_show(0, object, component);
}

#endif

---