Cursor

Object Hierarchy:

Description:

[ CCode ( type_id = "gdk_cursor_get_type ()" ) ]
public class Cursor : Object

`GdkCursor` 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 [ method@Gdk.Surface.set_cursor] or [method@Gdk.Surface.set_device_cursor]. Applications will typically use higher-level GTK functions such as [ set_cursor](../gtk4/method.Widget.set_cursor.html) instead.

Cursors are not bound to a given [class@Gdk.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 [ctor@Gdk.Cursor.new_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 [ctor@Gdk.Cursor.new_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 [class@Gdk.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.

Namespace: Gdk

Package: gtk4

Content:

Properties:

public Cursor fallback { get; construct; }
Cursor to fall back to if this cursor cannot be displayed.
public int hotspot_x { get; construct; }
X position of the cursor hotspot in the cursor image.
public int hotspot_y { get; construct; }
Y position of the cursor hotspot in the cursor image.
public string name { get; construct; }
Name of this this cursor.
public Texture texture { get; construct; }
The texture displayed by this cursor.

Creation methods:

protected Cursor ()
public Cursor.from_name (string name, Cursor? fallback)
Creates a new cursor by looking up name in the current cursor theme.
public Cursor.from_texture (Texture texture, int hotspot_x, int hotspot_y, Cursor? fallback)
Creates a new cursor from a `GdkTexture`.

Methods:

public unowned Cursor? get_fallback ()
Returns the fallback for this this.
public int get_hotspot_x ()
Returns the horizontal offset of the hotspot.
public int get_hotspot_y ()
Returns the vertical offset of the hotspot.
public unowned string? get_name ()
Returns the name of the cursor.
public unowned Texture? get_texture ()
Returns the texture for the cursor.

Inherited Members:

All known members inherited from class GLib.Object