vos/gui/gui/button.hh

Go to the documentation of this file.

/* $Id: button.hh,v 1.26 2003/08/05 14:23:15 reed Exp $ */


/* This file was generated by otd2cpp.pl, a script for VOS by Reed Hedges <reed@zerohour.net>
   and Peter Amstutz <tetron@interreality.org>

   Search for TODO for stuff that needs editing. You will want to especially fill in constructors,
   destructors, message handlers, non-property subobjects...

   I can make no guarantee that this code will work, or even that it even is safe to run.
   Use it at your own risk.
*/

/** @file button.hh Defines MetaObject class for Button type (revision 0).

*/

#ifndef _BUTTON_HH_
#define _BUTTON_HH_

#if defined(_WIN32) && defined(_MSC_VER)
# ifdef VOSGUI_EXPORTS
#  define VOSGUI_API __declspec(dllexport)
# else
#  define VOSGUI_API __declspec(dllimport)
# endif
#else
# define VOSGUI_API
#endif

#include <vos/corelibs/vos/vos.hh>
#include <vos/metaobjects/property/property.hh>
#include "widget.hh"

namespace VOSGUI
{

    /** MetaObject implementing Button Object Type.
        Represents a button component, which sends a message back to the
        LocalButton when pressed.
    */
    class VOSGUI_API Button : public virtual Widget
    {


    public:

        /** Constructor */
        Button(MetaObject* superobject);

    
        /** Destructor */
        virtual ~Button();

        /** Return type string ("gui:widget.button") */
        virtual const string getType();

        /** Register Extenders */
        static void registerExtenders();


        /** The client application may choose a button to be the "default"
          * choice in a window or other application context.  Use this
          * property to indicate which button you want to be the default.
          * If more than one button has this property set to true, then
          * the client application will choose one (typically the last
          * one it loads.) Changing this property to true will also probably
          * cause already-connected clients to use this button as their
          * new default.
         */
        //@{
        virtual void setIsDefaultButton(bool v = true, PropertyAccessControl* pac = 0);
        virtual bool getIsDefaultButton();
        virtual void setIsDefaultButtonObj(Property* newobj);
        virtual Property* getIsDefaultButtonObj();
        //@}


        /** Call on remote objects to indicate a putton press. Local objects
         *  will notify listeners (see LocalButton::push).
         *  @param userid If available, this is a string that can be used to
         *                identify a particular user. Typically, it will be
         *                in the form "user@hostname" or "usertype:someid@hostname"
         *
         */
        virtual void push(const string& userid = "") = 0;

    };


    /** Represents a button event. */
    class VOSGUI_API ButtonEvent {
    public:
        string userid;
    };

    /** Listener for button events (ie, push) */
    class VOSGUI_API ButtonListener {
    public:
        virtual void push(const VOSGUI::ButtonEvent& event) = 0;
    };


    /** Local version of Button.  */
    class VOSGUI_API LocalButton : public virtual LocalWidget, public virtual Button
    {
    private:
        std::set<ButtonListener*> buttonListeners;

    public:

        /** Constructor */
        LocalButton(MetaObject* superobject);

        virtual void initialize(PropertyAccessControl* ac);
        virtual void initialize() {
            LocalWidget::initialize();
        }

        /** Static generator, for factory. */
        static MetaObject* new_LocalButton(MetaObject* superobject, const string& type);

        /** Add a new listener */
        void addButtonListener(ButtonListener* l);

        /** Remove an existing listener */
        void removeButtonListener(ButtonListener* l);


        /** Called when the button is pressed. 
         * @deprecated use a ButtonListener instead.
         */
        virtual void push(const string& userid = "");

    protected:

        /** Handle message pushed by simply calling this->push(); */
        virtual void handlePushed(Message* m);

    };


/** Remote version of Button. */
    class VOSGUI_API RemoteButton : public virtual RemoteWidget, public virtual Button
    {
    public:

        /** Constructor */
        RemoteButton(MetaObject* superobject);

        /** Static generator, for factory. */
        static MetaObject* new_RemoteButton(MetaObject* superobject, const string& type);

        virtual void push(const string& userid = "");
    };


/** @def VOSGUI_DEFINE_BUTTON 
 * @deprecated Don't use this, use a ButtonListener with a LocalButton object
 * This macro defines a subclass of VOSGUI::Button named CLASS. The button will
 * have label LABEL. The push() method is left undefined; you must define
 * a method void CLASS::push() somewhere. You may supply a class DATA, and
 * a member object of that class will be declared (protected)named data. DATA
 * must be a subclass of RefCounted.
 */
#define VOSGUI_DEFINE_BUTTON(CLASS, DATA, LABEL)  \
    class CLASS : public virtual VOSGUI::LocalButton { \
    protected: \
        vRef<DATA> data; \
    public: \
        CLASS(MetaObject* super) : VOSGUI::LocalButton(super), VOSGUI::Button(super), VOSGUI::LocalWidget(super), VOSGUI::Widget(super), MetaObject(super) {  \
        }\
        static MetaObject* new_##CLASS (MetaObject* super, const string& type) { \
            return new CLASS(super); \
        }\
        void setup(DATA* data_p = 0) { \
            data = data_p; \
            setLabel(LABEL); \
        }\
        virtual void push(const string& userid = ""); \
    };


/** @def VOSGUI_CREATE_BUTTON
 *  @deprecated Don't use this, use a ButtonListener on a LocalButton object.
 *  This macro registers a local metaobject extension for CLASS and then creates
 *  a MetaObject instantiation of CLASS on site SITE (a pointer or a vRef) and 
 *  inserts it into the  Vobject PARENT (a pointer or a vRef). DATA should be an 
 *  object whose class you passed to VOSGUI_DEFINE_BUTTON.
 *  The button's name will be the same as its CLASS name.
 */
#define VOSGUI_CREATE_BUTTON(CLASS, PARENT, SITE, DATA) { \
    LocalSite::addLocalObjectExtension(typeid(CLASS).name(), &CLASS::new_##CLASS); \
    vRef<MetaObject> o = (SITE)->createMetaObject(#CLASS, typeid(CLASS).name(), 0); \
    vRef<CLASS> b = MetaObject::meta_cast<CLASS*>(&o); \
    assert(&b); \
    b->initialize(&NoPropertyAccessControl::static_); \
    b->setup(DATA); \
    (PARENT)->insertChild(-1, #CLASS, &o); \
}

}

#endif // #ifdef _BUTTON_HH_

---