Pileus Git - ~andy/gtk/blob - 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
  29 #include "gdkcursor.h"
  30
  31 #include "gdkdisplay.h"
  32 #include "gdkinternals.h"
  33
  34
  35 /**
  36  * SECTION:cursors
  37  * @Short_description: Standard and pixmap cursors
  38  * @Title: Cursors
  39  *
  40  * These functions are used to create and destroy cursors.
  41  * There is a number of standard cursors, but it is also
  42  * possible to construct new cursors from pixbufs. There
  43  * may be limitations as to what kinds of cursors can be
  44  * constructed on a given display, see
  45  * gdk_display_supports_cursor_alpha(),
  46  * gdk_display_supports_cursor_color(),
  47  * gdk_display_get_default_cursor_size() and
  48  * gdk_display_get_maximal_cursor_size().
  49  *
  50  * Cursors by themselves are not very interesting, they must be be
  51  * bound to a window for users to see them. This is done with
  52  * gdk_window_set_cursor() or by setting the cursor member of the
  53  * #GdkWindowAttr struct passed to gdk_window_new().
  54  */
  55
  56
  57 G_DEFINE_BOXED_TYPE (GdkCursor, gdk_cursor,
  58                      gdk_cursor_ref,
  59                      gdk_cursor_unref)
  60
  61 /**
  62  * gdk_cursor_ref:
  63  * @cursor: a #GdkCursor
  64  *
  65  * Adds a reference to @cursor.
  66  *
  67  * Return value: Same @cursor that was passed in
  68  **/
  69 GdkCursor*
  70 gdk_cursor_ref (GdkCursor *cursor)
  71 {
  72   g_return_val_if_fail (cursor != NULL, NULL);
  73   g_return_val_if_fail (cursor->ref_count > 0, NULL);
  74
  75   cursor->ref_count += 1;
  76
  77   return cursor;
  78 }
  79
  80 /**
  81  * gdk_cursor_unref:
  82  * @cursor: a #GdkCursor
  83  *
  84  * Removes a reference from @cursor, deallocating the cursor
  85  * if no references remain.
  86  *
  87  **/
  88 void
  89 gdk_cursor_unref (GdkCursor *cursor)
  90 {
  91   g_return_if_fail (cursor != NULL);
  92   g_return_if_fail (cursor->ref_count > 0);
  93
  94   cursor->ref_count -= 1;
  95
  96   if (cursor->ref_count == 0)
  97     _gdk_cursor_destroy (cursor);
  98 }
  99
 100 /**
 101  * gdk_cursor_new:
 102  * @cursor_type: cursor to create
 103  *
 104  * Creates a new cursor from the set of builtin cursors for the default display.
 105  * See gdk_cursor_new_for_display().
 106  *
 107  * To make the cursor invisible, use %GDK_BLANK_CURSOR.
 108  *
 109  * Return value: a new #GdkCursor
 110  **/
 111 GdkCursor*
 112 gdk_cursor_new (GdkCursorType cursor_type)
 113 {
 114   return gdk_cursor_new_for_display (gdk_display_get_default(), cursor_type);
 115 }
 116
 117 /**
 118  * gdk_cursor_get_cursor_type:
 119  * @cursor:  a #GdkCursor
 120  *
 121  * Returns the cursor type for this cursor.
 122  *
 123  * Return value: a #GdkCursorType
 124  *
 125  * Since: 2.22
 126  **/
 127 GdkCursorType
 128 gdk_cursor_get_cursor_type (GdkCursor *cursor)
 129 {
 130   g_return_val_if_fail (cursor != NULL, GDK_BLANK_CURSOR);
 131
 132   return cursor->type;
 133 }