DragContainer.h

/***********************************************************************
        filename:       CEGUIDragContainer.h
        created:        14/2/2005
        author:         Paul D Turner
*************************************************************************/
/***************************************************************************
 *   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 _CEGUIDragContainer_h_
#define _CEGUIDragContainer_h_

#include "../Window.h"
#include "../WindowFactory.h"

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

// Start of CEGUI namespace section
namespace CEGUI
{
    class CEGUIEXPORT DragContainer : public Window
    {
    public:
        /*************************************************************************
            Constants
        *************************************************************************/
        static const String WidgetTypeName;     
        static const String EventNamespace;     

        static const String EventDragStarted;
        static const String EventDragEnded;
        static const String EventDragPositionChanged;
        static const String EventDragEnabledChanged;
        static const String EventDragAlphaChanged;
        static const String EventDragMouseCursorChanged;
        static const String EventDragThresholdChanged;
        static const String EventDragDropTargetChanged;

        /*************************************************************************
            Object Construction and Destruction
        *************************************************************************/
        DragContainer(const String& type, const String& name);

        virtual ~DragContainer(void);

        /*************************************************************************
                Public Interface to DragContainer
        *************************************************************************/
        bool isDraggingEnabled(void) const;

        void setDraggingEnabled(bool setting);

        bool isBeingDragged(void) const;

        float getPixelDragThreshold(void) const;

        void setPixelDragThreshold(float pixels);

        float getDragAlpha(void) const;

        void setDragAlpha(float alpha);

        const Image* getDragCursorImage(void) const;

        void setDragCursorImage(const Image* image);

        void setDragCursorImage(const String& name);

        Window* getCurrentDropTarget(void) const;

        bool isStickyModeEnabled() const;

        void setStickyModeEnabled(bool setting);

        bool pickUp(const bool force_sticky = false);

        void setFixedDragOffset(const UVector2& offset);

        const UVector2& getFixedDragOffset() const;

        void setUsingFixedDragOffset(const bool enable);

        bool isUsingFixedDragOffset() const;

        // Window class overrides.
        void getRenderingContext_impl(RenderingContext& ctx) const;

    protected:
        /*************************************************************************
                Protected Implementation Methods
        *************************************************************************/
        bool isDraggingThresholdExceeded(const Vector2f& local_mouse);

        void initialiseDragging(void);

        void doDragging(const Vector2f& local_mouse);

        void updateActiveMouseCursor(void) const;

        /*************************************************************************
                Overrides of methods in Window
        *************************************************************************/

        /*************************************************************************
                Overrides for Event handler methods
        *************************************************************************/
        virtual void onMouseButtonDown(MouseEventArgs& e);
        virtual void onMouseButtonUp(MouseEventArgs& e);
        virtual void onMouseMove(MouseEventArgs& e);
        virtual void onCaptureLost(WindowEventArgs& e);
        virtual void onAlphaChanged(WindowEventArgs& e);
        virtual void onClippingChanged(WindowEventArgs& e);/*Window::drawSelf(z);*/
        virtual void onMoved(ElementEventArgs& e);

        /*************************************************************************
                New Event handler methods
        *************************************************************************/
        virtual void onDragStarted(WindowEventArgs& e);

        virtual void onDragEnded(WindowEventArgs& e);

        virtual void onDragPositionChanged(WindowEventArgs& e);

        virtual void onDragEnabledChanged(WindowEventArgs& e);

        virtual void onDragAlphaChanged(WindowEventArgs& e);

        virtual void onDragMouseCursorChanged(WindowEventArgs& e);

        virtual void onDragThresholdChanged(WindowEventArgs& e);

        virtual void onDragDropTargetChanged(DragDropEventArgs& e);

        /*************************************************************************
                Data
        *************************************************************************/
        bool    d_draggingEnabled;  
        bool    d_leftMouseDown;    
        bool    d_dragging;         
        UVector2 d_dragPoint;       
        UVector2 d_startPosition;   
        float   d_dragThreshold;    
        float   d_dragAlpha;        
        float   d_storedAlpha;      
        bool    d_storedClipState;  
        Window* d_dropTarget;       
        const Image* d_dragCursorImage; 
        bool d_dropflag;            

        bool d_stickyMode;
        bool d_pickedUp;
        bool d_usingFixedDragOffset;
        UVector2 d_fixedDragOffset;

    private:
        /*************************************************************************
                Implementation methods
        *************************************************************************/
        void addDragContainerProperties(void);
    };

} // End of  CEGUI namespace section


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

#endif  // end of guard _CEGUIDragContainer_h_