ScrolledContainer.h

/***********************************************************************
    filename:   CEGUIScrolledContainer.h
    created:    1/3/2005
    author:     Paul D Turner
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2009 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 "../Window.h"
#include "../WindowFactory.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:
    static const String WidgetTypeName;
    static const String EventNamespace;
    static const String EventContentChanged;
    static const String EventAutoSizeSettingChanged;

    ScrolledContainer(const String& type, const String& name);

    ~ScrolledContainer(void);

    bool isContentPaneAutoSized(void) const;

    void setContentPaneAutoSized(bool setting);

    const Rectf& getContentArea(void) const;

    void setContentArea(const Rectf& area);

    Rectf getChildExtentsArea(void) const;
    
    virtual const CachedRectf& getClientChildContentArea() const;
    virtual const CachedRectf& getNonClientChildContentArea() const;

    virtual void notifyScreenAreaChanged(bool recursive);
    
protected:
    // Overridden from Window.
    virtual Rectf getUnclippedInnerRect_impl(bool skipAllPixelAlignment) const;
    
    Rectf getClientChildContentArea_impl(bool skipAllPixelAlignment) const;
    
    virtual void onContentChanged(WindowEventArgs& e);

    virtual void onAutoSizeSettingChanged(WindowEventArgs& e);

    bool handleChildSized(const EventArgs& e);
    bool handleChildMoved(const EventArgs& e);

    // overridden from Window.
    void drawSelf(const RenderingContext&) {};
    Rectf getInnerRectClipper_impl() const;

    void setArea_impl(const UVector2& pos, const USize& size,
                      bool topLeftSizing = false, bool fireEvents = true);
    Rectf getHitTestRect_impl() const;
    void onChildAdded(ElementEventArgs& e);
    void onChildRemoved(ElementEventArgs& e);
    void onParentSized(ElementEventArgs& e);

    typedef std::multimap<Window*, Event::Connection>  ConnectionTracker;
    ConnectionTracker d_eventConnections;
    Rectf d_contentArea;
    bool d_autosizePane;
    
    CachedRectf d_clientChildContentArea;

private:
    void addScrolledContainerProperties(void);
};

} // End of  CEGUI namespace section


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

#endif  // end of guard _CEGUIScrolledContainer_h_