SMouseDetector
Overview
SMouseDetector is a compound Slate widget that extends SCompoundWidget. It provides a mechanism for detecting and handling different types of mouse events such as button down, button up, mouse move, double click, drag, hover, and drop. The widget allows users to bind custom event handlers through its constructor arguments.
Properties
Type | Name | Access | Description |
|---|---|---|---|
| OnMouseButtonDown | Public | Handler for mouse button down events. |
| OnMouseButtonUp | Public | Handler for mouse button up events. |
| OnMouseMove | Public | Handler for mouse move events. |
| OnMouseDoubleClick | Public | Handler for mouse double click events. |
| OnMouseDrag | Public | Handler for mouse drag events. |
| OnMouseHover | Public | Handler for mouse hover events. |
| OnMouseUnHover | Public | Handler for mouse unhover events. |
| OnDragOver | Public | Handler for drag over events. |
| OnDrop | Public | Handler for drop events. |
Functions
Return Type | Signature | Description |
|---|---|---|
|
| Handles the detection of a drag event and invokes the bound mouse drag handler if available. Returns |
|
| Handles the detection of a drag over event and invokes the bound drag over handler if available. Returns |
|
| Handles the detection of a drop event and invokes the bound drop handler if available. Returns |
Usage & Implementation Notes
The widget is designed to be used within a Slate UI system.
It requires binding specific mouse event handlers through its constructor arguments.
The widget does not manage memory for the event handlers; they are managed by the user who binds them.