juce_MouseEvent.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_MOUSEEVENT_H_INCLUDED
#define JUCE_MOUSEEVENT_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  MouseEvent
{
public:
    //==============================================================================
    MouseEvent (MouseInputSource source,
                Point<float> position,
                ModifierKeys modifiers,
                Component* eventComponent,
                Component* originator,
                Time eventTime,
                Point<float> mouseDownPos,
                Time mouseDownTime,
                int numberOfClicks,
                bool mouseWasDragged) noexcept;
 
    ~MouseEvent() noexcept;
 
    //==============================================================================
    const Point<float> position;
 
    const int x;
 
    const int y;
 
    const ModifierKeys mods;
 
    Component* const eventComponent;
 
    Component* const originalComponent;
 
    const Time eventTime;
 
    const Time mouseDownTime;
 
    MouseInputSource source;
 
    //==============================================================================
    int getMouseDownX() const noexcept;
 
    int getMouseDownY() const noexcept;
 
    Point<int> getMouseDownPosition() const noexcept;
 
    int getDistanceFromDragStart() const noexcept;
 
    int getDistanceFromDragStartX() const noexcept;
 
    int getDistanceFromDragStartY() const noexcept;
 
    Point<int> getOffsetFromDragStart() const noexcept;
 
    bool mouseWasClicked() const noexcept;
 
    int getNumberOfClicks() const noexcept                              { return numberOfClicks; }
 
    int getLengthOfMousePress() const noexcept;
 
    //==============================================================================
    Point<int> getPosition() const noexcept;
 
    int getScreenX() const;
 
    int getScreenY() const;
 
    Point<int> getScreenPosition() const;
 
    int getMouseDownScreenX() const;
 
    int getMouseDownScreenY() const;
 
    Point<int> getMouseDownScreenPosition() const;
 
    //==============================================================================
    MouseEvent getEventRelativeTo (Component* newComponent) const noexcept;
 
    MouseEvent withNewPosition (Point<float> newPosition) const noexcept;
 
    MouseEvent withNewPosition (Point<int> newPosition) const noexcept;
 
    //==============================================================================
    static void setDoubleClickTimeout (int timeOutMilliseconds) noexcept;
 
    static int getDoubleClickTimeout() noexcept;
 
 
private:
    //==============================================================================
    const Point<float> mouseDownPos;
    const uint8 numberOfClicks, wasMovedSinceMouseDown;
 
    MouseEvent& operator= (const MouseEvent&);
};
 
 
//==============================================================================
struct MouseWheelDetails
{
    //==============================================================================
    float deltaX;
 
    float deltaY;
 
    bool isReversed;
 
    bool isSmooth;
 
    bool isInertial;
};
 
 
#endif   // JUCE_MOUSEEVENT_H_INCLUDED