| Top |  |
 |
 |
 |
Functions
| GdkCursor * | gdk_cursor_new () |
| GdkCursor * | gdk_cursor_new_from_pixbuf () |
| GdkCursor * | gdk_cursor_new_from_surface () |
| GdkCursor * | gdk_cursor_new_from_name () |
| GdkCursor * | gdk_cursor_new_for_display () |
| GdkDisplay * | gdk_cursor_get_display () |
| GdkPixbuf * | gdk_cursor_get_image () |
| cairo_surface_t * | gdk_cursor_get_surface () |
| GdkCursorType | gdk_cursor_get_cursor_type () |
| GdkCursor * | gdk_cursor_ref () |
| void | gdk_cursor_unref () |
Properties
| GdkCursorType | cursor-type | Read / Write / Construct Only |
| GdkDisplay * | display | Read / Write / Construct Only |
Description
These functions are used to create and destroy cursors.
There is a number of standard cursors, but it is also
possible to construct new cursors from pixbufs. There
may be limitations as to what kinds of cursors can be
constructed on a given display, see
gdk_display_supports_cursor_alpha(),
gdk_display_supports_cursor_color(),
gdk_display_get_default_cursor_size() and
gdk_display_get_maximal_cursor_size().
Cursors by themselves are not very interesting, they must be be
bound to a window for users to see them. This is done with
gdk_window_set_cursor() or by setting the cursor member of the
GdkWindowAttr passed to gdk_window_new().
Functions
gdk_cursor_new ()
GdkCursor *
gdk_cursor_new (GdkCursorType cursor_type);
gdk_cursor_new has been deprecated since version 3.16 and should not be used in newly-written code.
Use gdk_cursor_new_for_display() instead.
Creates a new cursor from the set of builtin cursors for the default display.
See gdk_cursor_new_for_display().
To make the cursor invisible, use GDK_BLANK_CURSOR.
gdk_cursor_new_from_pixbuf ()
GdkCursor * gdk_cursor_new_from_pixbuf (GdkDisplay *display,GdkPixbuf *pixbuf,gint x,gint y);
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 gdk_display_supports_cursor_alpha() and
gdk_display_supports_cursor_color() can be used to determine
whether RGBA cursors are supported;
gdk_display_get_default_cursor_size() and
gdk_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.
Parameters
display |
the GdkDisplay for which the cursor will be created |
|
pixbuf |
the GdkPixbuf containing the cursor image |
|
x |
the horizontal offset of the “hotspot” of the cursor. |
|
y |
the vertical offset of the “hotspot” of the cursor. |
Since: 2.4
gdk_cursor_new_from_surface ()
GdkCursor * gdk_cursor_new_from_surface (GdkDisplay *display,cairo_surface_t *surface,gdouble x,gdouble y);
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 gdk_display_supports_cursor_alpha() and
gdk_display_supports_cursor_color() can be used to determine
whether RGBA cursors are supported;
gdk_display_get_default_cursor_size() and
gdk_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.
Parameters
display |
the GdkDisplay 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 |
Since: 3.10
gdk_cursor_new_from_name ()
GdkCursor * gdk_cursor_new_from_name (GdkDisplay *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:
"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"
Since: 2.8
gdk_cursor_new_for_display ()
GdkCursor * gdk_cursor_new_for_display (GdkDisplay *display,GdkCursorType cursor_type);
Creates a new cursor from the set of builtin cursors.
Since: 2.2
gdk_cursor_get_display ()
GdkDisplay *
gdk_cursor_get_display (GdkCursor *cursor);
Returns the display on which the GdkCursor is defined.
Since: 2.2
gdk_cursor_get_image ()
GdkPixbuf *
gdk_cursor_get_image (GdkCursor *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, GDK may not be able to obtain the image data. In this
case, NULL is returned.
Since: 2.8
gdk_cursor_get_surface ()
cairo_surface_t * gdk_cursor_get_surface (GdkCursor *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, GDK may not be able to obtain the image data. In this
case, NULL is returned.
Parameters
cursor |
||
x_hot |
Location to store the hotspot x position,
or |
[optional][out] |
y_hot |
Location to store the hotspot y position,
or |
[optional][out] |
Since: 3.10
gdk_cursor_get_cursor_type ()
GdkCursorType
gdk_cursor_get_cursor_type (GdkCursor *cursor);
Returns the cursor type for this cursor.
Since: 2.22
gdk_cursor_ref ()
GdkCursor *
gdk_cursor_ref (GdkCursor *cursor);
gdk_cursor_ref has been deprecated since version 3.0 and should not be used in newly-written code.
Use g_object_ref() instead
Adds a reference to cursor
.
gdk_cursor_unref ()
void
gdk_cursor_unref (GdkCursor *cursor);
gdk_cursor_unref has been deprecated since version 3.0 and should not be used in newly-written code.
Use g_object_unref() instead
Removes a reference from cursor
, deallocating the cursor
if no references remain.
Property Details
The “cursor-type” property
“cursor-type” GdkCursorType
Standard cursor type.
Owner: GdkCursor
Flags: Read / Write / Construct Only
Default value: GDK_X_CURSOR
The “display” property
“display” GdkDisplay *
Display of this cursor.
Owner: GdkCursor
Flags: Read / Write / Construct Only