Documentation

Version:

Version:

MouseEventBase<T>

The base class for mouse events.

Read time 2 minutes

Last updated 5 days ago


public abstract class MouseEventBase<T> : EventBase<T>, IDisposable, IMouseEvent where T : MouseEventBase<T>, new()

Property	Description
actionKey	Returns true if the platform-specific action key is pressed. This key is Cmd on macOS, and Ctrl on all other platforms.
altKey	Returns true if the Alt key is pressed.
button	A value that indicates which mouse button was pressed or released (if any) to cause this event: 0 is the left button, 1 is the right button, 2 is the middle button. A negative value indicates that no mouse button changed state during this event.
clickCount	The number of times the button is pressed.
commandKey	Returns true if the Windows/Cmd key is pressed.
ctrlKey	Returns true if the Ctrl key is pressed.
currentTarget	The current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed.
localMousePosition	The mouse position in the current target coordinate system.
modifiers	Flags that hold pressed modifier keys (Alt, Ctrl, Shift, Windows/Cmd).
mouseDelta	The difference of the mouse position between the previous mouse event and the current mouse event.
mousePosition	The mouse position in the screen coordinate system.
pressedButtons	A bitmask that describes the currently pressed buttons.
shiftKey	Returns true if the Shift key is pressed.

Method	Description
Init	Resets the event members to their initial values.

Method	Description
GetPooled	Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use `Dispose()` to release them.