vos/gui/gui/widget.hh

Go to the documentation of this file.

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

/** @file widget.hh Defines MetaObject class for gui:widget type (revision 0). */

/*  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 _WIDGET_HH_
#define _WIDGET_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>

/** VOS Graphical User Interface */
namespace VOSGUI
{

/** MetaObject implementing "gui:widget" Object Type.  */

    class VOSGUI_API Widget : public virtual MetaObject
    {

    protected:
        PropertyAccessControl* accessControl;


    public:

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

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

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

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

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

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


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



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

        /** Get the value of gui:alignment property  */
        virtual string getAlignment();

        /** Get the value of gui:padding property */
        virtual int getPadding();

        /** Get the value of the gui:proportion property. */
        virtual int getProportion();

        /** Set alignment property.
            @param value    Property value. Must be one of the following:
            <dl>
            <dt>center</dt>
            <dt>fill</dt>
            <dt>expand</dt>
            <dt>top</dt>
            <dt>bottom</dt>
            <dt>left</dt>
            <dt>right</dt>
            </dl>
            @param ac   Access control policy. If omitted, a pointer to
            NoPropertyAccessControl::static_ will be used.
        */
        virtual void setAlignment(const string& value, PropertyAccessControl* ac = 0);

        /** Set gui:padding property.
            @param value The new value
            @param ac Property access control policy. If omitted, then &NoAccessControl::static_ will be used.
        */
        virtual void setPadding(int value, PropertyAccessControl* ac = 0);

        /** Set the gui:proportion value.
         * @param value the new value
         * @param ac Property access control policy. if omitted, then
         * &NoAccessControl::static_ will be used.
         */
        virtual void setProportion(int value, PropertyAccessControl* ac = 0);

        /** Get gui:label property. 
            @throw Vobject::NoSuchObjectError if there is no label property.
            @throw bad_cast if "gui:label" is not a property.
        */
        virtual string getLabel();
        
        /** Set gui:label property. */
        virtual void setLabel(const string& value, const string& datatype = "text/plain", PropertyAccessControl* ac = 0);

        /** Set Vobject for the gui:label property. */
        virtual void setLabelObj(Property* newobj);

        /** Get datatype for label property. */
        virtual string getLabelDatatype();
            
        /** Get Vobject for the gui:label property.
            @throw Vobject::NoSuchObjectError if no label object exists
            @throw bad_cast if the label object is not a property.
        */
        virtual Property* getLabelObj();

        /** Set enabled or disabled ("dimmed") */
        virtual void setEnabled(bool q = true, PropertyAccessControl* defaultAC = &NoPropertyAccessControl::static_);

        /** Get enabled or disabled */
        virtual bool getEnabled();

        /** Set enabled or disabled object */
        virtual void setEnabledObj(Property* obj);

        /** Get enabled or disabled object */
        virtual Property* getEnabledObj();

        /** Set visible  */
        virtual void setVisible(bool q = true, PropertyAccessControl* defaultAC = &NoPropertyAccessControl::static_);

        /** Get visible  */
        virtual bool getVisible();

        /** Set visible property object */
        virtual void setVisibleObj(Property* obj);

        /** Get visible property object */
        virtual Property* getVisibleObj();
        
        
        //@}
        


    protected:
        void setOrInsertChild(const string& name, Vobject* obj);


    };



/** Local version of Widget. */
    class VOSGUI_API LocalWidget : public virtual Widget
    {

    public:

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

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

    };


/** Remote version of Widget. */
    class VOSGUI_API RemoteWidget : public virtual Widget
    {
    public:

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

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

    };
}

#endif // #ifdef _WIDGET_HH_

---