vos/gui/gui/menu.hh

Go to the documentation of this file.

/* $Id: menu.hh,v 1.6 2003/07/24 05:18:26 tetron 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 menu.hh Defines MetaObject class for "menu" type (revision 0).

*/ 

#ifndef _GUI_MENU_HH_
#define _GUI_MENU_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>

namespace VOSGUI {

/** MetaObject implementing Menu Object Type. 
    
    Contains a list of selectable items and/or submenus.
  
*/
class VOSGUI_API Menu : public virtual MetaObject
{


protected:
    PropertyAccessControl* accessControl;


public:

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

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

    /** Return type string ("gui:menu") */
    virtual const string getType();

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

    /** Set default access control policy */
    virtual void setPropertyAccessControl(PropertyAccessControl* ac);

    /** Get default access control policy */
    virtual PropertyAccessControl* getPropertyAccessControl();
        
};



/** Local version of Menu. */
class LocalMenu : public virtual Menu
{

public:

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

    /** Destructor */
    ~LocalMenu();

    /** Initialize required subproperties with given access control. */
    virtual void initialize(PropertyAccessControl* ac);

    /** Initialize required subproperties. If access control has been
    previously set with initialize(PropertyAccessControl*) or
    setPropertyAccessControl(), then that policy will be used. Otherwise,
    NoPropertyAccessControl will be used.
    */
    virtual void initialize();

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

    /** Called when this object gets a message */
    virtual void sendMessage(Message* m);



};


/** Remote version of Menu. */
class RemoteMenu : public virtual Menu
{
public:

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

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

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

    /** Called when this object gets an update message from its Local master across the network. */
    void sendUpdateMessage(Message *m);


};


} // end of namespace VOSGUI
#endif // #ifdef _MENU_HH_

---