vos/gui/gui/container.hh

Go to the documentation of this file.

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


/*
    Copyright (C) 2002 Reed Hedges

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

    This library 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
    Lesser General Public License for more details.

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

#ifndef _CONTAINER_HH_
#define _CONTAINER_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 <vector>

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


namespace VOSGUI
{

    /** MetaObject implementing the "container" Object Type.  
    */
    class VOSGUI_API Container : public virtual Widget
    {

    public:

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

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

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

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

        /** @name Access Subobjects */
        //@{

        string getLayout();
        void setLayout(const string& value, PropertyAccessControl* ac = 0);
        bool getBorder();
        void setBorder(bool value = true, PropertyAccessControl* ac = 0);

        bool getCompact();
        void setCompact(bool val = true, PropertyAccessControl* ac = 0);
        void setCompactObject(Property* obj);
        Property* getCompactObject();

        //@}

        /** Show remote containers (force raise if it has been hidden by the user, 
            e.g. re-open a closed window. */
        virtual void raise() = 0;

#if 0
       virtual void hide() = 0;

        /** Notification that remote container was hidden (e.g. user closed a
            window) */
        virtual void hidden() = 0;
#endif


    };



    /** Local version of Container. */

    class VOSGUI_API LocalContainer : public virtual Container, public virtual LocalWidget
    {
    private:
        /** If a container is a "top level" member of a display -- ie, a window
         *  -- then we might want to send it explicit set visible messages to force
         *  it to be displayed and raised.  To get added to this set, a remote
         *  container object needs to send a "gui:start-listening" message with
         *  a value of "raise". 
         */  
        vector<Vobject*> remoteWindows;

    public:

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

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

        /** Send a "raise" message to remote windows, asking them to show this
            container on top if it is currently hidden. */
        virtual void raise();

//        virtual void hide();

        /* Override this to do something when a "hidden" message is recieved. */
 //       virtual void hidden();

    private:
//        virtual void handleHidden(Message* m);
         virtual void handleStartListening(Message* m);

    };


/** Remote version of Container. */
    class VOSGUI_API RemoteContainer : public virtual Container, public virtual RemoteWidget
    {
    public:

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

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

        /** Override this to do something when a "raise" message is recieved. */
        virtual void raise();

#if 0
        virtual void hide();

        /** Send a "hidden" message to the local object, indicating that this
            remote container was closed or hidden by the user. */
        void hidden();

        /** Start listening for a "show-container" or "hide-container"  message 
          * from the local object.
          * A display client implementing the Remote GUI classes typically would
          * call this on top-level containers -- windows -- in the display. */
        void startListeningForShow(); 
    
 
#endif
    protected:

        virtual void handleRaise(Message* m);
//        virtual void handleHide(Message* m);

    };
}

#endif // #ifdef _CONTAINER_HH_

---