widgets/ScrollablePane.h

/***********************************************************************
    filename:   CEGUIScrollablePane.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 _CEGUIScrollablePane_h_
#define _CEGUIScrollablePane_h_

#include "../Base.h"
#include "../Window.h"

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

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT ScrollablePaneWindowRenderer : public WindowRenderer
{
public:
    ScrollablePaneWindowRenderer(const String& name);

    virtual Rectf getViewableArea(void) const = 0;
};

class CEGUIEXPORT ScrollablePane : public Window
{
public:
    static const String WidgetTypeName;
    static const String EventNamespace;
    static const String EventContentPaneChanged;
    static const String EventVertScrollbarModeChanged;
    static const String EventHorzScrollbarModeChanged;
    static const String EventAutoSizeSettingChanged;
    static const String EventContentPaneScrolled;
    static const String VertScrollbarName;
    static const String HorzScrollbarName;
    static const String ScrolledContainerName;

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

    ~ScrollablePane(void);

    const ScrolledContainer* getContentPane(void) const;

    bool isVertScrollbarAlwaysShown(void) const;

    void setShowVertScrollbar(bool setting);

    bool isHorzScrollbarAlwaysShown(void) const;

    void setShowHorzScrollbar(bool setting);

    bool isContentPaneAutoSized(void) const;

    void setContentPaneAutoSized(bool setting);

    const Rectf& getContentPaneArea(void) const;

    void setContentPaneArea(const Rectf& area);

    float getHorizontalStepSize(void) const;

    void setHorizontalStepSize(float step);

    float getHorizontalOverlapSize(void) const;

    void setHorizontalOverlapSize(float overlap);

    float getHorizontalScrollPosition(void) const;

    void setHorizontalScrollPosition(float position);

    float getVerticalStepSize(void) const;

    void setVerticalStepSize(float step);

    float getVerticalOverlapSize(void) const;

    void setVerticalOverlapSize(float overlap);

    float getVerticalScrollPosition(void) const;

    void setVerticalScrollPosition(float position);

    Rectf getViewableArea(void) const;

    Scrollbar* getVertScrollbar() const;

    Scrollbar* getHorzScrollbar() const;

    // Overridden from Window
    void initialiseComponents(void);
    void destroy(void);

protected:
    void configureScrollbars(void);

    bool isVertScrollbarNeeded(void) const;

    bool isHorzScrollbarNeeded(void) const;

    void updateContainerPosition(void);

    ScrolledContainer* getScrolledContainer() const;

    // validate window renderer
    virtual bool validateWindowRenderer(const WindowRenderer* renderer) const;

    /*************************************************************************
        Event triggers
    *************************************************************************/
    virtual void onContentPaneChanged(WindowEventArgs& e);

    virtual void onVertScrollbarModeChanged(WindowEventArgs& e);

    virtual void onHorzScrollbarModeChanged(WindowEventArgs& e);

    virtual void onAutoSizeSettingChanged(WindowEventArgs& e);

    virtual void onContentPaneScrolled(WindowEventArgs& e);

    /*************************************************************************
        Event handler methods
    *************************************************************************/
    bool handleScrollChange(const EventArgs& e);

    bool handleContentAreaChange(const EventArgs& e);

    bool handleAutoSizePaneChanged(const EventArgs& e);

    // Overridden from Window
    void addChild_impl(Element* element);
    void removeChild_impl(Element* element);
    
    void onSized(ElementEventArgs& e);
    void onMouseWheel(MouseEventArgs& e);

    NamedElement* getChildByNamePath_impl(const String& name_path) const;

    bool d_forceVertScroll;
    bool d_forceHorzScroll;
    Rectf d_contentRect;
    float d_vertStep;
    float d_vertOverlap;
    float d_horzStep;
    float d_horzOverlap;
    Event::Connection d_contentChangedConn;
    Event::Connection d_autoSizeChangedConn;

private:
    void addScrollablePaneProperties(void);
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIScrollablePane_h_