The IMouse interface represents the virtual machine's mouse. More...
Public Member Functions | |
void | putMouseEvent (in long dx, in long dy, in long dz, in long dw, in long buttonState) |
Initiates a mouse event using relative pointer movements along x and y axis. | |
void | putMouseEventAbsolute (in long x, in long y, in long dz, in long dw, in long buttonState) |
Positions the mouse pointer using absolute x and y coordinates. | |
Public Attributes | |
readonly attribute boolean | absoluteSupported |
Whether the guest OS supports absolute mouse pointer positioning or not. | |
readonly attribute boolean | relativeSupported |
Whether the guest OS supports relative mouse pointer positioning or not. | |
readonly attribute boolean | needsHostCursor |
Whether the guest OS can currently switch to drawing it's own mouse cursor on demand. |
The IMouse interface represents the virtual machine's mouse.
Used in IConsole::mouse.
Through this interface, the virtual machine's virtual mouse can be controlled.
{7C0F2EAE-F92D-498C-B802-E1A3763774DC}
void IMouse::putMouseEvent | ( | in long | dx, | |
in long | dy, | |||
in long | dz, | |||
in long | dw, | |||
in long | buttonState | |||
) |
Initiates a mouse event using relative pointer movements along x and y axis.
dx | Amount of pixels the mouse should move to the right. Negative values move the mouse to the left. | |||||||
dy | Amount of pixels the mouse should move downwards. Negative values move the mouse upwards. | |||||||
dz | Amount of mouse wheel moves. Positive values describe clockwise wheel rotations, negative values describe counterclockwise rotations. | |||||||
dw | Amount of horizontal mouse wheel moves. Positive values describe a movement to the left, negative values describe a movement to the right. | |||||||
buttonState | The current state of mouse buttons. Every bit represents a mouse button as follows:
A value of |
E_ACCESSDENIED | Console not powered up. |
VBOX_E_IPRT_ERROR | Could not send mouse event to virtual mouse. |
void IMouse::putMouseEventAbsolute | ( | in long | x, | |
in long | y, | |||
in long | dz, | |||
in long | dw, | |||
in long | buttonState | |||
) |
Positions the mouse pointer using absolute x and y coordinates.
These coordinates are expressed in pixels and start from [1,1]
which corresponds to the top left corner of the virtual display.
x | X coordinate of the pointer in pixels, starting from 1 . | |||||||
y | Y coordinate of the pointer in pixels, starting from 1 . | |||||||
dz | Amount of mouse wheel moves. Positive values describe clockwise wheel rotations, negative values describe counterclockwise rotations. | |||||||
dw | Amount of horizontal mouse wheel moves. Positive values describe a movement to the left, negative values describe a movement to the right. | |||||||
buttonState | The current state of mouse buttons. Every bit represents a mouse button as follows:
A value of |
E_ACCESSDENIED | Console not powered up. |
VBOX_E_IPRT_ERROR | Could not send mouse event to virtual mouse. |
readonly attribute boolean IMouse::absoluteSupported |
Whether the guest OS supports absolute mouse pointer positioning or not.
readonly attribute boolean IMouse::relativeSupported |
Whether the guest OS supports relative mouse pointer positioning or not.
readonly attribute boolean IMouse::needsHostCursor |
Whether the guest OS can currently switch to drawing it's own mouse cursor on demand.