Struct native_windows_gui::Cursor

pub struct Cursor {
    pub handle: HANDLE,
    /* private fields */
}

A wrapper over a cursor file (*.cur)

Cursor resources can be used with the cursor feature

Example:

use native_windows_gui as nwg;

fn load_cursor() -> nwg::Cursor {
    nwg::Cursor::from_file("Hello.cur", true).unwrap()
}

fn load_cursor_builder() -> nwg::Cursor {
    let mut cursor = nwg::Cursor::default();

    nwg::Cursor::builder()
        .source_file(Some("Hello.cur"))
        .strict(true)
        .build(&mut cursor)
        .unwrap();

    cursor
}

Fields

handle: HANDLE

Implementations

impl Cursor

pub fn builder<'a>() -> CursorBuilder<'a>

pub fn from_system(cursor: OemCursor) -> Cursor

pub fn from_file(path: &str, strict: bool) -> Result<Cursor, NwgError>

Single line helper function over the cursor builder api.

Use a file resource.

pub fn from_embed(
    embed: &EmbedResource,
    embed_id: Option<usize>,
    embed_str: Option<&str>
) -> Result<Cursor, NwgError>

Single line helper function over the cursor builder api.

Use an embedded resource. Either embed_id or embed_str must be defined, not both.

Requires the embed-resource feature.

Trait Implementations

impl Default for Cursor

fn default() -> Cursor

Returns the “default value” for a type.

impl Drop for Cursor

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<Cursor> for Cursor

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.