Struct Cursor 

pub struct Cursor { /* private fields */ }

A Cursor represents a cursor. Its contents are private.

This is an Abstract Base Class, you cannot instantiate it.

Properties

cursor-type

Readable | Writeable | Construct Only

display

Readable | Writeable | Construct Only

Implementations

impl Cursor

pub fn for_display(display: &Display, cursor_type: CursorType) -> Option<Cursor>

Creates a new cursor from the set of builtin cursors.

display

the Display for which the cursor will be created

cursor_type

cursor to create

Returns

a new Cursor, or None on failure

pub fn from_name(display: &Display, name: &str) -> Option<Cursor>

Creates a new cursor by looking up name in the current cursor theme.

A recommended set of cursor names that will work across different platforms can be found in the CSS specification:

• “none”
• “default”
• “help”
• “pointer”
• “context-menu”
• “progress”
• “wait”
• “cell”
• “crosshair”
• “text”
• “vertical-text”
• “alias”
• “copy”
• “no-drop”
• “move”
• “not-allowed”
• “grab”
• “grabbing”
• “all-scroll”
• “col-resize”
• “row-resize”
• “n-resize”
• “e-resize”
• “s-resize”
• “w-resize”
• “ne-resize”
• “nw-resize”
• “sw-resize”
• “se-resize”
• “ew-resize”
• “ns-resize”
• “nesw-resize”
• “nwse-resize”
• “zoom-in”
• “zoom-out”

display

the Display for which the cursor will be created

name

the name of the cursor

Returns

a new Cursor, or None if there is no cursor with the given name

pub fn from_pixbuf(display: &Display, pixbuf: &Pixbuf, x: i32, y: i32) -> Cursor

Creates a new cursor from a pixbuf.

Not all GDK backends support RGBA cursors. If they are not supported, a monochrome approximation will be displayed. The functions Display::supports_cursor_alpha() and Display::supports_cursor_color() can be used to determine whether RGBA cursors are supported; Display::default_cursor_size() and Display::maximal_cursor_size() give information about cursor sizes.

If x or y are -1, the pixbuf must have options named “x_hot” and “y_hot”, resp., containing integer values between 0 and the width resp. height of the pixbuf. (Since: 3.0)

On the X backend, support for RGBA cursors requires a sufficently new version of the X Render extension.

display

the Display for which the cursor will be created

pixbuf

the gdk_pixbuf::Pixbuf containing the cursor image

x

the horizontal offset of the “hotspot” of the cursor.

y

the vertical offset of the “hotspot” of the cursor.

Returns

a new Cursor.

pub fn from_surface( display: &Display, surface: &Surface, x: f64, y: f64, ) -> Cursor

Creates a new cursor from a cairo image surface.

Not all GDK backends support RGBA cursors. If they are not supported, a monochrome approximation will be displayed. The functions Display::supports_cursor_alpha() and Display::supports_cursor_color() can be used to determine whether RGBA cursors are supported; Display::default_cursor_size() and Display::maximal_cursor_size() give information about cursor sizes.

On the X backend, support for RGBA cursors requires a sufficently new version of the X Render extension.

display

the Display for which the cursor will be created

surface

the cairo image surface containing the cursor pixel data

x

the horizontal offset of the “hotspot” of the cursor

y

the vertical offset of the “hotspot” of the cursor

Returns

a new Cursor.

pub fn cursor_type(&self) -> CursorType

Returns the cursor type for this cursor.

Returns

a CursorType

pub fn display(&self) -> Display

Returns the display on which the Cursor is defined.

Returns

the Display associated to self

pub fn image(&self) -> Option<Pixbuf>

Returns a gdk_pixbuf::Pixbuf with the image used to display the cursor.

Note that depending on the capabilities of the windowing system and on the cursor, GDK may not be able to obtain the image data. In this case, None is returned.

Returns

a gdk_pixbuf::Pixbuf representing self, or None

pub fn surface(&self) -> (Option<Surface>, f64, f64)

Returns a cairo image surface with the image used to display the cursor.

Note that depending on the capabilities of the windowing system and on the cursor, GDK may not be able to obtain the image data. In this case, None is returned.

Returns

a cairo::Surface representing self, or None

x_hot

Location to store the hotspot x position, or None

y_hot

Location to store the hotspot y position, or None

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Cursor

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

Formats the value using the given formatter.

impl Display for Cursor

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

Formats the value using the given formatter.

impl Eq for Cursor

impl HasParamSpec for Cursor

type ParamSpec = ParamSpecObject

type SetValue = Cursor

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, Cursor>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Cursor

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Cursor

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for Cursor

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Cursor

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

Equality operator ==.

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

Inequality operator !=.

impl<OT: ObjectType> PartialOrd<OT> for Cursor

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Cursor

fn static_type() -> Type

Returns the type identifier of Self.