juce_MouseInputSource.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_MOUSEINPUTSOURCE_H_INCLUDED
#define JUCE_MOUSEINPUTSOURCE_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  MouseInputSource
{
public:
    //==============================================================================
    MouseInputSource (const MouseInputSource&) noexcept;
    MouseInputSource& operator= (const MouseInputSource&) noexcept;
    ~MouseInputSource() noexcept;
 
    //==============================================================================
    bool operator== (const MouseInputSource& other) const noexcept     { return pimpl == other.pimpl; }
    bool operator!= (const MouseInputSource& other) const noexcept     { return pimpl != other.pimpl; }
 
    //==============================================================================
    bool isMouse() const;
 
    bool isTouch() const;
 
    bool canHover() const;
 
    bool hasMouseWheel() const;
 
    int getIndex() const;
 
    bool isDragging() const;
 
    Point<float> getScreenPosition() const;
 
    ModifierKeys getCurrentModifiers() const;
 
    Component* getComponentUnderMouse() const;
 
    void triggerFakeMove() const;
 
    int getNumberOfMultipleClicks() const noexcept;
 
    Time getLastMouseDownTime() const noexcept;
 
    Point<float> getLastMouseDownPosition() const noexcept;
 
    bool hasMouseMovedSignificantlySincePressed() const noexcept;
 
    bool hasMouseCursor() const noexcept;
 
    void showMouseCursor (const MouseCursor& cursor);
 
    void hideCursor();
 
    void revealCursor();
 
    void forceMouseCursorUpdate();
 
    bool canDoUnboundedMovement() const noexcept;
 
    void enableUnboundedMouseMovement (bool isEnabled, bool keepCursorVisibleUntilOffscreen = false) const;
 
    bool isUnboundedMouseMovementEnabled() const;
 
    void setScreenPosition (Point<float> newPosition);
 
private:
    //==============================================================================
    friend class ComponentPeer;
    friend class Desktop;
    friend class MouseInputSourceInternal;
    MouseInputSourceInternal* pimpl;
 
    struct SourceList;
 
    explicit MouseInputSource (MouseInputSourceInternal*) noexcept;
    void handleEvent (ComponentPeer&, Point<float>, int64 time, ModifierKeys);
    void handleWheel (ComponentPeer&, Point<float>, int64 time, const MouseWheelDetails&);
    void handleMagnifyGesture (ComponentPeer&, Point<float>, int64 time, float scaleFactor);
 
    static Point<float> getCurrentRawMousePosition();
    static void setRawMousePosition (Point<float>);
 
    JUCE_LEAK_DETECTOR (MouseInputSource)
};
 
 
#endif   // JUCE_MOUSEINPUTSOURCE_H_INCLUDED