Struct x11rb::protocol::xproto::CursorWrapper

pub struct CursorWrapper<C: RequestConnection>(/* private fields */);

A RAII-like wrapper around a Cursor.

Instances of this struct represent a Cursor that is freed in Drop.

Any errors during Drop are silently ignored. Most likely an error here means that your X11 connection is broken and later requests will also fail.

Implementations

impl<C: RequestConnection> CursorWrapper<C>

pub fn for_cursor(conn: C, id: Cursor) -> Self

Assume ownership of the given resource and destroy it in Drop.

pub fn cursor(&self) -> Cursor

Get the XID of the wrapped resource

pub fn into_cursor(self) -> Cursor

Assume ownership of the XID of the wrapped resource

This function destroys this wrapper without freeing the underlying resource.

impl<'c, C: X11Connection> CursorWrapper<&'c C>

pub fn create_cursor_and_get_cookie<A>( conn: &'c C, source: Pixmap, mask: A, fore_red: u16, fore_green: u16, fore_blue: u16, back_red: u16, back_green: u16, back_blue: u16, x: u16, y: u16 ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

where A: Into<Pixmap>,

Create a new Cursor and return a Cursor wrapper and a cookie.

This is a thin wrapper around create_cursor that allocates an id for the Cursor. This function returns the resulting CursorWrapper that owns the created Cursor and frees it in Drop. This also returns a VoidCookie that comes from the call to create_cursor.

Errors can come from the call to X11Connection::generate_id or create_cursor.

impl<C: X11Connection> CursorWrapper<C>

pub fn create_cursor<A>( conn: C, source: Pixmap, mask: A, fore_red: u16, fore_green: u16, fore_blue: u16, back_red: u16, back_green: u16, back_blue: u16, x: u16, y: u16 ) -> Result<Self, ReplyOrIdError>

where A: Into<Pixmap>,

Create a new Cursor and return a Cursor wrapper

This is a thin wrapper around create_cursor that allocates an id for the Cursor. This function returns the resulting CursorWrapper that owns the created Cursor and frees it in Drop.

Errors can come from the call to X11Connection::generate_id or create_cursor.

impl<'c, C: X11Connection> CursorWrapper<&'c C>

pub fn create_glyph_cursor_and_get_cookie<A>( conn: &'c C, source_font: Font, mask_font: A, source_char: u16, mask_char: u16, fore_red: u16, fore_green: u16, fore_blue: u16, back_red: u16, back_green: u16, back_blue: u16 ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

where A: Into<Font>,

Create a new Cursor and return a Cursor wrapper and a cookie.

This is a thin wrapper around create_glyph_cursor that allocates an id for the Cursor. This function returns the resulting CursorWrapper that owns the created Cursor and frees it in Drop. This also returns a VoidCookie that comes from the call to create_glyph_cursor.

Errors can come from the call to X11Connection::generate_id or create_glyph_cursor.

impl<C: X11Connection> CursorWrapper<C>

pub fn create_glyph_cursor<A>( conn: C, source_font: Font, mask_font: A, source_char: u16, mask_char: u16, fore_red: u16, fore_green: u16, fore_blue: u16, back_red: u16, back_green: u16, back_blue: u16 ) -> Result<Self, ReplyOrIdError>

where A: Into<Font>,

Create a new Cursor and return a Cursor wrapper

This is a thin wrapper around create_glyph_cursor that allocates an id for the Cursor. This function returns the resulting CursorWrapper that owns the created Cursor and frees it in Drop.

Errors can come from the call to X11Connection::generate_id or create_glyph_cursor.

Trait Implementations

impl<C: Debug + RequestConnection> Debug for CursorWrapper<C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<C: RequestConnection> Drop for CursorWrapper<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C: RequestConnection> From<&CursorWrapper<C>> for Cursor

fn from(from: &CursorWrapper<C>) -> Self

Converts to this type from the input type.