WidgetComponent.h

/***********************************************************************
    created:    Mon Jun 13 2005
    author:     Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIFalWidgetComponent_h_
#define _CEGUIFalWidgetComponent_h_

#include "CEGUI/falagard/Dimensions.h"
#include "CEGUI/falagard/PropertyInitialiser.h"
#include "CEGUI/falagard/EventAction.h"
#include "CEGUI/Window.h"

#if defined(_MSC_VER)
#       pragma warning(push)
#       pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{
    class CEGUIEXPORT WidgetComponent :
        public AllocatedObject<WidgetComponent>
    {
    public:
        WidgetComponent() {}
        WidgetComponent(const String& type,
                        const String& look,
                        const String& suffix,
                        const String& renderer,
                        bool autoWindow);

        void create(Window& parent) const;

        void cleanup(Window& parent) const;

        const ComponentArea& getComponentArea() const;
        void setComponentArea(const ComponentArea& area);

        const String& getBaseWidgetType() const;
        void setBaseWidgetType(const String& type);

        const String& getWidgetLookName() const;
        void setWidgetLookName(const String& look);

        const String& getWidgetName() const;
        void setWidgetName(const String& name);

        const String& getWindowRendererType() const;
        void setWindowRendererType(const String& type);

        VerticalAlignment getVerticalWidgetAlignment() const;
        void setVerticalWidgetAlignment(VerticalAlignment alignment);

        HorizontalAlignment getHorizontalWidgetAlignment() const;
        void setHorizontalWidgetAlignment(HorizontalAlignment alignment);

        void addPropertyInitialiser(const PropertyInitialiser& initialiser);
        void removePropertyInitialiser(const String& name);
        void clearPropertyInitialisers();

        void setAutoWindow(bool is_auto);
        bool isAutoWindow() const;

        void addEventAction(const EventAction& event_action);
        void clearEventActions();

        void layout(const Window& owner) const;

        void writeXMLToStream(XMLSerializer& xml_stream) const;

        const PropertyInitialiser* findPropertyInitialiser(const String& propertyName) const;

        bool handleFontRenderSizeChange(Window& window, const Font* font) const;

        static const HorizontalAlignment HorizontalAlignmentDefault;
        static const VerticalAlignment VerticalAlignmentDefault;

    private:
        typedef std::vector<PropertyInitialiser
            CEGUI_VECTOR_ALLOC(PropertyInitialiser)> PropertiesList;
        typedef std::vector<EventAction
            CEGUI_VECTOR_ALLOC(EventAction)> EventActionList;

    public:
        /*************************************************************************
            Iterator stuff
        *************************************************************************/
        typedef ConstVectorIterator<PropertiesList> PropertyIterator;
        typedef ConstVectorIterator<EventActionList> EventActionIterator;

        PropertyIterator getPropertyIterator() const;

        EventActionIterator getEventActionIterator() const;

    private:
        ComponentArea   d_area;              
        String   d_baseType;                 
        String   d_imageryName;              
        String   d_name;                     
        String   d_rendererType;             
        bool     d_autoWindow;               
        VerticalAlignment    d_vertAlign;    
        HorizontalAlignment  d_horzAlign;    
        PropertiesList  d_properties;        
        EventActionList d_eventActions;
    };

} // End of  CEGUI namespace section


#if defined(_MSC_VER)
#       pragma warning(pop)
#endif

#endif  // end of guard _CEGUIFalWidgetComponent_h_