cdk_cursor_new ()

CdkCursor *
cdk_cursor_new (CdkCursorType cursor_type);

Creates a new cursor from the set of builtin cursors for the default display. See cdk_cursor_new_for_display().

To make the cursor invisible, use CDK_BLANK_CURSOR.

cdk_cursor_new_from_pixbuf ()

CdkCursor *
cdk_cursor_new_from_pixbuf (CdkDisplay *display,
                            GdkPixbuf *pixbuf,
                            gint x,
                            gint y);

Creates a new cursor from a pixbuf.

Not all CDK backends support RGBA cursors. If they are not supported, a monochrome approximation will be displayed. The functions cdk_display_supports_cursor_alpha() and cdk_display_supports_cursor_color() can be used to determine whether RGBA cursors are supported; cdk_display_get_default_cursor_size() and cdk_display_get_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.

Since: 2.4

cdk_cursor_new_from_surface ()

CdkCursor *
cdk_cursor_new_from_surface (CdkDisplay *display,
                             cairo_surface_t *surface,
                             gdouble x,
                             gdouble y);

Creates a new cursor from a cairo image surface.

Not all CDK backends support RGBA cursors. If they are not supported, a monochrome approximation will be displayed. The functions cdk_display_supports_cursor_alpha() and cdk_display_supports_cursor_color() can be used to determine whether RGBA cursors are supported; cdk_display_get_default_cursor_size() and cdk_display_get_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.

Since: 3.10

cdk_cursor_new_from_name ()

CdkCursor *
cdk_cursor_new_from_name (CdkDisplay *display,
                          const gchar *name);

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:

Since: 2.8

cdk_cursor_new_for_display ()

CdkCursor *
cdk_cursor_new_for_display (CdkDisplay *display,
                            CdkCursorType cursor_type);

Creates a new cursor from the set of builtin cursors.

Since: 2.2

cdk_cursor_get_display ()

CdkDisplay *
cdk_cursor_get_display (CdkCursor *cursor);

Returns the display on which the CdkCursor is defined.

Since: 2.2

cdk_cursor_get_image ()

GdkPixbuf *
cdk_cursor_get_image (CdkCursor *cursor);

Returns a GdkPixbuf with the image used to display the cursor.

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

Since: 2.8

cdk_cursor_get_surface ()

cairo_surface_t *
cdk_cursor_get_surface (CdkCursor *cursor,
                        gdouble *x_hot,
                        gdouble *y_hot);

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, CDK may not be able to obtain the image data. In this case, NULL is returned.

Since: 3.10

cdk_cursor_get_cursor_type ()

CdkCursorType
cdk_cursor_get_cursor_type (CdkCursor *cursor);

Returns the cursor type for this cursor.

Since: 2.22

cdk_cursor_ref ()

CdkCursor *
cdk_cursor_ref (CdkCursor *cursor);

Adds a reference to cursor .

cdk_cursor_unref ()

void
cdk_cursor_unref (CdkCursor *cursor);

Removes a reference from cursor , deallocating the cursor if no references remain.

CdkCursor

typedef struct _CdkCursor CdkCursor;

A CdkCursor represents a cursor. Its contents are private.

enum CdkCursorType

Predefined cursors.

Note that these IDs are directly taken from the X cursor font, and many of these cursors are either not useful, or are not available on other platforms.

The recommended way to create cursors is to use cdk_cursor_new_from_name().

The “cursor-type” property

  “cursor-type”              CdkCursorType

Standard cursor type.

Owner: CdkCursor

Flags: Read / Write / Construct Only

Default value: CDK_X_CURSOR

The “display” property

  “display”                  CdkDisplay *

Display of this cursor.

Owner: CdkCursor

Flags: Read / Write / Construct Only