X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=gdk%2Fgdktypes.h;h=d655ff97da4964106e167ab5c935f27cc2e8a034;hb=920e8b434367f9aa8aab306721cc024e66892e2e;hp=de5d6ac8a9a19827c06658b76783a4452d371784;hpb=00c5e838710a01ed97a46d96910b6f118d240b99;p=~andy%2Fgtk diff --git a/gdk/gdktypes.h b/gdk/gdktypes.h index de5d6ac8a..d655ff97d 100644 --- a/gdk/gdktypes.h +++ b/gdk/gdktypes.h @@ -2,96 +2,164 @@ * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald * * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Library General Public + * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Library General Public License for more details. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. * - * You should have received a copy of the GNU Library General Public + * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ /* - * Modified by the GTK+ Team and others 1997-1999. See the AUTHORS + * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS * file for a list of people on the GTK+ Team. See the ChangeLog * files for a list of changes. These files are distributed with - * GTK+ at ftp://ftp.gtk.org/pub/gtk/. + * GTK+ at ftp://ftp.gtk.org/pub/gtk/. */ +#if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION) +#error "Only can be included directly." +#endif + #ifndef __GDK_TYPES_H__ #define __GDK_TYPES_H__ /* GDK uses "glib". (And so does GTK). */ #include - -#ifdef G_OS_WIN32 -# ifdef GDK_COMPILATION -# define GDKVAR __declspec(dllexport) -# else -# define GDKVAR extern __declspec(dllimport) -# endif -#else -# define GDKVAR extern -#endif +#include +#include +#include /* The system specific file gdkconfig.h contains such configuration * settings that are needed not only when compiling GDK (or GTK) * itself, but also occasionally when compiling programs that use GDK * (or GTK). One such setting is what windowing API backend is in use. */ -#include +#include /* some common magic values */ -#define GDK_NONE 0L + +/** + * GDK_CURRENT_TIME: + * + * Represents the current time, and can be used anywhere a time is expected. + */ #define GDK_CURRENT_TIME 0L + +/** + * GDK_PARENT_RELATIVE: + * + * A special value, indicating that the background + * for a window should be inherited from the parent window. + */ #define GDK_PARENT_RELATIVE 1L -/* special deviceid for core pointer events */ -#define GDK_CORE_POINTER 0xfedc -#ifdef __cplusplus -extern "C" { -#endif /* __cplusplus */ +G_BEGIN_DECLS /* Type definitions for the basic structures. */ -typedef struct _GdkPoint GdkPoint; -typedef struct _GdkRectangle GdkRectangle; -typedef struct _GdkSegment GdkSegment; +typedef struct _GdkPoint GdkPoint; -/* - * Note that on some platforms the wchar_t type - * is not the same as GdkWChar. For instance - * on Win32, wchar_t is unsigned short. - */ -typedef guint32 GdkWChar; -typedef gulong GdkAtom; - -/* Forward declarations of commonly used types - */ -typedef struct _GdkColor GdkColor; -typedef struct _GdkColormap GdkColormap; -typedef struct _GdkCursor GdkCursor; -typedef struct _GdkFont GdkFont; -typedef struct _GdkGC GdkGC; -typedef struct _GdkImage GdkImage; -typedef struct _GdkRegion GdkRegion; +/** + * GdkRectangle: + * + * Defines the position and size of a rectangle. It is identical to + * #cairo_rectangle_int_t. + */ +typedef cairo_rectangle_int_t GdkRectangle; + +/** + * GdkAtom: + * + * An opaque type representing a string as an index into a table + * of strings on the X server. + */ +typedef struct _GdkAtom *GdkAtom; + +/** + * GDK_ATOM_TO_POINTER: + * @atom: a #GdkAtom. + * + * Converts a #GdkAtom into a pointer type. + */ +#define GDK_ATOM_TO_POINTER(atom) (atom) + +/** + * GDK_POINTER_TO_ATOM: + * @ptr: a pointer containing a #GdkAtom. + * + * Extracts a #GdkAtom from a pointer. The #GdkAtom must have been + * stored in the pointer with GDK_ATOM_TO_POINTER(). + */ +#define GDK_POINTER_TO_ATOM(ptr) ((GdkAtom)(ptr)) + +#ifdef GDK_NATIVE_WINDOW_POINTER +#define GDK_GPOINTER_TO_NATIVE_WINDOW(p) ((GdkNativeWindow) (p)) +#else +#define GDK_GPOINTER_TO_NATIVE_WINDOW(p) GPOINTER_TO_UINT(p) +#endif + +#define _GDK_MAKE_ATOM(val) ((GdkAtom)GUINT_TO_POINTER(val)) + +/** + * GDK_NONE: + * + * A null value for #GdkAtom, used in a similar way as + * None in the Xlib API. + */ +#define GDK_NONE _GDK_MAKE_ATOM (0) + +/** + * GdkNativeWindow: + * + * Used to represent native windows (Windows for the X11 + * backend, HWNDs for Win32). + */ +#ifdef GDK_NATIVE_WINDOW_POINTER +typedef gpointer GdkNativeWindow; +#else +typedef guint32 GdkNativeWindow; +#endif + +/* Forward declarations of commonly used types */ +typedef struct _GdkColor GdkColor; +typedef struct _GdkRGBA GdkRGBA; +typedef struct _GdkCursor GdkCursor; typedef struct _GdkVisual GdkVisual; +typedef struct _GdkDevice GdkDevice; +typedef struct _GdkDragContext GdkDragContext; -typedef struct _GdkDrawable GdkDrawable; -typedef struct _GdkDrawable GdkBitmap; -typedef struct _GdkDrawable GdkPixmap; -typedef struct _GdkDrawable GdkWindow; +typedef struct _GdkDisplayManager GdkDisplayManager; +typedef struct _GdkDeviceManager GdkDeviceManager; +typedef struct _GdkDisplay GdkDisplay; +typedef struct _GdkScreen GdkScreen; +typedef struct _GdkWindow GdkWindow; +typedef struct _GdkKeymap GdkKeymap; +typedef struct _GdkAppLaunchContext GdkAppLaunchContext; +/** + * GdkByteOrder: + * @GDK_LSB_FIRST: The values are stored with the least-significant byte + * first. For instance, the 32-bit value 0xffeecc would be stored + * in memory as 0xcc, 0xee, 0xff, 0x00. + * @GDK_MSB_FIRST: The values are stored with the most-significant byte + * first. For instance, the 32-bit value 0xffeecc would be stored + * in memory as 0x00, 0xcc, 0xee, 0xff. + * + * A set of values describing the possible byte-orders + * for storing pixel values in memory. + */ typedef enum { GDK_LSB_FIRST, @@ -100,73 +168,201 @@ typedef enum /* Types of modifiers. */ +/** + * GdkModifierType: + * @GDK_SHIFT_MASK: the Shift key. + * @GDK_LOCK_MASK: a Lock key (depending on the modifier mapping of the + * X server this may either be CapsLock or ShiftLock). + * @GDK_CONTROL_MASK: the Control key. + * @GDK_MOD1_MASK: the fourth modifier key (it depends on the modifier + * mapping of the X server which key is interpreted as this modifier, but + * normally it is the Alt key). + * @GDK_MOD2_MASK: the fifth modifier key (it depends on the modifier + * mapping of the X server which key is interpreted as this modifier). + * @GDK_MOD3_MASK: the sixth modifier key (it depends on the modifier + * mapping of the X server which key is interpreted as this modifier). + * @GDK_MOD4_MASK: the seventh modifier key (it depends on the modifier + * mapping of the X server which key is interpreted as this modifier). + * @GDK_MOD5_MASK: the eighth modifier key (it depends on the modifier + * mapping of the X server which key is interpreted as this modifier). + * @GDK_BUTTON1_MASK: the first mouse button. + * @GDK_BUTTON2_MASK: the second mouse button. + * @GDK_BUTTON3_MASK: the third mouse button. + * @GDK_BUTTON4_MASK: the fourth mouse button. + * @GDK_BUTTON5_MASK: the fifth mouse button. + * @GDK_SUPER_MASK: the Super modifier. Since 2.10 + * @GDK_HYPER_MASK: the Hyper modifier. Since 2.10 + * @GDK_META_MASK: the Meta modifier. Since 2.10 + * @GDK_RELEASE_MASK: not used in GDK itself. GTK+ uses it to differentiate + * between (keyval, modifiers) pairs from key press and release events. + * @GDK_MODIFIER_MASK: a mask covering all modifier types. + * + * A set of bit-flags to indicate the state of modifier keys and mouse buttons + * in various event types. Typical modifier keys are Shift, Control, Meta, + * Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock. + * + * Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons. + * + * Since 2.10, GDK recognizes which of the Meta, Super or Hyper keys are mapped + * to Mod2 - Mod5, and indicates this by setting %GDK_SUPER_MASK, + * %GDK_HYPER_MASK or %GDK_META_MASK in the state field of key events. + */ typedef enum { GDK_SHIFT_MASK = 1 << 0, - GDK_LOCK_MASK = 1 << 1, + GDK_LOCK_MASK = 1 << 1, GDK_CONTROL_MASK = 1 << 2, - GDK_MOD1_MASK = 1 << 3, - GDK_MOD2_MASK = 1 << 4, - GDK_MOD3_MASK = 1 << 5, - GDK_MOD4_MASK = 1 << 6, - GDK_MOD5_MASK = 1 << 7, + GDK_MOD1_MASK = 1 << 3, + GDK_MOD2_MASK = 1 << 4, + GDK_MOD3_MASK = 1 << 5, + GDK_MOD4_MASK = 1 << 6, + GDK_MOD5_MASK = 1 << 7, GDK_BUTTON1_MASK = 1 << 8, GDK_BUTTON2_MASK = 1 << 9, GDK_BUTTON3_MASK = 1 << 10, GDK_BUTTON4_MASK = 1 << 11, GDK_BUTTON5_MASK = 1 << 12, - GDK_RELEASE_MASK = 1 << 13, - GDK_MODIFIER_MASK = 0x3fff -} GdkModifierType; -typedef enum -{ - GDK_INPUT_READ = 1 << 0, - GDK_INPUT_WRITE = 1 << 1, - GDK_INPUT_EXCEPTION = 1 << 2 -} GdkInputCondition; + /* The next few modifiers are used by XKB, so we skip to the end. + * Bits 15 - 25 are currently unused. Bit 29 is used internally. + */ + + GDK_SUPER_MASK = 1 << 26, + GDK_HYPER_MASK = 1 << 27, + GDK_META_MASK = 1 << 28, + + GDK_RELEASE_MASK = 1 << 30, + + GDK_MODIFIER_MASK = 0x5c001fff +} GdkModifierType; typedef enum { - GDK_OK = 0, - GDK_ERROR = -1, + GDK_OK = 0, + GDK_ERROR = -1, GDK_ERROR_PARAM = -2, GDK_ERROR_FILE = -3, - GDK_ERROR_MEM = -4 + GDK_ERROR_MEM = -4 } GdkStatus; -typedef void (*GdkInputFunction) (gpointer data, - gint source, - GdkInputCondition condition); - -typedef void (*GdkDestroyNotify) (gpointer data); +/** + * GdkGrabStatus: + * @GDK_GRAB_SUCCESS: the resource was successfully grabbed. + * @GDK_GRAB_ALREADY_GRABBED: the resource is actively grabbed by another client. + * @GDK_GRAB_INVALID_TIME: the resource was grabbed more recently than the + * specified time. + * @GDK_GRAB_NOT_VIEWABLE: the grab window or the @confine_to window are not + * viewable. + * @GDK_GRAB_FROZEN: the resource is frozen by an active grab of another client. + * + * Returned by gdk_pointer_grab() and gdk_keyboard_grab() to indicate + * success or the reason for the failure of the grab attempt. + */ +typedef enum +{ + GDK_GRAB_SUCCESS = 0, + GDK_GRAB_ALREADY_GRABBED = 1, + GDK_GRAB_INVALID_TIME = 2, + GDK_GRAB_NOT_VIEWABLE = 3, + GDK_GRAB_FROZEN = 4 +} GdkGrabStatus; -struct _GdkPoint +/** + * GdkGrabOwnership: + * @GDK_OWNERSHIP_NONE: All other devices' events are allowed. + * @GDK_OWNERSHIP_WINDOW: Other devices' events are blocked for the grab window. + * @GDK_OWNERSHIP_APPLICATION: Other devices' events are blocked for the whole application. + * + * Defines how device grabs interact with other devices. + */ +typedef enum { - gint16 x; - gint16 y; -}; + GDK_OWNERSHIP_NONE, + GDK_OWNERSHIP_WINDOW, + GDK_OWNERSHIP_APPLICATION +} GdkGrabOwnership; -struct _GdkRectangle +/** + * GdkEventMask: + * @GDK_EXPOSURE_MASK: receive expose events + * @GDK_POINTER_MOTION_MASK: receive all pointer motion events + * @GDK_POINTER_MOTION_HINT_MASK: see the explanation above + * @GDK_BUTTON_MOTION_MASK: receive pointer motion events while any button is pressed + * @GDK_BUTTON1_MOTION_MASK: receive pointer motion events while 1 button is pressed + * @GDK_BUTTON2_MOTION_MASK: receive pointer motion events while 2 button is pressed + * @GDK_BUTTON3_MOTION_MASK: receive pointer motion events while 3 button is pressed + * @GDK_BUTTON_PRESS_MASK: receive button press events + * @GDK_BUTTON_RELEASE_MASK: receive button release events + * @GDK_KEY_PRESS_MASK: receive key press events + * @GDK_KEY_RELEASE_MASK: receive key release events + * @GDK_ENTER_NOTIFY_MASK: receive window enter events + * @GDK_LEAVE_NOTIFY_MASK: receive window leave events + * @GDK_FOCUS_CHANGE_MASK: receive focus change events + * @GDK_STRUCTURE_MASK: receive events about window configuration change + * @GDK_PROPERTY_CHANGE_MASK: receive property change events + * @GDK_VISIBILITY_NOTIFY_MASK: receive visibility change events + * @GDK_PROXIMITY_IN_MASK: receive proximity in events + * @GDK_PROXIMITY_OUT_MASK: receive proximity out events + * @GDK_SUBSTRUCTURE_MASK: receive events about window configuration changes of + * child windows + * @GDK_SCROLL_MASK: receive scroll events + * @GDK_ALL_EVENTS_MASK: the combination of all the above event masks. + * + * A set of bit-flags to indicate which events a window is to receive. + * Most of these masks map onto one or more of the #GdkEventType event types + * above. + * + * %GDK_POINTER_MOTION_HINT_MASK is a special mask which is used to reduce the + * number of %GDK_MOTION_NOTIFY events received. Normally a %GDK_MOTION_NOTIFY + * event is received each time the mouse moves. However, if the application + * spends a lot of time processing the event (updating the display, for example), + * it can lag behind the position of the mouse. When using + * %GDK_POINTER_MOTION_HINT_MASK, fewer %GDK_MOTION_NOTIFY events will be sent, + * some of which are marked as a hint (the is_hint member is %TRUE). + * To receive more motion events after a motion hint event, the application + * needs to asks for more, by calling gdk_event_request_motions(). + */ +typedef enum { - gint16 x; - gint16 y; - guint16 width; - guint16 height; -}; + GDK_EXPOSURE_MASK = 1 << 1, + GDK_POINTER_MOTION_MASK = 1 << 2, + GDK_POINTER_MOTION_HINT_MASK = 1 << 3, + GDK_BUTTON_MOTION_MASK = 1 << 4, + GDK_BUTTON1_MOTION_MASK = 1 << 5, + GDK_BUTTON2_MOTION_MASK = 1 << 6, + GDK_BUTTON3_MOTION_MASK = 1 << 7, + GDK_BUTTON_PRESS_MASK = 1 << 8, + GDK_BUTTON_RELEASE_MASK = 1 << 9, + GDK_KEY_PRESS_MASK = 1 << 10, + GDK_KEY_RELEASE_MASK = 1 << 11, + GDK_ENTER_NOTIFY_MASK = 1 << 12, + GDK_LEAVE_NOTIFY_MASK = 1 << 13, + GDK_FOCUS_CHANGE_MASK = 1 << 14, + GDK_STRUCTURE_MASK = 1 << 15, + GDK_PROPERTY_CHANGE_MASK = 1 << 16, + GDK_VISIBILITY_NOTIFY_MASK = 1 << 17, + GDK_PROXIMITY_IN_MASK = 1 << 18, + GDK_PROXIMITY_OUT_MASK = 1 << 19, + GDK_SUBSTRUCTURE_MASK = 1 << 20, + GDK_SCROLL_MASK = 1 << 21, + GDK_ALL_EVENTS_MASK = 0x3FFFFE +} GdkEventMask; -struct _GdkSegment +/** + * GdkPoint: + * @x: the x coordinate of the point. + * @y: the y coordinate of the point. + * + * Defines the x and y coordinates of a point. + */ +struct _GdkPoint { - gint16 x1; - gint16 y1; - gint16 x2; - gint16 y2; + gint x; + gint y; }; -#ifdef __cplusplus -} -#endif /* __cplusplus */ +G_END_DECLS #endif /* __GDK_TYPES_H__ */