vos/gui/gui/display.hh

Go to the documentation of this file.

/* $Id: display.hh,v 1.6 2003/07/24 05:18:26 tetron 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 _VOSGUI_DISPLAY_HH_
#define _VOSGUI_DISPLAY_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 "container.hh"

namespace VOSGUI
{

    class VOSGUI_API Display : public virtual MetaObject
    {

    protected:
        PropertyAccessControl* accessControl;

    public:

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

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

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

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

        /** Initialize required subproperties and set given access control as 
            default. */
        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();

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

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

        /** Name of display application, etc. */
        //@{
        string getAppInfo();    ///< @throw NoSuchObjectError
        void setAppInfo(const string& value, PropertyAccessControl* ac = 0);
        //@}

        /** User of this display ("user" or "user@host") */
        //@{
        string getUserId();   ///< @throw NoSuchObjectError
        void setUserId(const string& value, PropertyAccessControl* ac = 0);
        //@}

        /** Whether or not this display object is run by a GUI display client.
            (Some applications may use display objects but not actually
            display a GUI) */
        //@{
        bool getAppDedicated(); ///< @throw NoSuchObjectError
        void setAppDedicated(bool value, PropertyAccessControl* ac = 0);
        //@}

        /** Add c to the display as a new window. If it already exists
            in the display, a "show" message is sent instead. 
            @param c The container to add to the display.
            @param contextName Contextual name of c in the display object. If
                omitted or "" (empty string), then c's site name is used.
        */
        virtual void addWindow(Container* c, const string& contextName = "");

        /** Alternative to addWondow */
        inline void addContainer(Container* c, const string& contextName="") {
            addWindow(c, contextName);
        }

        /** Remove c from the display. 
            @throw Vobject::NoSuchObjectError if c is not in the display.
        */
        virtual void removeWindow(Container* c);

        /** Alternative to removeWindow */
        inline void removeContainer(Container* c) {
            removeWindow(c);
        }

        /** Add a secondary display object to this display */
        virtual void addSubDisplay(Display* d, const string& cname = "");
        
        /** Remove a secondary display object from this display */
        virtual void removeSubDisplay(Display* d);
    };



    class VOSGUI_API LocalDisplay : public virtual Display
    {

    public:

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

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

    };


/** Remote version of Display. */
    class VOSGUI_API RemoteDisplay : public virtual Display
    {
    public:

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

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

    };
}

#endif // #ifdef _VOSGUI_DISPLAY_HH_

---