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 /* 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.
  45  */
  46 #include <gdkconfig.h>
  47
  48 /* some common magic values */
  49
  50 /**
  51  * GDK_CURRENT_TIME:
  52  *
  53  * Represents the current time, and can be used anywhere a time is expected.
  54  */
  55 #define GDK_CURRENT_TIME     0L
  56
  57 /**
  58  * GDK_PARENT_RELATIVE:
  59  *
  60  * A special value, indicating that the background
  61  * for a window should be inherited from the parent window.
  62  */
  63 #define GDK_PARENT_RELATIVE  1L
  64
  65
  66
  67 G_BEGIN_DECLS
  68
  69
  70 /* Type definitions for the basic structures.
  71  */
  72 typedef struct _GdkPoint              GdkPoint;
  73
  74 /**
  75  * GdkRectangle:
  76  *
  77  * Defines the position and size of a rectangle. It is identical to
  78  * #cairo_rectangle_int_t.
  79  */
  80 typedef cairo_rectangle_int_t         GdkRectangle;
  81
  82 /**
  83  * GdkAtom:
  84  *
  85  * An opaque type representing a string as an index into a table
  86  * of strings on the X server.
  87  */
  88 typedef struct _GdkAtom            *GdkAtom;
  89
  90 /**
  91  * GDK_ATOM_TO_POINTER:
  92  * @atom: a #GdkAtom.
  93  *
  94  * Converts a #GdkAtom into a pointer type.
  95  */
  96 #define GDK_ATOM_TO_POINTER(atom) (atom)
  97
  98 /**
  99  * GDK_POINTER_TO_ATOM:
 100  * @ptr: a pointer containing a #GdkAtom.
 101  *
 102  * Extracts a #GdkAtom from a pointer. The #GdkAtom must have been
 103  * stored in the pointer with GDK_ATOM_TO_POINTER().
 104  */
 105 #define GDK_POINTER_TO_ATOM(ptr)  ((GdkAtom)(ptr))
 106
 107 #ifdef GDK_NATIVE_WINDOW_POINTER
 108 #define GDK_GPOINTER_TO_NATIVE_WINDOW(p) ((GdkNativeWindow) (p))
 109 #else
 110 #define GDK_GPOINTER_TO_NATIVE_WINDOW(p) GPOINTER_TO_UINT(p)
 111 #endif
 112
 113 #define _GDK_MAKE_ATOM(val) ((GdkAtom)GUINT_TO_POINTER(val))
 114
 115 /**
 116  * GDK_NONE:
 117  *
 118  * A null value for #GdkAtom, used in a similar way as
 119  * <literal>None</literal> in the Xlib API.
 120  */
 121 #define GDK_NONE            _GDK_MAKE_ATOM (0)
 122
 123 #ifdef GDK_NATIVE_WINDOW_POINTER
 124 typedef gpointer GdkNativeWindow;
 125 #else
 126 typedef guint32 GdkNativeWindow;
 127 #endif
 128
 129 /* Forward declarations of commonly used types
 130  */
 131 typedef struct _GdkColor              GdkColor;
 132 typedef struct _GdkRGBA               GdkRGBA;
 133 typedef struct _GdkCursor             GdkCursor;
 134 typedef struct _GdkVisual             GdkVisual;
 135
 136 typedef struct _GdkDrawable           GdkDrawable;
 137
 138 /**
 139  * GdkWindow:
 140  *
 141  * An opaque structure representing an onscreen drawable.
 142  */
 143 typedef struct _GdkDrawable           GdkWindow;
 144 typedef struct _GdkDisplay            GdkDisplay;
 145 typedef struct _GdkScreen             GdkScreen;
 146
 147 /**
 148  * GdkByteOrder:
 149  * @GDK_LSB_FIRST: The values are stored with the least-significant byte
 150  *   first. For instance, the 32-bit value 0xffeecc would be stored
 151  *   in memory as 0xcc, 0xee, 0xff, 0x00.
 152  * @GDK_MSB_FIRST: The values are stored with the most-significant byte
 153  *   first. For instance, the 32-bit value 0xffeecc would be stored
 154  *   in memory as 0x00, 0xcc, 0xee, 0xff.
 155  *
 156  * A set of values describing the possible byte-orders
 157  * for storing pixel values in memory.
 158  */
 159 typedef enum
 160 {
 161   GDK_LSB_FIRST,
 162   GDK_MSB_FIRST
 163 } GdkByteOrder;
 164
 165 /* Types of modifiers.
 166  */
 167 /**
 168  * GdkModifierType:
 169  * @GDK_SHIFT_MASK: the Shift key.
 170  * @GDK_LOCK_MASK: a Lock key (depending on the modifier mapping of the
 171  *  X server this may either be CapsLock or ShiftLock).
 172  * @GDK_CONTROL_MASK: the Control key.
 173  * @GDK_MOD1_MASK: the fourth modifier key (it depends on the modifier
 174  *  mapping of the X server which key is interpreted as this modifier, but
 175  *  normally it is the Alt key).
 176  * @GDK_MOD2_MASK: the fifth modifier key (it depends on the modifier
 177  *  mapping of the X server which key is interpreted as this modifier).
 178  * @GDK_MOD3_MASK: the sixth modifier key (it depends on the modifier
 179  *  mapping of the X server which key is interpreted as this modifier).
 180  * @GDK_MOD4_MASK: the seventh modifier key (it depends on the modifier
 181  *  mapping of the X server which key is interpreted as this modifier).
 182  * @GDK_MOD5_MASK: the eighth modifier key (it depends on the modifier
 183  *  mapping of the X server which key is interpreted as this modifier).
 184  * @GDK_BUTTON1_MASK: the first mouse button.
 185  * @GDK_BUTTON2_MASK: the second mouse button.
 186  * @GDK_BUTTON3_MASK: the third mouse button.
 187  * @GDK_BUTTON4_MASK: the fourth mouse button.
 188  * @GDK_BUTTON5_MASK: the fifth mouse button.
 189  * @GDK_SUPER_MASK: the Super modifier. Since 2.10
 190  * @GDK_HYPER_MASK: the Hyper modifier. Since 2.10
 191  * @GDK_META_MASK: the Meta modifier. Since 2.10
 192  * @GDK_RELEASE_MASK: not used in GDK itself. GTK+ uses it to differentiate
 193  *  between (keyval, modifiers) pairs from key press and release events.
 194  * @GDK_MODIFIER_MASK: a mask covering all modifier types.
 195  *
 196  * A set of bit-flags to indicate the state of modifier keys and mouse buttons
 197  * in various event types. Typical modifier keys are Shift, Control, Meta,
 198  * Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.
 199  *
 200  * Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.
 201  *
 202  * Since 2.10, GDK recognizes which of the Meta, Super or Hyper keys are mapped
 203  * to Mod2 - Mod5, and indicates this by setting %GDK_SUPER_MASK,
 204  * %GDK_HYPER_MASK or %GDK_META_MASK in the state field of key events.
 205  */
 206 typedef enum
 207 {
 208   GDK_SHIFT_MASK    = 1 << 0,
 209   GDK_LOCK_MASK     = 1 << 1,
 210   GDK_CONTROL_MASK  = 1 << 2,
 211   GDK_MOD1_MASK     = 1 << 3,
 212   GDK_MOD2_MASK     = 1 << 4,
 213   GDK_MOD3_MASK     = 1 << 5,
 214   GDK_MOD4_MASK     = 1 << 6,
 215   GDK_MOD5_MASK     = 1 << 7,
 216   GDK_BUTTON1_MASK  = 1 << 8,
 217   GDK_BUTTON2_MASK  = 1 << 9,
 218   GDK_BUTTON3_MASK  = 1 << 10,
 219   GDK_BUTTON4_MASK  = 1 << 11,
 220   GDK_BUTTON5_MASK  = 1 << 12,
 221
 222   /* The next few modifiers are used by XKB, so we skip to the end.
 223    * Bits 15 - 25 are currently unused. Bit 29 is used internally.
 224    */
 225
 226   GDK_SUPER_MASK    = 1 << 26,
 227   GDK_HYPER_MASK    = 1 << 27,
 228   GDK_META_MASK     = 1 << 28,
 229
 230   GDK_RELEASE_MASK  = 1 << 30,
 231
 232   GDK_MODIFIER_MASK = 0x5c001fff
 233 } GdkModifierType;
 234
 235 typedef enum
 236 {
 237   GDK_OK          = 0,
 238   GDK_ERROR       = -1,
 239   GDK_ERROR_PARAM = -2,
 240   GDK_ERROR_FILE  = -3,
 241   GDK_ERROR_MEM   = -4
 242 } GdkStatus;
 243
 244 /**
 245  * GdkGrabStatus:
 246  * @GDK_GRAB_SUCCESS: the resource was successfully grabbed.
 247  * @GDK_GRAB_ALREADY_GRABBED: the resource is actively grabbed by another client.
 248  * @GDK_GRAB_INVALID_TIME: the resource was grabbed more recently than the
 249  *  specified time.
 250  * @GDK_GRAB_NOT_VIEWABLE: the grab window or the @confine_to window are not
 251  *  viewable.
 252  * @GDK_GRAB_FROZEN: the resource is frozen by an active grab of another client.
 253  *
 254  * Returned by gdk_pointer_grab() and gdk_keyboard_grab() to indicate
 255  * success or the reason for the failure of the grab attempt.
 256  */
 257 typedef enum
 258 {
 259   GDK_GRAB_SUCCESS         = 0,
 260   GDK_GRAB_ALREADY_GRABBED = 1,
 261   GDK_GRAB_INVALID_TIME    = 2,
 262   GDK_GRAB_NOT_VIEWABLE    = 3,
 263   GDK_GRAB_FROZEN          = 4
 264 } GdkGrabStatus;
 265
 266 /**
 267  * GdkGrabOwnership:
 268  * @GDK_OWNERSHIP_NONE: All other devices' events are allowed.
 269  * @GDK_OWNERSHIP_WINDOW: Other devices' events are blocked for the grab window.
 270  * @GDK_OWNERSHIP_APPLICATION: Other devices' events are blocked for the whole application.
 271  *
 272  * Defines how device grabs interact with other devices.
 273  */
 274 typedef enum
 275 {
 276   GDK_OWNERSHIP_NONE,
 277   GDK_OWNERSHIP_WINDOW,
 278   GDK_OWNERSHIP_APPLICATION
 279 } GdkGrabOwnership;
 280
 281 /**
 282  * GdkEventMask:
 283  * @GDK_EXPOSURE_MASK: receive expose events
 284  * @GDK_POINTER_MOTION_MASK: receive all pointer motion events
 285  * @GDK_POINTER_MOTION_HINT_MASK: see the explanation above
 286  * @GDK_BUTTON_MOTION_MASK: receive pointer motion events while any button is pressed
 287  * @GDK_BUTTON1_MOTION_MASK: receive pointer motion events while 1 button is pressed
 288  * @GDK_BUTTON2_MOTION_MASK: receive pointer motion events while 2 button is pressed
 289  * @GDK_BUTTON3_MOTION_MASK: receive pointer motion events while 3 button is pressed
 290  * @GDK_BUTTON_PRESS_MASK: receive button press events
 291  * @GDK_BUTTON_RELEASE_MASK: receive button release events
 292  * @GDK_KEY_PRESS_MASK: receive key press events
 293  * @GDK_KEY_RELEASE_MASK: receive key release events
 294  * @GDK_ENTER_NOTIFY_MASK: receive window enter events
 295  * @GDK_LEAVE_NOTIFY_MASK: receive window leave events
 296  * @GDK_FOCUS_CHANGE_MASK: receive focus change events
 297  * @GDK_STRUCTURE_MASK: receive events about window configuration change
 298  * @GDK_PROPERTY_CHANGE_MASK: receive property change events
 299  * @GDK_VISIBILITY_NOTIFY_MASK: receive visibility change events
 300  * @GDK_PROXIMITY_IN_MASK: receive proximity in events
 301  * @GDK_PROXIMITY_OUT_MASK: receive proximity out events
 302  * @GDK_SUBSTRUCTURE_MASK: receive events about window configuration changes of
 303  *   child windows
 304  * @GDK_SCROLL_MASK: receive scroll events
 305  * @GDK_ALL_EVENTS_MASK: the combination of all the above event masks.
 306  *
 307  * A set of bit-flags to indicate which events a window is to receive.
 308  * Most of these masks map onto one or more of the #GdkEventType event types
 309  * above.
 310  *
 311  * %GDK_POINTER_MOTION_HINT_MASK is a special mask which is used to reduce the
 312  * number of %GDK_MOTION_NOTIFY events received. Normally a %GDK_MOTION_NOTIFY
 313  * event is received each time the mouse moves. However, if the application
 314  * spends a lot of time processing the event (updating the display, for example),
 315  * it can lag behind the position of the mouse. When using
 316  * %GDK_POINTER_MOTION_HINT_MASK, fewer %GDK_MOTION_NOTIFY events will be sent,
 317  * some of which are marked as a hint (the is_hint member is %TRUE).
 318  * To receive more motion events after a motion hint event, the application
 319  * needs to asks for more, by calling gdk_event_request_motions().
 320  */
 321 typedef enum
 322 {
 323   GDK_EXPOSURE_MASK             = 1 << 1,
 324   GDK_POINTER_MOTION_MASK       = 1 << 2,
 325   GDK_POINTER_MOTION_HINT_MASK  = 1 << 3,
 326   GDK_BUTTON_MOTION_MASK        = 1 << 4,
 327   GDK_BUTTON1_MOTION_MASK       = 1 << 5,
 328   GDK_BUTTON2_MOTION_MASK       = 1 << 6,
 329   GDK_BUTTON3_MOTION_MASK       = 1 << 7,
 330   GDK_BUTTON_PRESS_MASK         = 1 << 8,
 331   GDK_BUTTON_RELEASE_MASK       = 1 << 9,
 332   GDK_KEY_PRESS_MASK            = 1 << 10,
 333   GDK_KEY_RELEASE_MASK          = 1 << 11,
 334   GDK_ENTER_NOTIFY_MASK         = 1 << 12,
 335   GDK_LEAVE_NOTIFY_MASK         = 1 << 13,
 336   GDK_FOCUS_CHANGE_MASK         = 1 << 14,
 337   GDK_STRUCTURE_MASK            = 1 << 15,
 338   GDK_PROPERTY_CHANGE_MASK      = 1 << 16,
 339   GDK_VISIBILITY_NOTIFY_MASK    = 1 << 17,
 340   GDK_PROXIMITY_IN_MASK         = 1 << 18,
 341   GDK_PROXIMITY_OUT_MASK        = 1 << 19,
 342   GDK_SUBSTRUCTURE_MASK         = 1 << 20,
 343   GDK_SCROLL_MASK               = 1 << 21,
 344   GDK_ALL_EVENTS_MASK           = 0x3FFFFE
 345 } GdkEventMask;
 346
 347 /**
 348  * GdkPoint:
 349  * @x: the x coordinate of the point.
 350  * @y: the y coordinate of the point.
 351  *
 352  * Defines the x and y coordinates of a point.
 353  */
 354 struct _GdkPoint
 355 {
 356   gint x;
 357   gint y;
 358 };
 359
 360
 361 G_END_DECLS
 362
 363
 364 #endif /* __GDK_TYPES_H__ */