Interface IMouseInput

Namespace

RichHudFramework.UI

Assembly

RichHudClient.dll

Low-level mouse input handler providing cursor enter/exit detection and click events. Events are raised using the owning InputOwner as the sender.

public interface IMouseInput : IFocusableElement

Inherited Members

FocusHandler

Properties

CursorEnteredCallback

Invoked when the mouse cursor enters the element's interactive area. Event initializer.

EventHandler CursorEnteredCallback { set; }

Property Value

EventHandler

CursorExitedCallback

Invoked when the mouse cursor leaves the element's interactive area. Event initializer.

EventHandler CursorExitedCallback { set; }

Property Value

EventHandler

IsLeftClicked

Returns true if the element is currently being held down with the left mouse button.

bool IsLeftClicked { get; }

Property Value

bool

IsLeftReleased

Returns true if the element was just released after being left-clicked this frame.

bool IsLeftReleased { get; }

Property Value

bool

IsMousedOver

Returns true if the mouse cursor is currently over the element.

bool IsMousedOver { get; }

Property Value

bool

IsNewLeftClicked

Returns true if the element was just clicked with the left mouse button this frame.

bool IsNewLeftClicked { get; }

Property Value

bool

IsNewRightClicked

Returns true if the element was just clicked with the right mouse button this frame.

bool IsNewRightClicked { get; }

Property Value

bool

IsRightClicked

Returns true if the element is currently being held down with the right mouse button.

bool IsRightClicked { get; }

Property Value

bool

IsRightReleased

Returns true if the element was just released after being right-clicked this frame.

bool IsRightReleased { get; }

Property Value

bool

LeftClickedCallback

Invoked when the element is clicked with the left mouse button. Event initializer.

EventHandler LeftClickedCallback { set; }

Property Value

EventHandler

LeftReleasedCallback

Invoked when the left mouse button is released over the element. Event initializer.

EventHandler LeftReleasedCallback { set; }

Property Value

EventHandler

RequestCursor

If true, the input element will temporarily show the cursor while it's enabled.

Uses EnableCursorTemp().

bool RequestCursor { get; set; }

Property Value

bool

RightClickedCallback

Invoked when the element is clicked with the right mouse button. Event initializer.

EventHandler RightClickedCallback { set; }

Property Value

EventHandler

RightReleasedCallback

Invoked when the right mouse button is released over the element. Event initializer.

EventHandler RightReleasedCallback { set; }

Property Value

EventHandler

ToolTip

Optional tooltip text shown when the element is moused over.

ToolTip ToolTip { get; set; }

Property Value

ToolTip

Events

CursorEntered

Invoked when the mouse cursor enters the element's interactive area.

event EventHandler CursorEntered

Event Type

EventHandler

CursorExited

Invoked when the mouse cursor leaves the element's interactive area.

event EventHandler CursorExited

Event Type

EventHandler

LeftClicked

Invoked when the element is clicked with the left mouse button.

event EventHandler LeftClicked

Event Type

EventHandler

LeftReleased

Invoked when the left mouse button is released over the element.

event EventHandler LeftReleased

Event Type

EventHandler

RightClicked

Invoked when the element is clicked with the right mouse button.

event EventHandler RightClicked

Event Type

EventHandler

RightReleased

Invoked when the right mouse button is released over the element.

event EventHandler RightReleased

Event Type

EventHandler