114 lines
4.1 KiB
C++
114 lines
4.1 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE library.
|
|
Copyright (c) 2017 - ROLI Ltd.
|
|
|
|
JUCE is an open source library subject to commercial or open-source
|
|
licensing.
|
|
|
|
By using JUCE, you agree to the terms of both the JUCE 5 End-User License
|
|
Agreement and JUCE 5 Privacy Policy (both updated and effective as of the
|
|
27th April 2017).
|
|
|
|
End User License Agreement: www.juce.com/juce-5-licence
|
|
Privacy Policy: www.juce.com/juce-5-privacy-policy
|
|
|
|
Or: You may also use this code under the terms of the GPL v3 (see
|
|
www.gnu.org/licenses).
|
|
|
|
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
|
|
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
|
|
DISCLAIMED.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
namespace juce
|
|
{
|
|
|
|
//==============================================================================
|
|
/**
|
|
This object watches for mouse-events happening within a component, and if
|
|
the mouse remains still for long enough, triggers an event to indicate that
|
|
it has become inactive.
|
|
|
|
You'd use this for situations where e.g. you want to hide the mouse-cursor
|
|
when the user's not actively using the mouse.
|
|
|
|
After creating an instance of this, use addListener to get callbacks when
|
|
the activity status changes.
|
|
|
|
@tags{GUI}
|
|
*/
|
|
class JUCE_API MouseInactivityDetector : private Timer,
|
|
private MouseListener
|
|
{
|
|
public:
|
|
/** Creates an inactivity watcher, attached to the given component.
|
|
The target component must not be deleted while this - it will be monitored
|
|
for any mouse events in it or its child components.
|
|
*/
|
|
MouseInactivityDetector (Component& target);
|
|
|
|
/** Destructor. */
|
|
~MouseInactivityDetector() override;
|
|
|
|
/** Sets the time for which the mouse must be still before the callback
|
|
is triggered.
|
|
*/
|
|
void setDelay (int newDelayMilliseconds) noexcept;
|
|
|
|
/** Sets the number of pixels by which the cursor is allowed to drift before it is
|
|
considered to be actively moved.
|
|
*/
|
|
void setMouseMoveTolerance (int pixelsNeededToTrigger) noexcept;
|
|
|
|
//==============================================================================
|
|
/** Classes should implement this to receive callbacks from a MouseInactivityDetector
|
|
when the mouse becomes active or inactive.
|
|
*/
|
|
class Listener
|
|
{
|
|
public:
|
|
virtual ~Listener() = default;
|
|
|
|
/** Called when the mouse is moved or clicked for the first time
|
|
after a period of inactivity. */
|
|
virtual void mouseBecameActive() = 0;
|
|
|
|
/** Called when the mouse hasn't been moved for the timeout period. */
|
|
virtual void mouseBecameInactive() = 0;
|
|
};
|
|
|
|
/** Registers a listener. */
|
|
void addListener (Listener* listener);
|
|
|
|
/** Removes a previously-registered listener. */
|
|
void removeListener (Listener* listener);
|
|
|
|
private:
|
|
//==============================================================================
|
|
Component& targetComp;
|
|
ListenerList<Listener> listenerList;
|
|
Point<int> lastMousePos;
|
|
int delayMs = 1500, toleranceDistance = 15;
|
|
bool isActive = true;
|
|
|
|
void timerCallback() override;
|
|
void wakeUp (const MouseEvent&, bool alwaysWake);
|
|
void setActive (bool);
|
|
|
|
void mouseMove (const MouseEvent& e) override { wakeUp (e, false); }
|
|
void mouseEnter (const MouseEvent& e) override { wakeUp (e, false); }
|
|
void mouseExit (const MouseEvent& e) override { wakeUp (e, false); }
|
|
void mouseDown (const MouseEvent& e) override { wakeUp (e, true); }
|
|
void mouseDrag (const MouseEvent& e) override { wakeUp (e, true); }
|
|
void mouseUp (const MouseEvent& e) override { wakeUp (e, true); }
|
|
void mouseWheelMove (const MouseEvent& e, const MouseWheelDetails&) override { wakeUp (e, true); }
|
|
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (MouseInactivityDetector)
|
|
};
|
|
|
|
} // namespace juce
|