Struct native_windows_gui::GlobalCursor

pub struct GlobalCursor;

A global object that wraps the system cursor. This object must not be instanced. The methods should be used this way:

Requires the cursor feature.

use native_windows_gui as nwg;
let (x,y) = nwg::GlobalCursor::position();

Implementations

impl GlobalCursor

pub fn position() -> (i32, i32)

Return the cursor position in the screen.

pub fn local_position<C: Into<ControlHandle>>(
    control: C,
    point: Option<(i32, i32)>
) -> (i32, i32)

Return or map the cursor position relatively to a control. If point is None, Cursor::position is used.

pub fn set_position(x: i32, y: i32)

Set the cursor position in the screen.

Arguments: • x: The new x coordinates of the cursor • y: The new y coordinaets of the cursor

pub fn set(cursor: &Cursor)

Set the cursor image. If your application must set the cursor while it is in a window, make sure the class cursor for the specified window's class is set to NULL. If the class cursor is not NULL, the system restores the class cursor each time the mouse is moved.

Arguments: • cursor: The id identifying the cursor resource

pub fn get() -> Option<Cursor>

Get the cursor image

Returns None if there is no cursor.

pub fn set_capture(control: &ControlHandle)

Capture the mouse for a window-like control. Make sure to call Cursor::release to remove the capture. A control that has captured the mouse will receive mouse events even if the mouse is not hovering it.

Will panic if the control handle passed to the method is not a window or if the control is not yet initialized.

Arguments: • control: The control that will capture the mouse input

pub fn release()

Release the cursor if it was captured with Cursor::set_capture

pub fn capture() -> Option<ControlHandle>

Return the handle of the control that has captured the mouse. Return None if no control captured the cursor.

Arguments: • ui: The Ui holding the cursor resource

pub fn dragging(control: &ControlHandle, point: Option<(i32, i32)>) -> bool

Captures the mouse and tracks its movement until the user releases the left button, presses the ESC key, or moves the mouse outside the drag rectangle around the specified point.

Return Ok(true) if the user did not execute the actions mentioned above or Ok(false) if it did.

Will panic if the control handle passed to the method is not a window or if the control is not yet initialized.

Arguments: • control: The control that will capture the mouse input • point: A point in screen coordinates where the dragging begins. If None, use the Cursor::position value.

    use native_windows_gui as nwg;
    fn dragging(c: &nwg::Window) {
        if nwg::GlobalCursor::dragging(&c.handle, None) {
            println!("DRAGGING!")
        }
    }