openshot-audio
0.1.5
|
#include <juce_MouseInputSource.h>
Classes | |
struct | SourceList |
Friends | |
class | ComponentPeer |
class | Desktop |
class | MouseInputSourceInternal |
Represents a linear source of mouse events from a mouse device or individual finger in a multi-touch environment.
Each MouseEvent object contains a reference to the MouseInputSource that generated it. In an environment with a single mouse for input, all events will come from the same source, but in a multi-touch system, there may be multiple MouseInputSource obects active, each representing a stream of events coming from a particular finger.
Events coming from a single MouseInputSource are always sent in a fixed and predictable order: a mouseMove will never be called without a mouseEnter having been sent beforehand, the only events that can happen between a mouseDown and its corresponding mouseUp are mouseDrags, etc. When there are multiple touches arriving from multiple MouseInputSources, their event streams may arrive in an interleaved order, so you should use the getIndex() method to find out which finger each event came from.
|
noexcept |
|
noexcept |
|
noexcept |
Returns true if this mouse can be moved indefinitely in any direction without running out of space.
bool MouseInputSource::canHover | ( | ) | const |
Returns true if this source has an on-screen pointer that can hover over items without clicking them.
void MouseInputSource::enableUnboundedMouseMovement | ( | bool | isEnabled, |
bool | keepCursorVisibleUntilOffscreen = false |
||
) | const |
Allows the mouse to move beyond the edges of the screen.
Calling this method when the mouse button is currently pressed will remove the cursor from the screen and allow the mouse to (seem to) move beyond the edges of the screen.
This means that the coordinates returned to mouseDrag() will be unbounded, and this can be used for things like custom slider controls or dragging objects around, where movement would be otherwise be limited by the mouse hitting the edges of the screen.
The unbounded mode is automatically turned off when the mouse button is released, or it can be turned off explicitly by calling this method again.
isEnabled | whether to turn this mode on or off |
keepCursorVisibleUntilOffscreen | if set to false, the cursor will immediately be hidden; if true, it will only be hidden when it is moved beyond the edge of the screen |
void MouseInputSource::forceMouseCursorUpdate | ( | ) |
Forces an update of the mouse cursor for whatever component it's currently over.
Component * MouseInputSource::getComponentUnderMouse | ( | ) | const |
Returns the component that was last known to be under this pointer.
ModifierKeys MouseInputSource::getCurrentModifiers | ( | ) | const |
Returns a set of modifiers that indicate which buttons are currently held down on this device.
int MouseInputSource::getIndex | ( | ) | const |
Returns this source's index in the global list of possible sources. If the system only has a single mouse, there will only be a single MouseInputSource with an index of 0.
If the system supports multi-touch input, then the index will represent a finger number, starting from 0. When the first touch event begins, it will have finger number 0, and then if a second touch happens while the first is still down, it will have index 1, etc.
|
noexcept |
Returns the screen position at which the last mouse-down occurred.
|
noexcept |
Returns the time at which the last mouse-down occurred.
|
noexcept |
Returns the number of clicks that should be counted as belonging to the current mouse event. So the mouse is currently down and it's the second click of a double-click, this will return 2.
Point< float > MouseInputSource::getScreenPosition | ( | ) | const |
Returns the last-known screen position of this source.
|
noexcept |
Returns true if this input source uses a visible mouse cursor.
|
noexcept |
Returns true if this mouse is currently down, and if it has been dragged more than a couple of pixels from the place it was pressed.
bool MouseInputSource::hasMouseWheel | ( | ) | const |
Returns true if this source may have a scroll wheel.
void MouseInputSource::hideCursor | ( | ) |
Hides the mouse cursor (if there is one).
bool MouseInputSource::isDragging | ( | ) | const |
Returns true if this device is currently being pressed.
bool MouseInputSource::isMouse | ( | ) | const |
Returns true if this object represents a normal desk-based mouse device.
bool MouseInputSource::isTouch | ( | ) | const |
Returns true if this object represents a source of touch events - i.e. a finger or stylus.
bool MouseInputSource::isUnboundedMouseMovementEnabled | ( | ) | const |
Returns true if this source is currently in "unbounded" mode.
|
inlinenoexcept |
|
noexcept |
|
inlinenoexcept |
void MouseInputSource::revealCursor | ( | ) |
Un-hides the mouse cursor if it was hidden by hideCursor().
void MouseInputSource::setScreenPosition | ( | Point< float > | newPosition | ) |
Attempts to set this mouse pointer's screen position.
void MouseInputSource::showMouseCursor | ( | const MouseCursor & | cursor | ) |
Changes the mouse cursor, (if there is one).
void MouseInputSource::triggerFakeMove | ( | ) | const |
Tells the device to dispatch a mouse-move or mouse-drag event. This is asynchronous - the event will occur on the message thread.
|
friend |
|
friend |
|
friend |