widgets/Scrollbar.h

/***********************************************************************
    created:    13/4/2004
    author:     Paul D Turner
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2012 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 _CEGUIScrollbar_h_
#define _CEGUIScrollbar_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 ScrollbarWindowRenderer : public WindowRenderer
{
public:
    ScrollbarWindowRenderer(const String& name);

    virtual void updateThumb(void) = 0;

    virtual float getValueFromThumb(void) const = 0;

    virtual float getAdjustDirectionFromPoint(const Vector2f& pt) const  = 0;
};

class CEGUIEXPORT Scrollbar : public Window
{
public:
    static const String WidgetTypeName;

    static const String EventNamespace;
    static const String EventScrollPositionChanged;
    static const String EventThumbTrackStarted;
    static const String EventThumbTrackEnded;
    static const String EventScrollConfigChanged;

    static const String ThumbName;
    static const String IncreaseButtonName;
    static const String DecreaseButtonName;

    float getDocumentSize(void) const
    {
        return d_documentSize;
    }

    void setDocumentSize(float document_size);

    float getPageSize(void) const
    {
        return d_pageSize;
    }

    void setPageSize(float page_size);

    float getStepSize(void) const
    {
        return d_stepSize;
    }

    void setStepSize(float step_size);

    float getOverlapSize(void) const
    {
        return d_overlapSize;
    }

    void setOverlapSize(float overlap_size);

    float getScrollPosition(void) const
    {
        return d_position;
    }

    void setScrollPosition(float position);

    float getUnitIntervalScrollPosition() const;
    void setUnitIntervalScrollPosition(float position);

    PushButton* getIncreaseButton() const;

    PushButton* getDecreaseButton() const;

    Thumb* getThumb() const;

    void setConfig(const float* const document_size,
                   const float* const page_size,
                   const float* const step_size,
                   const float* const overlap_size,
                   const float* const position);

    void setEndLockEnabled(const bool enabled);

    bool isEndLockEnabled() const;

    void scrollForwardsByStep();
    void scrollBackwardsByStep();

    void scrollForwardsByPage();
    void scrollBackwardsByPage();

    Scrollbar(const String& type, const String& name);
    ~Scrollbar(void);

    // overrides
    void initialiseComponents(void);

protected:
    void updateThumb(void);

    float getValueFromThumb(void) const;

    float getAdjustDirectionFromPoint(const Vector2f& pt) const;

    bool setScrollPosition_impl(const float position);

    bool isAtEnd() const;

    float getMaxScrollPosition() const;

    bool handleThumbMoved(const EventArgs& e);

    bool handleIncreaseClicked(const EventArgs& e);

    bool handleDecreaseClicked(const EventArgs& e);

    bool handleThumbTrackStarted(const EventArgs& e);

    bool handleThumbTrackEnded(const EventArgs& e);

    virtual bool validateWindowRenderer(const WindowRenderer* renderer) const;

    // New event handlers for slider widget
    virtual void onScrollPositionChanged(WindowEventArgs& e);

    virtual void onThumbTrackStarted(WindowEventArgs& e);

    virtual void onThumbTrackEnded(WindowEventArgs& e);

    virtual void onScrollConfigChanged(WindowEventArgs& e);

    // Overridden event handlers
    virtual void onMouseButtonDown(MouseEventArgs& e);
    virtual void onMouseWheel(MouseEventArgs& e);

    // base class overrides
    void banPropertiesForAutoWindow();

    // Implementation Data
    float d_documentSize;
    float d_pageSize;
    float d_stepSize;
    float d_overlapSize;
    float d_position;
    bool d_endLockPosition;

private:
    void addScrollbarProperties(void);
};

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIScrollbar_h_