1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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.
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.
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.
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/.
27 #if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
28 #error "Only <gdk/gdk.h> can be included directly."
31 #ifndef __GDK_TYPES_H__
32 #define __GDK_TYPES_H__
34 /* GDK uses "glib". (And so does GTK).
37 #include <pango/pango.h>
38 #include <glib-object.h>
41 /* The system specific file gdkconfig.h contains such configuration
42 * settings that are needed not only when compiling GDK (or GTK)
43 * itself, but also occasionally when compiling programs that use GDK
44 * (or GTK). One such setting is what windowing API backend is in use.
46 #include <gdkconfig.h>
48 /* some common magic values */
49 #define GDK_CURRENT_TIME 0L
52 * GDK_PARENT_RELATIVE:
54 * A special value for #GdkPixmap variables, indicating that the background
55 * pixmap for a window should be inherited from the parent window.
57 #define GDK_PARENT_RELATIVE 1L
64 /* Type definitions for the basic structures.
66 typedef struct _GdkPoint GdkPoint;
67 typedef cairo_rectangle_int_t GdkRectangle;
68 typedef struct _GdkSpan GdkSpan;
70 typedef struct _GdkAtom *GdkAtom;
72 #define GDK_ATOM_TO_POINTER(atom) (atom)
73 #define GDK_POINTER_TO_ATOM(ptr) ((GdkAtom)(ptr))
75 #ifdef GDK_NATIVE_WINDOW_POINTER
76 #define GDK_GPOINTER_TO_NATIVE_WINDOW(p) ((GdkNativeWindow) (p))
78 #define GDK_GPOINTER_TO_NATIVE_WINDOW(p) GPOINTER_TO_UINT(p)
81 #define _GDK_MAKE_ATOM(val) ((GdkAtom)GUINT_TO_POINTER(val))
82 #define GDK_NONE _GDK_MAKE_ATOM (0)
84 #ifdef GDK_NATIVE_WINDOW_POINTER
85 typedef gpointer GdkNativeWindow;
87 typedef guint32 GdkNativeWindow;
90 /* Forward declarations of commonly used types
92 typedef struct _GdkColor GdkColor;
93 typedef struct _GdkColormap GdkColormap;
94 typedef struct _GdkCursor GdkCursor;
95 typedef struct _GdkVisual GdkVisual;
97 typedef struct _GdkDrawable GdkDrawable;
98 typedef struct _GdkDrawable GdkBitmap;
99 typedef struct _GdkDrawable GdkPixmap;
104 * An opaque structure representing an onscreen drawable. Pointers to structures
105 * of type #GdkPixmap, #GdkBitmap, and #GdkWindow can often be used
106 * interchangeably. The type #GdkDrawable refers generically to any of these
109 typedef struct _GdkDrawable GdkWindow;
110 typedef struct _GdkDisplay GdkDisplay;
111 typedef struct _GdkScreen GdkScreen;
119 /* Types of modifiers.
123 * @GDK_SHIFT_MASK: the Shift key.
124 * @GDK_LOCK_MASK: a Lock key (depending on the modifier mapping of the
125 * X server this may either be CapsLock or ShiftLock).
126 * @GDK_CONTROL_MASK: the Control key.
127 * @GDK_MOD1_MASK: the fourth modifier key (it depends on the modifier
128 * mapping of the X server which key is interpreted as this modifier, but
129 * normally it is the Alt key).
130 * @GDK_MOD2_MASK: the fifth modifier key (it depends on the modifier
131 * mapping of the X server which key is interpreted as this modifier).
132 * @GDK_MOD3_MASK: the sixth modifier key (it depends on the modifier
133 * mapping of the X server which key is interpreted as this modifier).
134 * @GDK_MOD4_MASK: the seventh modifier key (it depends on the modifier
135 * mapping of the X server which key is interpreted as this modifier).
136 * @GDK_MOD5_MASK: the eighth modifier key (it depends on the modifier
137 * mapping of the X server which key is interpreted as this modifier).
138 * @GDK_BUTTON1_MASK: the first mouse button.
139 * @GDK_BUTTON2_MASK: the second mouse button.
140 * @GDK_BUTTON3_MASK: the third mouse button.
141 * @GDK_BUTTON4_MASK: the fourth mouse button.
142 * @GDK_BUTTON5_MASK: the fifth mouse button.
143 * @GDK_SUPER_MASK: the Super modifier. Since 2.10
144 * @GDK_HYPER_MASK: the Hyper modifier. Since 2.10
145 * @GDK_META_MASK: the Meta modifier. Since 2.10
146 * @GDK_RELEASE_MASK: not used in GDK itself. GTK+ uses it to differentiate
147 * between (keyval, modifiers) pairs from key press and release events.
148 * @GDK_MODIFIER_MASK: a mask covering all modifier types.
150 * A set of bit-flags to indicate the state of modifier keys and mouse buttons
151 * in various event types. Typical modifier keys are Shift, Control, Meta,
152 * Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.
154 * Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.
156 * Since 2.10, GDK recognizes which of the Meta, Super or Hyper keys are mapped
157 * to Mod2 - Mod5, and indicates this by setting %GDK_SUPER_MASK,
158 * %GDK_HYPER_MASK or %GDK_META_MASK in the state field of key events.
162 GDK_SHIFT_MASK = 1 << 0,
163 GDK_LOCK_MASK = 1 << 1,
164 GDK_CONTROL_MASK = 1 << 2,
165 GDK_MOD1_MASK = 1 << 3,
166 GDK_MOD2_MASK = 1 << 4,
167 GDK_MOD3_MASK = 1 << 5,
168 GDK_MOD4_MASK = 1 << 6,
169 GDK_MOD5_MASK = 1 << 7,
170 GDK_BUTTON1_MASK = 1 << 8,
171 GDK_BUTTON2_MASK = 1 << 9,
172 GDK_BUTTON3_MASK = 1 << 10,
173 GDK_BUTTON4_MASK = 1 << 11,
174 GDK_BUTTON5_MASK = 1 << 12,
176 /* The next few modifiers are used by XKB, so we skip to the end.
177 * Bits 15 - 25 are currently unused. Bit 29 is used internally.
180 GDK_SUPER_MASK = 1 << 26,
181 GDK_HYPER_MASK = 1 << 27,
182 GDK_META_MASK = 1 << 28,
184 GDK_RELEASE_MASK = 1 << 30,
186 GDK_MODIFIER_MASK = 0x5c001fff
193 GDK_ERROR_PARAM = -2,
198 /* We define specific numeric values for these constants,
199 * since old application code may depend on them matching the X values
200 * We don't actually depend on the matchup ourselves.
204 GDK_GRAB_SUCCESS = 0,
205 GDK_GRAB_ALREADY_GRABBED = 1,
206 GDK_GRAB_INVALID_TIME = 2,
207 GDK_GRAB_NOT_VIEWABLE = 3,
213 * @GDK_OWNERSHIP_NONE: All other devices' events are allowed.
214 * @GDK_OWNERSHIP_WINDOW: Other devices' events are blocked for the grab window.
215 * @GDK_OWNERSHIP_APPLICATION: Other devices' events are blocked for the whole application.
217 * Defines how device grabs interact with other devices.
222 GDK_OWNERSHIP_WINDOW,
223 GDK_OWNERSHIP_APPLICATION
226 /* Event masks. (Used to select what types of events a window
231 GDK_EXPOSURE_MASK = 1 << 1,
232 GDK_POINTER_MOTION_MASK = 1 << 2,
233 GDK_POINTER_MOTION_HINT_MASK = 1 << 3,
234 GDK_BUTTON_MOTION_MASK = 1 << 4,
235 GDK_BUTTON1_MOTION_MASK = 1 << 5,
236 GDK_BUTTON2_MOTION_MASK = 1 << 6,
237 GDK_BUTTON3_MOTION_MASK = 1 << 7,
238 GDK_BUTTON_PRESS_MASK = 1 << 8,
239 GDK_BUTTON_RELEASE_MASK = 1 << 9,
240 GDK_KEY_PRESS_MASK = 1 << 10,
241 GDK_KEY_RELEASE_MASK = 1 << 11,
242 GDK_ENTER_NOTIFY_MASK = 1 << 12,
243 GDK_LEAVE_NOTIFY_MASK = 1 << 13,
244 GDK_FOCUS_CHANGE_MASK = 1 << 14,
245 GDK_STRUCTURE_MASK = 1 << 15,
246 GDK_PROPERTY_CHANGE_MASK = 1 << 16,
247 GDK_VISIBILITY_NOTIFY_MASK = 1 << 17,
248 GDK_PROXIMITY_IN_MASK = 1 << 18,
249 GDK_PROXIMITY_OUT_MASK = 1 << 19,
250 GDK_SUBSTRUCTURE_MASK = 1 << 20,
251 GDK_SCROLL_MASK = 1 << 21,
252 GDK_ALL_EVENTS_MASK = 0x3FFFFE
271 #endif /* __GDK_TYPES_H__ */