gdkcursor.c 15 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GDK - The GIMP Drawing Kit
Havoc Pennington's avatar
Havoc Pennington committed
2
3
4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Havoc Pennington's avatar
Havoc Pennington committed
6
7
8
9
10
11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Havoc Pennington's avatar
Havoc Pennington committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Havoc Pennington's avatar
Havoc Pennington committed
16
17
18
 */

/*
19
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
Havoc Pennington's avatar
Havoc Pennington committed
20
21
22
23
24
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

25
#include "config.h"
26

27
28
29
#define GDK_PIXBUF_ENABLE_BACKEND
#include <gdk-pixbuf/gdk-pixbuf.h>

Havoc Pennington's avatar
Havoc Pennington committed
30
#include "gdkcursor.h"
31
#include "gdkcursorprivate.h"
32
#include "gdkdisplayprivate.h"
33
#include "gdkintl.h"
34
#include "gdkinternals.h"
35

36
#include <math.h>
37
#include <errno.h>
Havoc Pennington's avatar
Havoc Pennington committed
38

39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/**
 * SECTION:cursors
 * @Short_description: Standard and pixmap cursors
 * @Title: Cursors
 *
 * 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
57
 * #GdkWindowAttr passed to gdk_window_new().
58
59
 */

60
61
62
/**
 * GdkCursor:
 *
63
 * A #GdkCursor represents a cursor. Its contents are private.
64
 */
65

66
67
enum {
  PROP_0,
68
69
  PROP_CURSOR_TYPE,
  PROP_DISPLAY
70
71
};

Benjamin Otte's avatar
Benjamin Otte committed
72
73
G_DEFINE_ABSTRACT_TYPE (GdkCursor, gdk_cursor, G_TYPE_OBJECT)

74
75
76
77
78
79
80
81
82
83
84
85
86
static void
gdk_cursor_get_property (GObject    *object,
                         guint       prop_id,
                         GValue     *value,
                         GParamSpec *pspec)
{
  GdkCursor *cursor = GDK_CURSOR (object);

  switch (prop_id)
    {
    case PROP_CURSOR_TYPE:
      g_value_set_enum (value, cursor->type);
      break;
87
88
89
    case PROP_DISPLAY:
      g_value_set_object (value, cursor->display);
      break;
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gdk_cursor_set_property (GObject      *object,
                         guint         prop_id,
                         const GValue *value,
                         GParamSpec   *pspec)
{
  GdkCursor *cursor = GDK_CURSOR (object);

  switch (prop_id)
    {
    case PROP_CURSOR_TYPE:
      cursor->type = g_value_get_enum (value);
      break;
109
110
111
112
113
    case PROP_DISPLAY:
      cursor->display = g_value_get_object (value);
      /* check that implementations actually provide the display when constructing */
      g_assert (cursor->display != NULL);
      break;
114
115
116
117
118
119
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

Benjamin Otte's avatar
Benjamin Otte committed
120
121
122
static void
gdk_cursor_class_init (GdkCursorClass *cursor_class)
{
123
124
125
126
127
128
129
130
131
132
133
134
  GObjectClass *object_class = G_OBJECT_CLASS (cursor_class);

  object_class->get_property = gdk_cursor_get_property;
  object_class->set_property = gdk_cursor_set_property;

  g_object_class_install_property (object_class,
				   PROP_CURSOR_TYPE,
				   g_param_spec_enum ("cursor-type",
                                                      P_("Cursor type"),
                                                      P_("Standard cursor type"),
                                                      GDK_TYPE_CURSOR_TYPE, GDK_X_CURSOR,
                                                      G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
135
136
137
138
139
140
141
142

  g_object_class_install_property (object_class,
				   PROP_DISPLAY,
				   g_param_spec_object ("display",
                                                        P_("Display"),
                                                        P_("Display of this cursor"),
                                                        GDK_TYPE_DISPLAY,
                                                        G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
Benjamin Otte's avatar
Benjamin Otte committed
143
144
145
146
147
148
}

static void
gdk_cursor_init (GdkCursor *cursor)
{
}
149

Havoc Pennington's avatar
Havoc Pennington committed
150
151
152
/**
 * gdk_cursor_ref:
 * @cursor: a #GdkCursor
153
 *
Havoc Pennington's avatar
Havoc Pennington committed
154
 * Adds a reference to @cursor.
155
 *
156
 * Returns: (transfer full): Same @cursor that was passed in
157
158
 *
 * Deprecated: 3.0: Use g_object_ref() instead
159
 */
Havoc Pennington's avatar
Havoc Pennington committed
160
161
162
GdkCursor*
gdk_cursor_ref (GdkCursor *cursor)
{
163
  g_return_val_if_fail (cursor != NULL, NULL);
Tim Janik's avatar
Tim Janik committed
164

Benjamin Otte's avatar
Benjamin Otte committed
165
  return g_object_ref (cursor);
Havoc Pennington's avatar
Havoc Pennington committed
166
167
}

Havoc Pennington's avatar
Havoc Pennington committed
168
169
170
171
172
173
/**
 * gdk_cursor_unref:
 * @cursor: a #GdkCursor
 *
 * Removes a reference from @cursor, deallocating the cursor
 * if no references remain.
174
175
 *
 * Deprecated: 3.0: Use g_object_unref() instead
176
 */
Havoc Pennington's avatar
Havoc Pennington committed
177
178
179
void
gdk_cursor_unref (GdkCursor *cursor)
{
180
  g_return_if_fail (cursor != NULL);
Havoc Pennington's avatar
Havoc Pennington committed
181

Benjamin Otte's avatar
Benjamin Otte committed
182
  g_object_unref (cursor);
Havoc Pennington's avatar
Havoc Pennington committed
183
184
}

185
186
187
/**
 * gdk_cursor_new:
 * @cursor_type: cursor to create
188
 *
189
190
 * Creates a new cursor from the set of builtin cursors for the default display.
 * See gdk_cursor_new_for_display().
191
 *
Matthias Clasen's avatar
Matthias Clasen committed
192
 * To make the cursor invisible, use %GDK_BLANK_CURSOR.
193
 *
194
 * Returns: a new #GdkCursor
Matthias Clasen's avatar
Matthias Clasen committed
195
196
 *
 * Deprecated: 3.16: Use gdk_cursor_new_for_display() instead.
197
 */
198
199
200
GdkCursor*
gdk_cursor_new (GdkCursorType cursor_type)
{
Matthias Clasen's avatar
Matthias Clasen committed
201
  return gdk_cursor_new_for_display (gdk_display_get_default (), cursor_type);
202
}
John Stowers's avatar
John Stowers committed
203
204
205
206
207
208
209

/**
 * gdk_cursor_get_cursor_type:
 * @cursor:  a #GdkCursor
 *
 * Returns the cursor type for this cursor.
 *
210
 * Returns: a #GdkCursorType
John Stowers's avatar
John Stowers committed
211
212
213
214
215
216
217
 *
 * Since: 2.22
 **/
GdkCursorType
gdk_cursor_get_cursor_type (GdkCursor *cursor)
{
  g_return_val_if_fail (cursor != NULL, GDK_BLANK_CURSOR);
218

John Stowers's avatar
John Stowers committed
219
220
  return cursor->type;
}
221
222
223
224
225
226
227

/**
 * gdk_cursor_new_for_display:
 * @display: the #GdkDisplay for which the cursor will be created
 * @cursor_type: cursor to create
 *
 * Creates a new cursor from the set of builtin cursors.
Matthias Clasen's avatar
Matthias Clasen committed
228
 *
229
 * Returns: (nullable) (transfer full): a new #GdkCursor, or %NULL on failure
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 *
 * Since: 2.2
 **/
GdkCursor*
gdk_cursor_new_for_display (GdkDisplay    *display,
                            GdkCursorType  cursor_type)
{
  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);

  return GDK_DISPLAY_GET_CLASS (display)->get_cursor_for_type (display, cursor_type);
}

/**
 * gdk_cursor_new_from_name:
 * @display: the #GdkDisplay for which the cursor will be created
 * @name: the name of the cursor
 *
 * Creates a new cursor by looking up @name in the current cursor
 * theme.
 *
Matthias Clasen's avatar
Matthias Clasen committed
250
251
252
253
254
255
 * A recommended set of cursor names that will work across different
 * platforms can be found in the CSS specification:
 * - "none"
 * - ![](default_cursor.png) "default"
 * - ![](help_cursor.png) "help"
 * - ![](pointer_cursor.png) "pointer"
Matthias Clasen's avatar
Matthias Clasen committed
256
 * - ![](context_menu_cursor.png) "context-menu"
Matthias Clasen's avatar
Matthias Clasen committed
257
258
259
260
261
262
263
264
265
 * - ![](progress_cursor.png) "progress"
 * - ![](wait_cursor.png) "wait"
 * - ![](cell_cursor.png) "cell"
 * - ![](crosshair_cursor.png) "crosshair"
 * - ![](text_cursor.png) "text"
 * - ![](vertical_text_cursor.png) "vertical-text"
 * - ![](alias_cursor.png) "alias"
 * - ![](copy_cursor.png) "copy"
 * - ![](no_drop_cursor.png) "no-drop"
Matthias Clasen's avatar
Matthias Clasen committed
266
 * - ![](move_cursor.png) "move"
Matthias Clasen's avatar
Matthias Clasen committed
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 * - ![](not_allowed_cursor.png) "not-allowed"
 * - ![](grab_cursor.png) "grab"
 * - ![](grabbing_cursor.png) "grabbing"
 * - ![](all_scroll_cursor.png) "all-scroll"
 * - ![](col_resize_cursor.png) "col-resize"
 * - ![](row_resize_cursor.png) "row-resize"
 * - ![](n_resize_cursor.png) "n-resize"
 * - ![](e_resize_cursor.png) "e-resize"
 * - ![](s_resize_cursor.png) "s-resize"
 * - ![](w_resize_cursor.png) "w-resize"
 * - ![](ne_resize_cursor.png) "ne-resize"
 * - ![](nw_resize_cursor.png) "nw-resize"
 * - ![](sw_resize_cursor.png) "sw-resize"
 * - ![](se_resize_cursor.png) "se-resize"
 * - ![](ew_resize_cursor.png) "ew-resize"
 * - ![](ns_resize_cursor.png) "ns-resize"
 * - ![](nesw_resize_cursor.png) "nesw-resize"
 * - ![](nwse_resize_cursor.png) "nwse-resize"
 * - ![](zoom_in_cursor.png) "zoom-in"
 * - ![](zoom_out_cursor.png) "zoom-out"
 *
 *
289
290
 * Returns: (nullable): a new #GdkCursor, or %NULL if there is no
 *   cursor with the given name
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 *
 * Since: 2.8
 */
GdkCursor*
gdk_cursor_new_from_name (GdkDisplay  *display,
                          const gchar *name)
{
  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);

  return GDK_DISPLAY_GET_CLASS (display)->get_cursor_for_name (display, name);
}

/**
 * gdk_cursor_new_from_pixbuf:
 * @display: the #GdkDisplay for which the cursor will be created
 * @pixbuf: the #GdkPixbuf containing the cursor image
307
308
 * @x: the horizontal offset of the “hotspot” of the cursor.
 * @y: the vertical offset of the “hotspot” of the cursor.
309
310
311
312
313
314
315
316
317
318
319
320
 *
 * 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.
 *
321
 * If @x or @y are `-1`, the pixbuf must have
William Jon McCann's avatar
William Jon McCann committed
322
 * options named “x_hot” and “y_hot”, resp., containing
323
 * integer values between `0` and the width resp. height of
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 * the pixbuf. (Since: 3.0)
 *
 * On the X backend, support for RGBA cursors requires a
 * sufficently new version of the X Render extension.
 *
 * Returns: a new #GdkCursor.
 *
 * Since: 2.4
 */
GdkCursor *
gdk_cursor_new_from_pixbuf (GdkDisplay *display,
                            GdkPixbuf  *pixbuf,
                            gint        x,
                            gint        y)
{
339
340
341
342
  cairo_surface_t *surface;
  const char *option;
  char *end;
  gint64 value;
343
  GdkCursor *cursor;
344
 
345
346
347
  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
  g_return_val_if_fail (GDK_IS_PIXBUF (pixbuf), NULL);

348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
  if (x == -1 && (option = gdk_pixbuf_get_option (pixbuf, "x_hot")))
    {
      errno = 0;
      end = NULL;
      value = g_ascii_strtoll (option, &end, 10);
      if (errno == 0 &&
          end != option &&
          value >= 0 && value < G_MAXINT)
        x = (gint) value;
    }
  
  if (y == -1 && (option = gdk_pixbuf_get_option (pixbuf, "y_hot")))
    {
      errno = 0;
      end = NULL;
      value = g_ascii_strtoll (option, &end, 10);
      if (errno == 0 &&
          end != option &&
          value >= 0 && value < G_MAXINT)
        y = (gint) value;
    }

  surface = gdk_cairo_surface_create_from_pixbuf (pixbuf, 1, NULL);
  
372
373
374
375
376
  cursor = GDK_DISPLAY_GET_CLASS (display)->get_cursor_for_surface (display, surface, x, y);

  cairo_surface_destroy (surface);

  return cursor;
377
}
378

379
380
381
382
/**
 * gdk_cursor_new_from_surface:
 * @display: the #GdkDisplay for which the cursor will be created
 * @surface: the cairo image surface containing the cursor pixel data
383
384
 * @x: the horizontal offset of the “hotspot” of the cursor
 * @y: the vertical offset of the “hotspot” of the cursor
385
 *
386
 * Creates a new cursor from a cairo image surface.
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 *
 * 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.
 *
 * Returns: a new #GdkCursor.
 *
 * Since: 3.10
 */
GdkCursor *
405
gdk_cursor_new_from_surface (GdkDisplay      *display,
406
			     cairo_surface_t *surface,
407
408
			     gdouble          x,
			     gdouble          y)
409
410
411
412
413
414
415
416
417
418
{
  g_return_val_if_fail (GDK_IS_DISPLAY (display), NULL);
  g_return_val_if_fail (surface != NULL, NULL);
  g_return_val_if_fail (cairo_surface_get_type (surface) == CAIRO_SURFACE_TYPE_IMAGE, NULL);
  g_return_val_if_fail (0 <= x && x < cairo_image_surface_get_width (surface), NULL);
  g_return_val_if_fail (0 <= y && y < cairo_image_surface_get_height (surface), NULL);

  return GDK_DISPLAY_GET_CLASS (display)->get_cursor_for_surface (display,
								  surface, x, y);
}
419
/**
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 * gdk_cursor_get_display:
 * @cursor: a #GdkCursor.
 *
 * Returns the display on which the #GdkCursor is defined.
 *
 * Returns: (transfer none): the #GdkDisplay associated to @cursor
 *
 * Since: 2.2
 */

GdkDisplay *
gdk_cursor_get_display (GdkCursor *cursor)
{
  g_return_val_if_fail (GDK_IS_CURSOR (cursor), NULL);

  return cursor->display;
}

438
439
440
441
442
443
444
445
446
447
/**
 * gdk_cursor_get_image:
 * @cursor: a #GdkCursor
 *
 * 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.
 *
448
449
 * Returns: (nullable) (transfer full): a #GdkPixbuf representing
 *   @cursor, or %NULL
450
451
452
453
454
 *
 * Since: 2.8
 */
GdkPixbuf*  
gdk_cursor_get_image (GdkCursor *cursor)
455
456
457
458
459
460
461
462
463
464
465
466
467
{
  int w, h;
  cairo_surface_t *surface;
  GdkPixbuf *pixbuf;
  gchar buf[32];
  double x_hot, y_hot;
  double x_scale, y_scale;

  g_return_val_if_fail (GDK_IS_CURSOR (cursor), NULL);

  surface = gdk_cursor_get_surface (cursor, &x_hot, &y_hot);
  if (surface == NULL)
    return NULL;
468

469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
  w = cairo_image_surface_get_width (surface);
  h = cairo_image_surface_get_height (surface);

  x_scale = y_scale = 1;
  cairo_surface_get_device_scale (surface, &x_scale, &y_scale);

  pixbuf = gdk_pixbuf_get_from_surface (surface, 0, 0, w, h);
  cairo_surface_destroy (surface);

  if (x_scale != 1)
    {
      GdkPixbuf *old;

      old = pixbuf;
      pixbuf = gdk_pixbuf_scale_simple (old,
					w / x_scale, h / y_scale,
					GDK_INTERP_HYPER);
      g_object_unref (old);
    }

  
  g_snprintf (buf, 32, "%d", (int)x_hot);
  gdk_pixbuf_set_option (pixbuf, "x_hot", buf);

  g_snprintf (buf, 32, "%d", (int)y_hot);
  gdk_pixbuf_set_option (pixbuf, "y_hot", buf);

  return pixbuf;
}

/**
 * gdk_cursor_get_surface:
 * @cursor: a #GdkCursor
502
503
504
505
 * @x_hot: (optional) (out): Location to store the hotspot x position,
 *   or %NULL
 * @y_hot: (optional) (out): Location to store the hotspot y position,
 *   or %NULL
506
 *
507
 * Returns a cairo image surface with the image used to display the cursor.
508
509
510
511
512
 *
 * 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.
 *
513
514
 * Returns: (nullable) (transfer full): a #cairo_surface_t
 *   representing @cursor, or %NULL
515
516
517
518
519
 *
 * Since: 3.10
 */
cairo_surface_t *
gdk_cursor_get_surface (GdkCursor *cursor,
520
521
			gdouble   *x_hot,
			gdouble   *y_hot)
522
523
524
{
  g_return_val_if_fail (GDK_IS_CURSOR (cursor), NULL);

525
  return GDK_CURSOR_GET_CLASS (cursor)->get_surface (cursor, x_hot, y_hot);
526
}