Struct Cursor

pub struct Cursor { /* private fields */ }

Cursor is used to create and destroy cursors.

Cursors are immutable objects, so once you created them, there is no way to modify them later. You should create a new cursor when you want to change something about it.

Cursors by themselves are not very interesting: they must be bound to a window for users to see them. This is done with SurfaceExt::set_cursor() or SurfaceExt::set_device_cursor(). Applications will typically use higher-level GTK functions such as gtk_widget_set_cursor() instead.

Cursors are not bound to a given Display, so they can be shared. However, the appearance of cursors may vary when used on different platforms.

Named and texture cursors

There are multiple ways to create cursors. The platform’s own cursors can be created with from_name(). That function lists the commonly available names that are shared with the CSS specification. Other names may be available, depending on the platform in use. On some platforms, what images are used for named cursors may be influenced by the cursor theme.

Another option to create a cursor is to use from_texture() and provide an image to use for the cursor.

To ease work with unsupported cursors, a fallback cursor can be provided. If a Surface cannot use a cursor because of the reasons mentioned above, it will try the fallback cursor. Fallback cursors can themselves have fallback cursors again, so it is possible to provide a chain of progressively easier to support cursors. If none of the provided cursors can be supported, the default cursor will be the ultimate fallback.

Properties

fallback

Cursor to fall back to if this cursor cannot be displayed.

Readable | Writeable | Construct Only

hotspot-x

X position of the cursor hotspot in the cursor image.

Readable | Writeable | Construct Only

hotspot-y

Y position of the cursor hotspot in the cursor image.

Readable | Writeable | Construct Only

name

Name of this this cursor.

The name will be None if the cursor was created from a texture.

Readable | Writeable | Construct Only

texture

The texture displayed by this cursor.

The texture will be None if the cursor was created from a name.

Readable | Writeable | Construct Only

GLib type: GObject with reference counted clone semantics.

Implementations

impl Cursor

pub fn from_name(name: &str, fallback: Option<&Cursor>) -> 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”

name

the name of the cursor

fallback

None or the Cursor to fall back to when this one cannot be supported

Returns

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

pub fn from_texture( texture: &impl IsA<Texture>, hotspot_x: i32, hotspot_y: i32, fallback: Option<&Cursor>, ) -> Cursor

Creates a new cursor from a Texture.

texture

the texture providing the pixel data

hotspot_x

the horizontal offset of the “hotspot” of the cursor

hotspot_y

the vertical offset of the “hotspot” of the cursor

fallback

the Cursor to fall back to when this one cannot be supported

Returns

a new Cursor

pub fn builder() -> CursorBuilder

Creates a new builder-pattern struct instance to construct Cursor objects.

This method returns an instance of CursorBuilder which can be used to create Cursor objects.

pub fn fallback(&self) -> Option<Cursor>

Returns the fallback for this @self.

The fallback will be used if this cursor is not available on a given Display. For named cursors, this can happen when using nonstandard names or when using an incomplete cursor theme. For textured cursors, this can happen when the texture is too large or when the Display it is used on does not support textured cursors.

Returns

the fallback of the cursor or None to use the default cursor as fallback

pub fn hotspot_x(&self) -> i32

Returns the horizontal offset of the hotspot.

The hotspot indicates the pixel that will be directly above the cursor.

Note that named cursors may have a nonzero hotspot, but this function will only return the hotspot position for cursors created with from_texture().

Returns

the horizontal offset of the hotspot or 0 for named cursors

pub fn hotspot_y(&self) -> i32

Returns the vertical offset of the hotspot.

The hotspot indicates the pixel that will be directly above the cursor.

Note that named cursors may have a nonzero hotspot, but this function will only return the hotspot position for cursors created with from_texture().

Returns

the vertical offset of the hotspot or 0 for named cursors

pub fn name(&self) -> Option<GString>

Returns the name of the cursor.

If the cursor is not a named cursor, None will be returned.

Returns

the name of the cursor or None if it is not a named cursor

pub fn texture(&self) -> Option<Texture>

Returns the texture for the cursor.

If the cursor is a named cursor, None will be returned.

Returns

the texture for cursor or None if it is a named cursor

impl Cursor

pub fn from_callback<P: Fn(&Cursor, i32, f64, &mut i32, &mut i32, &mut i32, &mut i32) -> Texture + 'static>( callback: P, fallback: Option<&Cursor>, ) -> Option<Cursor>

Available on crate feature v4_16 only.

Creates a new callback-based cursor object.

Cursors of this kind produce textures for the cursor image on demand, when the @callback is called.

callback

the GdkCursorGetTextureCallback

fallback

the Cursor to fall back to when this one cannot be supported

Returns

a new Cursor

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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 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,

Hashes the memory address of this object.

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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.

impl Eq for Cursor