]> Pileus Git - ~andy/gtk/blob - gdk/gdkcursor.c
Use G_DEFINE_BOXED_TYPE
[~andy/gtk] / gdk / gdkcursor.c
1 /* GDK - The GIMP Drawing Kit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 /*
21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22  * file for a list of people on the GTK+ Team.  See the ChangeLog
23  * files for a list of changes.  These files are distributed with
24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
25  */
26
27 #include "config.h"
28 #include "gdkcursor.h"
29 #include "gdkdisplay.h"
30 #include "gdkinternals.h"
31
32
33 G_DEFINE_BOXED_TYPE (GdkCursor, gdk_cursor,
34                      gdk_cursor_ref,
35                      gdk_cursor_unref)
36
37 /**
38  * gdk_cursor_ref:
39  * @cursor: a #GdkCursor
40  * 
41  * Adds a reference to @cursor.
42  * 
43  * Return value: Same @cursor that was passed in
44  **/
45 GdkCursor*
46 gdk_cursor_ref (GdkCursor *cursor)
47 {
48   g_return_val_if_fail (cursor != NULL, NULL);
49   g_return_val_if_fail (cursor->ref_count > 0, NULL);
50
51   cursor->ref_count += 1;
52
53   return cursor;
54 }
55
56 /**
57  * gdk_cursor_unref:
58  * @cursor: a #GdkCursor
59  *
60  * Removes a reference from @cursor, deallocating the cursor
61  * if no references remain.
62  * 
63  **/
64 void
65 gdk_cursor_unref (GdkCursor *cursor)
66 {
67   g_return_if_fail (cursor != NULL);
68   g_return_if_fail (cursor->ref_count > 0);
69
70   cursor->ref_count -= 1;
71
72   if (cursor->ref_count == 0)
73     _gdk_cursor_destroy (cursor);
74 }
75
76 /**
77  * gdk_cursor_new:
78  * @cursor_type: cursor to create
79  * 
80  * Creates a new cursor from the set of builtin cursors for the default display.
81  * See gdk_cursor_new_for_display().
82  *
83  * To make the cursor invisible, use %GDK_BLANK_CURSOR.
84  * 
85  * Return value: a new #GdkCursor
86  **/
87 GdkCursor*
88 gdk_cursor_new (GdkCursorType cursor_type)
89 {
90   return gdk_cursor_new_for_display (gdk_display_get_default(), cursor_type);
91 }
92
93 /**
94  * gdk_cursor_get_cursor_type:
95  * @cursor:  a #GdkCursor
96  *
97  * Returns the cursor type for this cursor.
98  *
99  * Return value: a #GdkCursorType
100  *
101  * Since: 2.22
102  **/
103 GdkCursorType
104 gdk_cursor_get_cursor_type (GdkCursor *cursor)
105 {
106   g_return_val_if_fail (cursor != NULL, GDK_BLANK_CURSOR);
107   return cursor->type;
108 }