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 */
53 * Represents the current time, and can be used anywhere a time is expected.
55 #define GDK_CURRENT_TIME 0L
58 * GDK_PARENT_RELATIVE:
60 * A special value, indicating that the background
61 * for a window should be inherited from the parent window.
63 #define GDK_PARENT_RELATIVE 1L
70 /* Type definitions for the basic structures.
72 typedef struct _GdkPoint GdkPoint;
77 * Defines the position and size of a rectangle. It is identical to
78 * #cairo_rectangle_int_t.
80 typedef cairo_rectangle_int_t GdkRectangle;
85 * An opaque type representing a string as an index into a table
86 * of strings on the X server.
88 typedef struct _GdkAtom *GdkAtom;
91 * GDK_ATOM_TO_POINTER:
94 * Converts a #GdkAtom into a pointer type.
96 #define GDK_ATOM_TO_POINTER(atom) (atom)
99 * GDK_POINTER_TO_ATOM:
100 * @ptr: a pointer containing a #GdkAtom.
102 * Extracts a #GdkAtom from a pointer. The #GdkAtom must have been
103 * stored in the pointer with GDK_ATOM_TO_POINTER().
105 #define GDK_POINTER_TO_ATOM(ptr) ((GdkAtom)(ptr))
107 #ifdef GDK_NATIVE_WINDOW_POINTER
108 #define GDK_GPOINTER_TO_NATIVE_WINDOW(p) ((GdkNativeWindow) (p))
110 #define GDK_GPOINTER_TO_NATIVE_WINDOW(p) GPOINTER_TO_UINT(p)
113 #define _GDK_MAKE_ATOM(val) ((GdkAtom)GUINT_TO_POINTER(val))
118 * A null value for #GdkAtom, used in a similar way as
119 * <literal>None</literal> in the Xlib API.
121 #define GDK_NONE _GDK_MAKE_ATOM (0)
126 * Used to represent native windows (<type>Window</type>s for the X11
127 * backend, <type>HWND</type>s for Win32).
129 #ifdef GDK_NATIVE_WINDOW_POINTER
130 typedef gpointer GdkNativeWindow;
132 typedef guint32 GdkNativeWindow;
135 /* Forward declarations of commonly used types
137 typedef struct _GdkColor GdkColor;
138 typedef struct _GdkRGBA GdkRGBA;
139 typedef struct _GdkCursor GdkCursor;
140 typedef struct _GdkVisual GdkVisual;
142 typedef struct _GdkDrawable GdkDrawable;
147 * An opaque structure representing an onscreen drawable.
149 typedef struct _GdkDrawable GdkWindow;
150 typedef struct _GdkDisplay GdkDisplay;
151 typedef struct _GdkScreen GdkScreen;
155 * @GDK_LSB_FIRST: The values are stored with the least-significant byte
156 * first. For instance, the 32-bit value 0xffeecc would be stored
157 * in memory as 0xcc, 0xee, 0xff, 0x00.
158 * @GDK_MSB_FIRST: The values are stored with the most-significant byte
159 * first. For instance, the 32-bit value 0xffeecc would be stored
160 * in memory as 0x00, 0xcc, 0xee, 0xff.
162 * A set of values describing the possible byte-orders
163 * for storing pixel values in memory.
171 /* Types of modifiers.
175 * @GDK_SHIFT_MASK: the Shift key.
176 * @GDK_LOCK_MASK: a Lock key (depending on the modifier mapping of the
177 * X server this may either be CapsLock or ShiftLock).
178 * @GDK_CONTROL_MASK: the Control key.
179 * @GDK_MOD1_MASK: the fourth modifier key (it depends on the modifier
180 * mapping of the X server which key is interpreted as this modifier, but
181 * normally it is the Alt key).
182 * @GDK_MOD2_MASK: the fifth modifier key (it depends on the modifier
183 * mapping of the X server which key is interpreted as this modifier).
184 * @GDK_MOD3_MASK: the sixth modifier key (it depends on the modifier
185 * mapping of the X server which key is interpreted as this modifier).
186 * @GDK_MOD4_MASK: the seventh modifier key (it depends on the modifier
187 * mapping of the X server which key is interpreted as this modifier).
188 * @GDK_MOD5_MASK: the eighth modifier key (it depends on the modifier
189 * mapping of the X server which key is interpreted as this modifier).
190 * @GDK_BUTTON1_MASK: the first mouse button.
191 * @GDK_BUTTON2_MASK: the second mouse button.
192 * @GDK_BUTTON3_MASK: the third mouse button.
193 * @GDK_BUTTON4_MASK: the fourth mouse button.
194 * @GDK_BUTTON5_MASK: the fifth mouse button.
195 * @GDK_SUPER_MASK: the Super modifier. Since 2.10
196 * @GDK_HYPER_MASK: the Hyper modifier. Since 2.10
197 * @GDK_META_MASK: the Meta modifier. Since 2.10
198 * @GDK_RELEASE_MASK: not used in GDK itself. GTK+ uses it to differentiate
199 * between (keyval, modifiers) pairs from key press and release events.
200 * @GDK_MODIFIER_MASK: a mask covering all modifier types.
202 * A set of bit-flags to indicate the state of modifier keys and mouse buttons
203 * in various event types. Typical modifier keys are Shift, Control, Meta,
204 * Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.
206 * Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.
208 * Since 2.10, GDK recognizes which of the Meta, Super or Hyper keys are mapped
209 * to Mod2 - Mod5, and indicates this by setting %GDK_SUPER_MASK,
210 * %GDK_HYPER_MASK or %GDK_META_MASK in the state field of key events.
214 GDK_SHIFT_MASK = 1 << 0,
215 GDK_LOCK_MASK = 1 << 1,
216 GDK_CONTROL_MASK = 1 << 2,
217 GDK_MOD1_MASK = 1 << 3,
218 GDK_MOD2_MASK = 1 << 4,
219 GDK_MOD3_MASK = 1 << 5,
220 GDK_MOD4_MASK = 1 << 6,
221 GDK_MOD5_MASK = 1 << 7,
222 GDK_BUTTON1_MASK = 1 << 8,
223 GDK_BUTTON2_MASK = 1 << 9,
224 GDK_BUTTON3_MASK = 1 << 10,
225 GDK_BUTTON4_MASK = 1 << 11,
226 GDK_BUTTON5_MASK = 1 << 12,
228 /* The next few modifiers are used by XKB, so we skip to the end.
229 * Bits 15 - 25 are currently unused. Bit 29 is used internally.
232 GDK_SUPER_MASK = 1 << 26,
233 GDK_HYPER_MASK = 1 << 27,
234 GDK_META_MASK = 1 << 28,
236 GDK_RELEASE_MASK = 1 << 30,
238 GDK_MODIFIER_MASK = 0x5c001fff
245 GDK_ERROR_PARAM = -2,
252 * @GDK_GRAB_SUCCESS: the resource was successfully grabbed.
253 * @GDK_GRAB_ALREADY_GRABBED: the resource is actively grabbed by another client.
254 * @GDK_GRAB_INVALID_TIME: the resource was grabbed more recently than the
256 * @GDK_GRAB_NOT_VIEWABLE: the grab window or the @confine_to window are not
258 * @GDK_GRAB_FROZEN: the resource is frozen by an active grab of another client.
260 * Returned by gdk_pointer_grab() and gdk_keyboard_grab() to indicate
261 * success or the reason for the failure of the grab attempt.
265 GDK_GRAB_SUCCESS = 0,
266 GDK_GRAB_ALREADY_GRABBED = 1,
267 GDK_GRAB_INVALID_TIME = 2,
268 GDK_GRAB_NOT_VIEWABLE = 3,
274 * @GDK_OWNERSHIP_NONE: All other devices' events are allowed.
275 * @GDK_OWNERSHIP_WINDOW: Other devices' events are blocked for the grab window.
276 * @GDK_OWNERSHIP_APPLICATION: Other devices' events are blocked for the whole application.
278 * Defines how device grabs interact with other devices.
283 GDK_OWNERSHIP_WINDOW,
284 GDK_OWNERSHIP_APPLICATION
289 * @GDK_EXPOSURE_MASK: receive expose events
290 * @GDK_POINTER_MOTION_MASK: receive all pointer motion events
291 * @GDK_POINTER_MOTION_HINT_MASK: see the explanation above
292 * @GDK_BUTTON_MOTION_MASK: receive pointer motion events while any button is pressed
293 * @GDK_BUTTON1_MOTION_MASK: receive pointer motion events while 1 button is pressed
294 * @GDK_BUTTON2_MOTION_MASK: receive pointer motion events while 2 button is pressed
295 * @GDK_BUTTON3_MOTION_MASK: receive pointer motion events while 3 button is pressed
296 * @GDK_BUTTON_PRESS_MASK: receive button press events
297 * @GDK_BUTTON_RELEASE_MASK: receive button release events
298 * @GDK_KEY_PRESS_MASK: receive key press events
299 * @GDK_KEY_RELEASE_MASK: receive key release events
300 * @GDK_ENTER_NOTIFY_MASK: receive window enter events
301 * @GDK_LEAVE_NOTIFY_MASK: receive window leave events
302 * @GDK_FOCUS_CHANGE_MASK: receive focus change events
303 * @GDK_STRUCTURE_MASK: receive events about window configuration change
304 * @GDK_PROPERTY_CHANGE_MASK: receive property change events
305 * @GDK_VISIBILITY_NOTIFY_MASK: receive visibility change events
306 * @GDK_PROXIMITY_IN_MASK: receive proximity in events
307 * @GDK_PROXIMITY_OUT_MASK: receive proximity out events
308 * @GDK_SUBSTRUCTURE_MASK: receive events about window configuration changes of
310 * @GDK_SCROLL_MASK: receive scroll events
311 * @GDK_ALL_EVENTS_MASK: the combination of all the above event masks.
313 * A set of bit-flags to indicate which events a window is to receive.
314 * Most of these masks map onto one or more of the #GdkEventType event types
317 * %GDK_POINTER_MOTION_HINT_MASK is a special mask which is used to reduce the
318 * number of %GDK_MOTION_NOTIFY events received. Normally a %GDK_MOTION_NOTIFY
319 * event is received each time the mouse moves. However, if the application
320 * spends a lot of time processing the event (updating the display, for example),
321 * it can lag behind the position of the mouse. When using
322 * %GDK_POINTER_MOTION_HINT_MASK, fewer %GDK_MOTION_NOTIFY events will be sent,
323 * some of which are marked as a hint (the is_hint member is %TRUE).
324 * To receive more motion events after a motion hint event, the application
325 * needs to asks for more, by calling gdk_event_request_motions().
329 GDK_EXPOSURE_MASK = 1 << 1,
330 GDK_POINTER_MOTION_MASK = 1 << 2,
331 GDK_POINTER_MOTION_HINT_MASK = 1 << 3,
332 GDK_BUTTON_MOTION_MASK = 1 << 4,
333 GDK_BUTTON1_MOTION_MASK = 1 << 5,
334 GDK_BUTTON2_MOTION_MASK = 1 << 6,
335 GDK_BUTTON3_MOTION_MASK = 1 << 7,
336 GDK_BUTTON_PRESS_MASK = 1 << 8,
337 GDK_BUTTON_RELEASE_MASK = 1 << 9,
338 GDK_KEY_PRESS_MASK = 1 << 10,
339 GDK_KEY_RELEASE_MASK = 1 << 11,
340 GDK_ENTER_NOTIFY_MASK = 1 << 12,
341 GDK_LEAVE_NOTIFY_MASK = 1 << 13,
342 GDK_FOCUS_CHANGE_MASK = 1 << 14,
343 GDK_STRUCTURE_MASK = 1 << 15,
344 GDK_PROPERTY_CHANGE_MASK = 1 << 16,
345 GDK_VISIBILITY_NOTIFY_MASK = 1 << 17,
346 GDK_PROXIMITY_IN_MASK = 1 << 18,
347 GDK_PROXIMITY_OUT_MASK = 1 << 19,
348 GDK_SUBSTRUCTURE_MASK = 1 << 20,
349 GDK_SCROLL_MASK = 1 << 21,
350 GDK_ALL_EVENTS_MASK = 0x3FFFFE
355 * @x: the x coordinate of the point.
356 * @y: the y coordinate of the point.
358 * Defines the x and y coordinates of a point.
370 #endif /* __GDK_TYPES_H__ */