Cursors

Cursors

Functions

Types and Values

Includes

#include <gdk/gdk.h>

Description

Functions

gdk_cursor_new ()

GdkCursor *
gdk_cursor_new (GdkCursorType cursor_type);

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.

Parameters

cursor_type

cursor to create

 

Returns

a new GdkCursor


gdk_cursor_new_from_pixmap ()

GdkCursor *
gdk_cursor_new_from_pixmap (GdkPixmap *source,
                            GdkPixmap *mask,
                            const GdkColor *fg,
                            const GdkColor *bg,
                            gint x,
                            gint y);

Creates a new cursor from a given pixmap and mask. Both the pixmap and mask must have a depth of 1 (i.e. each pixel has only 2 values - on or off). The standard cursor size is 16 by 16 pixels. You can create a bitmap from inline data as in the below example.

Example 3. Creating a custom cursor

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/* This data is in X bitmap format, and can be created with the 'bitmap'
   utility. */
#define cursor1_width 16
#define cursor1_height 16
static unsigned char cursor1_bits[] = {
  0x80, 0x01, 0x40, 0x02, 0x20, 0x04, 0x10, 0x08, 0x08, 0x10, 0x04, 0x20,
  0x82, 0x41, 0x41, 0x82, 0x41, 0x82, 0x82, 0x41, 0x04, 0x20, 0x08, 0x10,
  0x10, 0x08, 0x20, 0x04, 0x40, 0x02, 0x80, 0x01};
 
static unsigned char cursor1mask_bits[] = {
  0x80, 0x01, 0xc0, 0x03, 0x60, 0x06, 0x30, 0x0c, 0x18, 0x18, 0x8c, 0x31,
  0xc6, 0x63, 0x63, 0xc6, 0x63, 0xc6, 0xc6, 0x63, 0x8c, 0x31, 0x18, 0x18,
  0x30, 0x0c, 0x60, 0x06, 0xc0, 0x03, 0x80, 0x01};
 
 
 GdkCursor *cursor;
 GdkPixmap *source, *mask;
 GdkColor fg = { 0, 65535, 0, 0 }; /* Red. */
 GdkColor bg = { 0, 0, 0, 65535 }; /* Blue. */
 
 
 source = gdk_bitmap_create_from_data (NULL, cursor1_bits,
                                       cursor1_width, cursor1_height);
 mask = gdk_bitmap_create_from_data (NULL, cursor1mask_bits,
                                     cursor1_width, cursor1_height);
 cursor = gdk_cursor_new_from_pixmap (source, mask, &fg, &bg, 8, 8);
 g_object_unref (source);
 g_object_unref (mask);
 
 
 gdk_window_set_cursor (widget->window, cursor);

Parameters

source

the pixmap specifying the cursor.

 

mask

the pixmap specifying the mask, which must be the same size as source .

 

fg

the foreground color, used for the bits in the source which are 1. The color does not have to be allocated first.

 

bg

the background color, used for the bits in the source which are 0. The color does not have to be allocated first.

 

x

the horizontal offset of the 'hotspot' of the cursor.

 

y

the vertical offset of the 'hotspot' of the cursor.

 

Returns

a new GdkCursor.


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.

 

Returns

a new GdkCursor.

Since: 2.4


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.

Parameters

display

the GdkDisplay for which the cursor will be created

 

name

the name of the cursor

 

Returns

a new GdkCursor, or NULL if there is no cursor with the given name

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. Some useful ones are:

Parameters

display

the GdkDisplay for which the cursor will be created

 

cursor_type

cursor to create

 

Returns

a new GdkCursor

Since: 2.2


gdk_cursor_get_display ()

GdkDisplay *
gdk_cursor_get_display (GdkCursor *cursor);

Returns the display on which the GdkCursor is defined.

Parameters

cursor

a GdkCursor.

 

Returns

the GdkDisplay associated to cursor

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.

Parameters

cursor

a GdkCursor

 

Returns

a GdkPixbuf representing cursor , or NULL

Since: 2.8


gdk_cursor_get_cursor_type ()

GdkCursorType
gdk_cursor_get_cursor_type (GdkCursor *cursor);

Returns the cursor type for this cursor.

Parameters

cursor

a GdkCursor

 

Returns

a GdkCursorType

Since: 2.22


gdk_cursor_ref ()

GdkCursor *
gdk_cursor_ref (GdkCursor *cursor);

Adds a reference to cursor .

Parameters

cursor

a GdkCursor

 

Returns

Same cursor that was passed in.

[transfer full]


gdk_cursor_unref ()

void
gdk_cursor_unref (GdkCursor *cursor);

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

Parameters

cursor

a GdkCursor

 

Types and Values

GdkCursor

typedef struct {
  GdkCursorType GSEAL (type);
} GdkCursor;

enum GdkCursorType

Members

GDK_X_CURSOR

   

GDK_ARROW

   

GDK_BASED_ARROW_DOWN

   

GDK_BASED_ARROW_UP

   

GDK_BOAT

   

GDK_BOGOSITY

   

GDK_BOTTOM_LEFT_CORNER

   

GDK_BOTTOM_RIGHT_CORNER

   

GDK_BOTTOM_SIDE

   

GDK_BOTTOM_TEE

   

GDK_BOX_SPIRAL

   

GDK_CENTER_PTR

   

GDK_CIRCLE

   

GDK_CLOCK

   

GDK_COFFEE_MUG

   

GDK_CROSS

   

GDK_CROSS_REVERSE

   

GDK_CROSSHAIR

   

GDK_DIAMOND_CROSS

   

GDK_DOT

   

GDK_DOTBOX

   

GDK_DOUBLE_ARROW

   

GDK_DRAFT_LARGE

   

GDK_DRAFT_SMALL

   

GDK_DRAPED_BOX

   

GDK_EXCHANGE

   

GDK_FLEUR

   

GDK_GOBBLER

   

GDK_GUMBY

   

GDK_HAND1

   

GDK_HAND2

   

GDK_HEART

   

GDK_ICON

   

GDK_IRON_CROSS

   

GDK_LEFT_PTR

   

GDK_LEFT_SIDE

   

GDK_LEFT_TEE

   

GDK_LEFTBUTTON

   

GDK_LL_ANGLE

   

GDK_LR_ANGLE

   

GDK_MAN

   

GDK_MIDDLEBUTTON

   

GDK_MOUSE

   

GDK_PENCIL

   

GDK_PIRATE

   

GDK_PLUS

   

GDK_QUESTION_ARROW

   

GDK_RIGHT_PTR

   

GDK_RIGHT_SIDE

   

GDK_RIGHT_TEE

   

GDK_RIGHTBUTTON

   

GDK_RTL_LOGO

   

GDK_SAILBOAT

   

GDK_SB_DOWN_ARROW

   

GDK_SB_H_DOUBLE_ARROW

   

GDK_SB_LEFT_ARROW

   

GDK_SB_RIGHT_ARROW

   

GDK_SB_UP_ARROW

   

GDK_SB_V_DOUBLE_ARROW

   

GDK_SHUTTLE

   

GDK_SIZING

   

GDK_SPIDER

   

GDK_SPRAYCAN

   

GDK_STAR

   

GDK_TARGET

   

GDK_TCROSS

   

GDK_TOP_LEFT_ARROW

   

GDK_TOP_LEFT_CORNER

   

GDK_TOP_RIGHT_CORNER

   

GDK_TOP_SIDE

   

GDK_TOP_TEE

   

GDK_TREK

   

GDK_UL_ANGLE

   

GDK_UMBRELLA

   

GDK_UR_ANGLE

   

GDK_WATCH

   

GDK_XTERM

   

GDK_LAST_CURSOR

   

GDK_BLANK_CURSOR

   

GDK_CURSOR_IS_PIXMAP

   

gdk_cursor_destroy

#define gdk_cursor_destroy             gdk_cursor_unref

gdk_cursor_destroy is deprecated and should not be used in newly-written code.