Pileus Git - ~andy/gtk/blob - 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 #if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
  28 #error "Only <gdk/gdk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GDK_TYPES_H__
  32 #define __GDK_TYPES_H__
  33
  34 /* GDK uses "glib". (And so does GTK).
  35  */
  36 #include <glib.h>
  37 #include <pango/pango.h>
  38 #include <glib-object.h>
  39 #include <cairo.h>
  40
  41 #ifdef G_OS_WIN32
  42 #  ifdef GDK_COMPILATION
  43 #    define GDKVAR __declspec(dllexport)
  44 #  else
  45 #    define GDKVAR extern __declspec(dllimport)
  46 #  endif
  47 #else
  48 #  define GDKVAR extern
  49 #endif
  50
  51 /* The system specific file gdkconfig.h contains such configuration
  52  * settings that are needed not only when compiling GDK (or GTK)
  53  * itself, but also occasionally when compiling programs that use GDK
  54  * (or GTK). One such setting is what windowing API backend is in use.
  55  */
  56 #include <gdkconfig.h>
  57
  58 /* some common magic values */
  59 #define GDK_CURRENT_TIME     0L
  60
  61 /**
  62  * GDK_PARENT_RELATIVE:
  63  *
  64  * A special value for #GdkPixmap variables, indicating that the background
  65  * pixmap for a window should be inherited from the parent window.
  66  */
  67 #define GDK_PARENT_RELATIVE  1L
  68
  69
  70
  71 G_BEGIN_DECLS
  72
  73
  74 /* Type definitions for the basic structures.
  75  */
  76 typedef struct _GdkPoint              GdkPoint;
  77 typedef cairo_rectangle_int_t         GdkRectangle;
  78 typedef struct _GdkSpan               GdkSpan;
  79
  80 typedef struct _GdkAtom            *GdkAtom;
  81
  82 #define GDK_ATOM_TO_POINTER(atom) (atom)
  83 #define GDK_POINTER_TO_ATOM(ptr)  ((GdkAtom)(ptr))
  84
  85 #ifdef GDK_NATIVE_WINDOW_POINTER
  86 #define GDK_GPOINTER_TO_NATIVE_WINDOW(p) ((GdkNativeWindow) (p))
  87 #else
  88 #define GDK_GPOINTER_TO_NATIVE_WINDOW(p) GPOINTER_TO_UINT(p)
  89 #endif
  90
  91 #define _GDK_MAKE_ATOM(val) ((GdkAtom)GUINT_TO_POINTER(val))
  92 #define GDK_NONE            _GDK_MAKE_ATOM (0)
  93
  94 #ifdef GDK_NATIVE_WINDOW_POINTER
  95 typedef gpointer GdkNativeWindow;
  96 #else
  97 typedef guint32 GdkNativeWindow;
  98 #endif
  99
 100 /* Forward declarations of commonly used types
 101  */
 102 typedef struct _GdkColor              GdkColor;
 103 typedef struct _GdkColormap           GdkColormap;
 104 typedef struct _GdkCursor             GdkCursor;
 105 typedef struct _GdkGC                 GdkGC;
 106 typedef struct _GdkVisual             GdkVisual;
 107
 108 typedef struct _GdkDrawable           GdkDrawable;
 109 typedef struct _GdkDrawable           GdkBitmap;
 110 typedef struct _GdkDrawable           GdkPixmap;
 111
 112 /**
 113  * GdkWindow:
 114  *
 115  * An opaque structure representing an onscreen drawable. Pointers to structures
 116  * of type #GdkPixmap, #GdkBitmap, and #GdkWindow can often be used
 117  * interchangeably. The type #GdkDrawable refers generically to any of these
 118  * types.
 119  */
 120 typedef struct _GdkDrawable           GdkWindow;
 121 typedef struct _GdkDisplay            GdkDisplay;
 122 typedef struct _GdkScreen             GdkScreen;
 123
 124 typedef enum
 125 {
 126   GDK_LSB_FIRST,
 127   GDK_MSB_FIRST
 128 } GdkByteOrder;
 129
 130 /* Types of modifiers.
 131  */
 132 /**
 133  * GdkModifierType:
 134  * @GDK_SHIFT_MASK: the Shift key.
 135  * @GDK_LOCK_MASK: a Lock key (depending on the modifier mapping of the
 136  *  X server this may either be CapsLock or ShiftLock).
 137  * @GDK_CONTROL_MASK: the Control key.
 138  * @GDK_MOD1_MASK: the fourth modifier key (it depends on the modifier
 139  *  mapping of the X server which key is interpreted as this modifier, but
 140  *  normally it is the Alt key).
 141  * @GDK_MOD2_MASK: the fifth modifier key (it depends on the modifier
 142  *  mapping of the X server which key is interpreted as this modifier).
 143  * @GDK_MOD3_MASK: the sixth modifier key (it depends on the modifier
 144  *  mapping of the X server which key is interpreted as this modifier).
 145  * @GDK_MOD4_MASK: the seventh modifier key (it depends on the modifier
 146  *  mapping of the X server which key is interpreted as this modifier).
 147  * @GDK_MOD5_MASK: the eighth modifier key (it depends on the modifier
 148  *  mapping of the X server which key is interpreted as this modifier).
 149  * @GDK_BUTTON1_MASK: the first mouse button.
 150  * @GDK_BUTTON2_MASK: the second mouse button.
 151  * @GDK_BUTTON3_MASK: the third mouse button.
 152  * @GDK_BUTTON4_MASK: the fourth mouse button.
 153  * @GDK_BUTTON5_MASK: the fifth mouse button.
 154  * @GDK_SUPER_MASK: the Super modifier. Since 2.10
 155  * @GDK_HYPER_MASK: the Hyper modifier. Since 2.10
 156  * @GDK_META_MASK: the Meta modifier. Since 2.10
 157  * @GDK_RELEASE_MASK: not used in GDK itself. GTK+ uses it to differentiate
 158  *  between (keyval, modifiers) pairs from key press and release events.
 159  * @GDK_MODIFIER_MASK: a mask covering all modifier types.
 160  *
 161  * A set of bit-flags to indicate the state of modifier keys and mouse buttons
 162  * in various event types. Typical modifier keys are Shift, Control, Meta,
 163  * Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.
 164  *
 165  * Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.
 166  *
 167  * Since 2.10, GDK recognizes which of the Meta, Super or Hyper keys are mapped
 168  * to Mod2 - Mod5, and indicates this by setting %GDK_SUPER_MASK,
 169  * %GDK_HYPER_MASK or %GDK_META_MASK in the state field of key events.
 170  */
 171 typedef enum
 172 {
 173   GDK_SHIFT_MASK    = 1 << 0,
 174   GDK_LOCK_MASK     = 1 << 1,
 175   GDK_CONTROL_MASK  = 1 << 2,
 176   GDK_MOD1_MASK     = 1 << 3,
 177   GDK_MOD2_MASK     = 1 << 4,
 178   GDK_MOD3_MASK     = 1 << 5,
 179   GDK_MOD4_MASK     = 1 << 6,
 180   GDK_MOD5_MASK     = 1 << 7,
 181   GDK_BUTTON1_MASK  = 1 << 8,
 182   GDK_BUTTON2_MASK  = 1 << 9,
 183   GDK_BUTTON3_MASK  = 1 << 10,
 184   GDK_BUTTON4_MASK  = 1 << 11,
 185   GDK_BUTTON5_MASK  = 1 << 12,
 186
 187   /* The next few modifiers are used by XKB, so we skip to the end.
 188    * Bits 15 - 25 are currently unused. Bit 29 is used internally.
 189    */
 190
 191   GDK_SUPER_MASK    = 1 << 26,
 192   GDK_HYPER_MASK    = 1 << 27,
 193   GDK_META_MASK     = 1 << 28,
 194
 195   GDK_RELEASE_MASK  = 1 << 30,
 196
 197   GDK_MODIFIER_MASK = 0x5c001fff
 198 } GdkModifierType;
 199
 200 typedef enum
 201 {
 202   GDK_OK          = 0,
 203   GDK_ERROR       = -1,
 204   GDK_ERROR_PARAM = -2,
 205   GDK_ERROR_FILE  = -3,
 206   GDK_ERROR_MEM   = -4
 207 } GdkStatus;
 208
 209 /* We define specific numeric values for these constants,
 210  * since old application code may depend on them matching the X values
 211  * We don't actually depend on the matchup ourselves.
 212  */
 213 typedef enum
 214 {
 215   GDK_GRAB_SUCCESS         = 0,
 216   GDK_GRAB_ALREADY_GRABBED = 1,
 217   GDK_GRAB_INVALID_TIME    = 2,
 218   GDK_GRAB_NOT_VIEWABLE    = 3,
 219   GDK_GRAB_FROZEN          = 4
 220 } GdkGrabStatus;
 221
 222 /**
 223  * GdkGrabOwnership:
 224  * @GDK_OWNERSHIP_NONE: All other devices' events are allowed.
 225  * @GDK_OWNERSHIP_WINDOW: Other devices' events are blocked for the grab window.
 226  * @GDK_OWNERSHIP_APPLICATION: Other devices' events are blocked for the whole application.
 227  *
 228  * Defines how device grabs interact with other devices.
 229  */
 230 typedef enum
 231 {
 232   GDK_OWNERSHIP_NONE,
 233   GDK_OWNERSHIP_WINDOW,
 234   GDK_OWNERSHIP_APPLICATION
 235 } GdkGrabOwnership;
 236
 237 /* Event masks. (Used to select what types of events a window
 238  *  *  will receive).
 239  *   */
 240 typedef enum
 241 {
 242   GDK_EXPOSURE_MASK             = 1 << 1,
 243   GDK_POINTER_MOTION_MASK       = 1 << 2,
 244   GDK_POINTER_MOTION_HINT_MASK  = 1 << 3,
 245   GDK_BUTTON_MOTION_MASK        = 1 << 4,
 246   GDK_BUTTON1_MOTION_MASK       = 1 << 5,
 247   GDK_BUTTON2_MOTION_MASK       = 1 << 6,
 248   GDK_BUTTON3_MOTION_MASK       = 1 << 7,
 249   GDK_BUTTON_PRESS_MASK         = 1 << 8,
 250   GDK_BUTTON_RELEASE_MASK       = 1 << 9,
 251   GDK_KEY_PRESS_MASK            = 1 << 10,
 252   GDK_KEY_RELEASE_MASK          = 1 << 11,
 253   GDK_ENTER_NOTIFY_MASK         = 1 << 12,
 254   GDK_LEAVE_NOTIFY_MASK         = 1 << 13,
 255   GDK_FOCUS_CHANGE_MASK         = 1 << 14,
 256   GDK_STRUCTURE_MASK            = 1 << 15,
 257   GDK_PROPERTY_CHANGE_MASK      = 1 << 16,
 258   GDK_VISIBILITY_NOTIFY_MASK    = 1 << 17,
 259   GDK_PROXIMITY_IN_MASK         = 1 << 18,
 260   GDK_PROXIMITY_OUT_MASK        = 1 << 19,
 261   GDK_SUBSTRUCTURE_MASK         = 1 << 20,
 262   GDK_SCROLL_MASK               = 1 << 21,
 263   GDK_ALL_EVENTS_MASK           = 0x3FFFFE
 264 } GdkEventMask;
 265
 266 struct _GdkPoint
 267 {
 268   gint x;
 269   gint y;
 270 };
 271
 272 struct _GdkSpan
 273 {
 274   gint x;
 275   gint y;
 276   gint width;
 277 };
 278
 279 G_END_DECLS
 280
 281
 282 #endif /* __GDK_TYPES_H__ */