CEGUIScrolledContainer.h

/***********************************************************************
        filename:       CEGUIScrolledContainer.h
        created:        1/3/2005
        author:         Paul D Turner
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIScrolledContainer_h_
#define _CEGUIScrolledContainer_h_

#include "CEGUIWindow.h"
#include "CEGUIWindowFactory.h"
#include "elements/CEGUIScrolledContainerProperties.h"
#include <map>

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

// Start of CEGUI namespace section
namespace CEGUI
{
    class CEGUIEXPORT ScrolledContainer : public Window
    {
    public:
        /*************************************************************************
            Constants
        *************************************************************************/
        static const String WidgetTypeName;     
        static const String EventNamespace;     
        static const String EventContentChanged;    
        static const String EventAutoSizeSettingChanged;    

        /*************************************************************************
                Object construction and destruction
        *************************************************************************/
        ScrolledContainer(const String& type, const String& name);

        ~ScrolledContainer(void);

        /*************************************************************************
                Public interface methods
        *************************************************************************/
        bool isContentPaneAutoSized(void) const;

        void setContentPaneAutoSized(bool setting);

        const Rect& getContentArea(void) const;

        void setContentArea(const Rect& area);

        Rect getChildExtentsArea(void) const;

        // Overridden from Window.
        Rect getUnclippedInnerRect_impl(void) const;

    protected:
        /*************************************************************************
                Implementation methods
        *************************************************************************/
                virtual bool    testClassName_impl(const String& class_name) const
                {
                        if (class_name=="ScrolledContainer")    return true;
                        return Window::testClassName_impl(class_name);
                }

        /*************************************************************************
                Implementation of abstract methods from Window
        *************************************************************************/
        void drawSelf(float z) {};

        /*************************************************************************
                Event trigger methods.
        *************************************************************************/
        virtual void onContentChanged(WindowEventArgs& e);

        virtual void onAutoSizeSettingChanged(WindowEventArgs& e);

        /*************************************************************************
                Event callbacks
        *************************************************************************/
        bool handleChildSized(const EventArgs& e);

        bool handleChildMoved(const EventArgs& e);

        /*************************************************************************
                Overridden from Window.
        *************************************************************************/
        void onChildAdded(WindowEventArgs& e);
        void onChildRemoved(WindowEventArgs& e);
        void onParentSized(WindowEventArgs& e);

        /*************************************************************************
                Data fields
        *************************************************************************/
        typedef std::multimap<Window*, Event::Connection>  ConnectionTracker;
        ConnectionTracker d_eventConnections;   
        Rect d_contentArea;     
        bool d_autosizePane;    

    private:
            /*************************************************************************
                    Static Properties for this class
            *************************************************************************/
            static ScrolledContainerProperties::ContentPaneAutoSized    d_autoSizedProperty;
            static ScrolledContainerProperties::ContentArea             d_contentAreaProperty;
            static ScrolledContainerProperties::ChildExtentsArea        d_childExtentsAreaProperty;

            /*************************************************************************
                    Private methods
            *************************************************************************/
            void addScrolledContainerProperties(void);
    };

} // End of  CEGUI namespace section


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

#endif  // end of guard _CEGUIScrolledContainer_h_