CEGUIScrollbar.h

/***********************************************************************
        filename:       CEGUIScrollbar.h
        created:        13/4/2004
        author:         Paul D Turner
        
        purpose:        Interface to base class for Scrollbar widget
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIScrollbar_h_
#define _CEGUIScrollbar_h_

#include "CEGUIBase.h"
#include "CEGUIWindow.h"
#include "elements/CEGUIScrollbarProperties.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 Point& pt) const  = 0;
};

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

        /*************************************************************************
                Event name constants
        *************************************************************************/
        static const String EventScrollPositionChanged;         
        static const String EventThumbTrackStarted;                     
        static const String EventThumbTrackEnded;                               
        static const String EventScrollConfigChanged;                   

    /*************************************************************************
        Child Widget name suffix constants
    *************************************************************************/
    static const String ThumbNameSuffix;            
    static const String IncreaseButtonNameSuffix;   
    static const String DecreaseButtonNameSuffix;   

        /*************************************************************************
                Accessor functions
        *************************************************************************/
        float   getDocumentSize(void) const                     {return d_documentSize;}


        float   getPageSize(void) const                         {return d_pageSize;}


        float   getStepSize(void) const                         {return d_stepSize;}


        float   getOverlapSize(void) const                      {return d_overlapSize;}


        float   getScrollPosition(void) const           {return d_position;}


    PushButton* getIncreaseButton() const;


    PushButton* getDecreaseButton() const;


    Thumb* getThumb() const;


        /*************************************************************************
                Manipulator Commands
        *************************************************************************/
        virtual void    initialiseComponents(void);


        void    setDocumentSize(float document_size);


        void    setPageSize(float page_size);


        void    setStepSize(float step_size);


        void    setOverlapSize(float overlap_size);


        void    setScrollPosition(float position);


        /*************************************************************************
                Construction / Destruction
        *************************************************************************/
        Scrollbar(const String& type, const String& name);


        virtual ~Scrollbar(void);


protected:
        /*************************************************************************
                Implementation Methods
        *************************************************************************/
        void    updateThumb(void);


        float   getValueFromThumb(void) const;


        float   getAdjustDirectionFromPoint(const Point& pt) const;


    //virtual void    updateThumb_impl(void)   = 0;


    //virtual float   getValueFromThumb_impl(void) const   = 0;


    //virtual float   getAdjustDirectionFromPoint_impl(const Point& pt) const  = 0;


        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    testClassName_impl(const String& class_name) const
        {
                if (class_name=="Scrollbar")    return true;
                return Window::testClassName_impl(class_name);
        }

    // validate window renderer
    virtual bool validateWindowRenderer(const String& name) const
    {
        return (name == "Scrollbar");
    }

        /*************************************************************************
                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);


        /*************************************************************************
                Implementation Data
        *************************************************************************/
        float   d_documentSize;         
        float   d_pageSize;                     
        float   d_stepSize;                     
        float   d_overlapSize;          
        float   d_position;                     


private:
        /*************************************************************************
                Static Properties for this class
        *************************************************************************/
        static ScrollbarProperties::DocumentSize        d_documentSizeProperty;
        static ScrollbarProperties::PageSize            d_pageSizeProperty;
        static ScrollbarProperties::StepSize            d_stepSizeProperty;
        static ScrollbarProperties::OverlapSize         d_overlapSizeProperty;
        static ScrollbarProperties::ScrollPosition      d_scrollPositionProperty;


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

} // End of  CEGUI namespace section

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

#endif  // end of guard _CEGUIScrollbar_h_