]> Pileus Git - ~andy/gtk/blob - gdk/gdktypes.h
Add support for extra virtual modifiers: (#85780, Owen Taylor)
[~andy/gtk] / gdk / gdktypes.h
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 #ifndef __GDK_TYPES_H__
28 #define __GDK_TYPES_H__
29
30 /* GDK uses "glib". (And so does GTK).
31  */
32 #include <glib.h>
33 #include <pango/pango.h>
34 #include <glib-object.h>
35
36 #ifdef G_OS_WIN32
37 #  ifdef GDK_COMPILATION
38 #    define GDKVAR __declspec(dllexport)
39 #  else
40 #    define GDKVAR extern __declspec(dllimport)
41 #  endif
42 #else
43 #  define GDKVAR extern
44 #endif
45
46 /* The system specific file gdkconfig.h contains such configuration
47  * settings that are needed not only when compiling GDK (or GTK)
48  * itself, but also occasionally when compiling programs that use GDK
49  * (or GTK). One such setting is what windowing API backend is in use.
50  */
51 #include <gdkconfig.h>
52
53 /* some common magic values */
54 #define GDK_CURRENT_TIME     0L
55 #define GDK_PARENT_RELATIVE  1L
56
57
58
59 G_BEGIN_DECLS
60
61
62 /* Type definitions for the basic structures.
63  */
64 typedef struct _GdkPoint              GdkPoint;
65 typedef struct _GdkRectangle          GdkRectangle;
66 typedef struct _GdkSegment            GdkSegment;
67 typedef struct _GdkSpan               GdkSpan;
68
69 /*
70  * Note that on some platforms the wchar_t type
71  * is not the same as GdkWChar. For instance
72  * on Win32, wchar_t is unsigned short.
73  */
74 typedef guint32                     GdkWChar;
75
76 typedef struct _GdkAtom            *GdkAtom;
77
78 #define GDK_ATOM_TO_POINTER(atom) (atom)
79 #define GDK_POINTER_TO_ATOM(ptr)  ((GdkAtom)(ptr))
80
81 #define _GDK_MAKE_ATOM(val) ((GdkAtom)GUINT_TO_POINTER(val))
82 #define GDK_NONE            _GDK_MAKE_ATOM (0)
83
84 #ifdef GDK_NATIVE_WINDOW_POINTER
85 typedef gpointer GdkNativeWindow;
86 #else
87 typedef guint32 GdkNativeWindow;
88 #endif
89  
90 /* Forward declarations of commonly used types
91  */
92 typedef struct _GdkColor              GdkColor;
93 typedef struct _GdkColormap           GdkColormap;
94 typedef struct _GdkCursor             GdkCursor;
95 typedef struct _GdkFont               GdkFont;
96 typedef struct _GdkGC                 GdkGC;
97 typedef struct _GdkImage              GdkImage;
98 typedef struct _GdkRegion             GdkRegion;
99 typedef struct _GdkVisual             GdkVisual;
100
101 typedef struct _GdkDrawable           GdkDrawable;
102 typedef struct _GdkDrawable           GdkBitmap;
103 typedef struct _GdkDrawable           GdkPixmap;
104 typedef struct _GdkDrawable           GdkWindow;
105 typedef struct _GdkDisplay            GdkDisplay;
106 typedef struct _GdkScreen             GdkScreen;
107
108 typedef enum
109 {
110   GDK_LSB_FIRST,
111   GDK_MSB_FIRST
112 } GdkByteOrder;
113
114 /* Types of modifiers.
115  */
116 typedef enum
117 {
118   GDK_SHIFT_MASK    = 1 << 0,
119   GDK_LOCK_MASK     = 1 << 1,
120   GDK_CONTROL_MASK  = 1 << 2,
121   GDK_MOD1_MASK     = 1 << 3,
122   GDK_ALT_MASK      = GDK_MOD1_MASK,
123   GDK_MOD2_MASK     = 1 << 4,
124   GDK_MOD3_MASK     = 1 << 5,
125   GDK_MOD4_MASK     = 1 << 6,
126   GDK_MOD5_MASK     = 1 << 7,
127   GDK_BUTTON1_MASK  = 1 << 8,
128   GDK_BUTTON2_MASK  = 1 << 9,
129   GDK_BUTTON3_MASK  = 1 << 10,
130   GDK_BUTTON4_MASK  = 1 << 11,
131   GDK_BUTTON5_MASK  = 1 << 12,
132
133   /* The next few modifiers are used by XKB, so we skip to the end.
134    * Bits 15 - 25 are currently unused. Bit 29 is used internally.
135    */
136   
137   GDK_SUPER_MASK    = 1 << 26,
138   GDK_HYPER_MASK    = 1 << 27,
139   GDK_META_MASK     = 1 << 28,
140   
141   GDK_RELEASE_MASK  = 1 << 30,
142
143   GDK_MODIFIER_MASK = 0x5c001fff
144 } GdkModifierType;
145
146 typedef enum
147 {
148   GDK_INPUT_READ       = 1 << 0,
149   GDK_INPUT_WRITE      = 1 << 1,
150   GDK_INPUT_EXCEPTION  = 1 << 2
151 } GdkInputCondition;
152
153 typedef enum
154 {
155   GDK_OK          = 0,
156   GDK_ERROR       = -1,
157   GDK_ERROR_PARAM = -2,
158   GDK_ERROR_FILE  = -3,
159   GDK_ERROR_MEM   = -4
160 } GdkStatus;
161
162 /* We define specific numeric values for these constants,
163  * since old application code may depend on them matching the X values
164  * We don't actually depend on the matchup ourselves.
165  */
166 typedef enum
167 {
168   GDK_GRAB_SUCCESS         = 0,
169   GDK_GRAB_ALREADY_GRABBED = 1,
170   GDK_GRAB_INVALID_TIME    = 2,
171   GDK_GRAB_NOT_VIEWABLE    = 3,
172   GDK_GRAB_FROZEN          = 4
173 } GdkGrabStatus;
174
175 typedef void (*GdkInputFunction) (gpointer          data,
176                                   gint              source,
177                                   GdkInputCondition condition);
178
179 typedef void (*GdkDestroyNotify) (gpointer data);
180
181 struct _GdkPoint
182 {
183   gint x;
184   gint y;
185 };
186
187 struct _GdkRectangle
188 {
189   gint x;
190   gint y;
191   gint width;
192   gint height;
193 };
194
195 struct _GdkSegment
196 {
197   gint x1;
198   gint y1;
199   gint x2;
200   gint y2;
201 };
202
203 struct _GdkSpan
204 {
205   gint x;
206   gint y;
207   gint width;
208 };
209
210 G_END_DECLS
211
212
213 #endif /* __GDK_TYPES_H__ */