]> Pileus Git - ~andy/gtk/blob - gdk/gdkcursor.h
New functions to construct named cursors and to get the image used for a
[~andy/gtk] / gdk / gdkcursor.h
1 #ifndef __GDK_CURSOR_H__
2 #define __GDK_CURSOR_H__
3
4 #include <gdk/gdktypes.h>
5 #include <gdk-pixbuf/gdk-pixbuf.h>
6
7 G_BEGIN_DECLS
8
9 #define GDK_TYPE_CURSOR (gdk_cursor_get_type ())
10
11 /* Cursor types.
12  */
13 typedef enum
14 {
15   GDK_X_CURSOR            = 0,
16   GDK_ARROW               = 2,
17   GDK_BASED_ARROW_DOWN    = 4,
18   GDK_BASED_ARROW_UP      = 6,
19   GDK_BOAT                = 8,
20   GDK_BOGOSITY            = 10,
21   GDK_BOTTOM_LEFT_CORNER  = 12,
22   GDK_BOTTOM_RIGHT_CORNER = 14,
23   GDK_BOTTOM_SIDE         = 16,
24   GDK_BOTTOM_TEE          = 18,
25   GDK_BOX_SPIRAL          = 20,
26   GDK_CENTER_PTR          = 22,
27   GDK_CIRCLE              = 24,
28   GDK_CLOCK               = 26,
29   GDK_COFFEE_MUG          = 28,
30   GDK_CROSS               = 30,
31   GDK_CROSS_REVERSE       = 32,
32   GDK_CROSSHAIR           = 34,
33   GDK_DIAMOND_CROSS       = 36,
34   GDK_DOT                 = 38,
35   GDK_DOTBOX              = 40,
36   GDK_DOUBLE_ARROW        = 42,
37   GDK_DRAFT_LARGE         = 44,
38   GDK_DRAFT_SMALL         = 46,
39   GDK_DRAPED_BOX          = 48,
40   GDK_EXCHANGE            = 50,
41   GDK_FLEUR               = 52,
42   GDK_GOBBLER             = 54,
43   GDK_GUMBY               = 56,
44   GDK_HAND1               = 58,
45   GDK_HAND2               = 60,
46   GDK_HEART               = 62,
47   GDK_ICON                = 64,
48   GDK_IRON_CROSS          = 66,
49   GDK_LEFT_PTR            = 68,
50   GDK_LEFT_SIDE           = 70,
51   GDK_LEFT_TEE            = 72,
52   GDK_LEFTBUTTON          = 74,
53   GDK_LL_ANGLE            = 76,
54   GDK_LR_ANGLE            = 78,
55   GDK_MAN                 = 80,
56   GDK_MIDDLEBUTTON        = 82,
57   GDK_MOUSE               = 84,
58   GDK_PENCIL              = 86,
59   GDK_PIRATE              = 88,
60   GDK_PLUS                = 90,
61   GDK_QUESTION_ARROW      = 92,
62   GDK_RIGHT_PTR           = 94,
63   GDK_RIGHT_SIDE          = 96,
64   GDK_RIGHT_TEE           = 98,
65   GDK_RIGHTBUTTON         = 100,
66   GDK_RTL_LOGO            = 102,
67   GDK_SAILBOAT            = 104,
68   GDK_SB_DOWN_ARROW       = 106,
69   GDK_SB_H_DOUBLE_ARROW   = 108,
70   GDK_SB_LEFT_ARROW       = 110,
71   GDK_SB_RIGHT_ARROW      = 112,
72   GDK_SB_UP_ARROW         = 114,
73   GDK_SB_V_DOUBLE_ARROW   = 116,
74   GDK_SHUTTLE             = 118,
75   GDK_SIZING              = 120,
76   GDK_SPIDER              = 122,
77   GDK_SPRAYCAN            = 124,
78   GDK_STAR                = 126,
79   GDK_TARGET              = 128,
80   GDK_TCROSS              = 130,
81   GDK_TOP_LEFT_ARROW      = 132,
82   GDK_TOP_LEFT_CORNER     = 134,
83   GDK_TOP_RIGHT_CORNER    = 136,
84   GDK_TOP_SIDE            = 138,
85   GDK_TOP_TEE             = 140,
86   GDK_TREK                = 142,
87   GDK_UL_ANGLE            = 144,
88   GDK_UMBRELLA            = 146,
89   GDK_UR_ANGLE            = 148,
90   GDK_WATCH               = 150,
91   GDK_XTERM               = 152,
92   GDK_LAST_CURSOR,
93   GDK_CURSOR_IS_PIXMAP  = -1
94 } GdkCursorType;
95
96 struct _GdkCursor
97 {
98   GdkCursorType type;
99   /*< private >*/
100   guint ref_count;
101 };
102
103 /* Cursors
104  */
105
106 GType      gdk_cursor_get_type           (void) G_GNUC_CONST;
107
108 GdkCursor* gdk_cursor_new_for_display    (GdkDisplay      *display,
109                                           GdkCursorType    cursor_type);
110 #ifndef GDK_MULTIHEAD_SAFE
111 GdkCursor* gdk_cursor_new                (GdkCursorType    cursor_type);
112 #endif
113 GdkCursor* gdk_cursor_new_from_pixmap    (GdkPixmap       *source,
114                                           GdkPixmap       *mask,
115                                           const GdkColor  *fg,
116                                           const GdkColor  *bg,
117                                           gint             x,
118                                           gint             y);
119 GdkCursor* gdk_cursor_new_from_pixbuf    (GdkDisplay      *display,
120                                           GdkPixbuf       *pixbuf,
121                                           gint             x,
122                                           gint             y);
123 GdkDisplay* gdk_cursor_get_display       (GdkCursor       *cursor);
124 GdkCursor*  gdk_cursor_ref               (GdkCursor       *cursor);
125 void        gdk_cursor_unref             (GdkCursor       *cursor);
126 GdkCursor*  gdk_cursor_new_from_name     (GdkDisplay      *display,
127                                           const gchar     *name);
128 GdkPixbuf*  gdk_cursor_get_image         (GdkCursor       *cursor);
129
130 #ifndef GDK_DISABLE_DEPRECATED
131 #define gdk_cursor_destroy             gdk_cursor_unref
132 #endif /* GDK_DISABLE_DEPRECATED */
133
134 G_END_DECLS
135
136 #endif /* __GDK_CURSOR_H__ */