urho3d/Engine/UI/ScrollView.h

//
// Urho3D Engine
// Copyright (c) 2008-2011 Lasse Öörni
//
// 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 OR COPYRIGHT HOLDERS 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 UI_SCROLLVIEW_H
#define UI_SCROLLVIEW_H

#include "BorderImage.h"

class Slider;

//! A scrollable view for showing child widgets
class ScrollView : public BorderImage
{
    DEFINE_TYPE(ScrollView);
    
public:
    //! Construct with name
    ScrollView(const std::string& name = std::string());
    //! Destruct
    virtual ~ScrollView();
    
    //! Set UI element style from XML data
    virtual void setStyle(const XMLElement& element, ResourceCache* cache);
    //! Perform UI element update
    virtual void update(float timeStep);
    
    //! Set view offset from the top-left corner
    void setViewPosition(const IntVector2& position);
    //! Set view offset from the top-left corner
    void setViewPosition(int x, int y);
    //! Set total view size
    void setViewSize(const IntVector2& position);
    //! Set total view size
    void setViewSize(int x, int y);
    //! Set horizontal slider
    void setHorizontalSlider(Slider* slider);
    //! Set vertical slider
    void setVerticalSlider(Slider* slider);
    
    //! Return view offset from the top-left corner
    const IntVector2& getViewPosition() const { return mViewPosition; }
    //! Return total view size
    const IntVector2& getViewSize() const { return mViewSize; }
    //! Return horizontal slider
    Slider* getHorizontalSlider() const { return mHorizontalSlider; }
    //! Return vertical slider
    Slider* getVerticalSlider() const { return mVerticalSlider; }
    
protected:
    //! Update the view from sliders if available
    void updateViewFromSliders();
    //! Update the sliders' ranges and positions
    void updateSliders();
    //! Limit and update view with a new position
    void updateView(const IntVector2& position);
    
    //! Horizontal slider
    WeakPtr<Slider> mHorizontalSlider;
    //! Vertical slider
    WeakPtr<Slider> mVerticalSlider;
    //! Current view offset from the top-left corner
    IntVector2 mViewPosition;
    //! Total view size
    IntVector2 mViewSize;
    //! Last known own size
    IntVector2 mLastSize;
};

#endif // UI_SCROLLVIEW_H