Pileus Git - ~andy/gtk/blob - gdk/gdkdisplay.h

   1 /*
   2  * gdkdisplay.h
   3  *
   4  * Copyright 2001 Sun Microsystems Inc.
   5  *
   6  * Erwann Chenede <erwann.chenede@sun.com>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
  25 #error "Only <gdk/gdk.h> can be included directly."
  26 #endif
  27
  28 #ifndef __GDK_DISPLAY_H__
  29 #define __GDK_DISPLAY_H__
  30
  31 #include <gdk/gdktypes.h>
  32 #include <gdk/gdkevents.h>
  33 #include <gdk/gdkdevicemanager.h>
  34
  35 G_BEGIN_DECLS
  36
  37 #define GDK_TYPE_DISPLAY              (gdk_display_get_type ())
  38 #define GDK_DISPLAY(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_DISPLAY, GdkDisplay))
  39 #define GDK_IS_DISPLAY(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_DISPLAY))
  40 #ifndef GDK_DISABLE_DEPRECATED
  41 #define GDK_DISPLAY_OBJECT(object)    GDK_DISPLAY(object)
  42 #endif
  43
  44 typedef struct _GdkDisplayDeviceHooks GdkDisplayDeviceHooks;
  45
  46 /**
  47  * GdkDisplayDeviceHooks:
  48  * @get_device_state: Obtains the current position and modifier state for
  49  * @device. The position is given in coordinates relative to the window
  50  * containing the pointer, which is returned in @window.
  51  * @window_get_device_position: Obtains the window underneath the device
  52  * position. Current device position and modifier state are returned in
  53  * @x, @y and @mask. The position is given in coordinates relative to
  54  * @window.
  55  * @window_at_device_position: Obtains the window underneath the device
  56  * position, returning the location of that window in @win_x, @win_y.
  57  * Returns %NULL if the window under the mouse pointer is not known to
  58  * GDK (for example, belongs to another application).
  59  *
  60  * A table of pointers to functions for getting quantities related to
  61  * the current device position. Each #GdkDisplay has a table of this type,
  62  * which can be set using gdk_display_set_device_hooks().
  63  */
  64 struct _GdkDisplayDeviceHooks
  65 {
  66   void (* get_device_state)                  (GdkDisplay       *display,
  67                                               GdkDevice        *device,
  68                                               GdkScreen       **screen,
  69                                               gint             *x,
  70                                               gint             *y,
  71                                               GdkModifierType  *mask);
  72   GdkWindow * (* window_get_device_position) (GdkDisplay      *display,
  73                                               GdkDevice       *device,
  74                                               GdkWindow       *window,
  75                                               gint            *x,
  76                                               gint            *y,
  77                                               GdkModifierType *mask);
  78   GdkWindow * (* window_at_device_position)  (GdkDisplay *display,
  79                                               GdkDevice  *device,
  80                                               gint       *win_x,
  81                                               gint       *win_y);
  82 };
  83
  84 GType       gdk_display_get_type (void) G_GNUC_CONST;
  85 GdkDisplay *gdk_display_open                (const gchar *display_name);
  86
  87 G_CONST_RETURN gchar * gdk_display_get_name (GdkDisplay *display);
  88
  89 gint        gdk_display_get_n_screens      (GdkDisplay  *display);
  90 GdkScreen * gdk_display_get_screen         (GdkDisplay  *display,
  91                                             gint         screen_num);
  92 GdkScreen * gdk_display_get_default_screen (GdkDisplay  *display);
  93
  94 #ifndef GDK_MULTIDEVICE_SAFE
  95 #ifndef GDK_DISABLE_DEPRECATED
  96 void        gdk_display_pointer_ungrab     (GdkDisplay  *display,
  97                                             guint32      time_);
  98 void        gdk_display_keyboard_ungrab    (GdkDisplay  *display,
  99                                             guint32      time_);
 100 gboolean    gdk_display_pointer_is_grabbed (GdkDisplay  *display);
 101 #endif /* GDK_DISABLE_DEPRECATED */
 102 #endif /* GDK_MULTIDEVICE_SAFE */
 103
 104 gboolean    gdk_display_device_is_grabbed  (GdkDisplay  *display,
 105                                             GdkDevice   *device);
 106 void        gdk_display_beep               (GdkDisplay  *display);
 107 void        gdk_display_sync               (GdkDisplay  *display);
 108 void        gdk_display_flush              (GdkDisplay  *display);
 109
 110 void        gdk_display_close                  (GdkDisplay  *display);
 111 gboolean    gdk_display_is_closed          (GdkDisplay  *display);
 112
 113 #ifndef GDK_DISABLE_DEPRECATED
 114 GList *     gdk_display_list_devices       (GdkDisplay  *display);
 115 #endif /* GDK_DISABLE_DEPRECATED */
 116
 117 GdkEvent* gdk_display_get_event  (GdkDisplay     *display);
 118 GdkEvent* gdk_display_peek_event (GdkDisplay     *display);
 119 void      gdk_display_put_event  (GdkDisplay     *display,
 120                                   const GdkEvent *event);
 121 gboolean  gdk_display_has_pending (GdkDisplay  *display);
 122
 123 void gdk_display_add_client_message_filter (GdkDisplay   *display,
 124                                             GdkAtom       message_type,
 125                                             GdkFilterFunc func,
 126                                             gpointer      data);
 127
 128 void gdk_display_set_double_click_time     (GdkDisplay   *display,
 129                                             guint         msec);
 130 void gdk_display_set_double_click_distance (GdkDisplay   *display,
 131                                             guint         distance);
 132
 133 GdkDisplay *gdk_display_get_default (void);
 134
 135 #ifndef GDK_MULTIDEVICE_SAFE
 136 #ifndef GDK_DISABLE_DEPRECATED
 137 void             gdk_display_get_pointer           (GdkDisplay             *display,
 138                                                     GdkScreen             **screen,
 139                                                     gint                   *x,
 140                                                     gint                   *y,
 141                                                     GdkModifierType        *mask);
 142 GdkWindow *      gdk_display_get_window_at_pointer (GdkDisplay             *display,
 143                                                     gint                   *win_x,
 144                                                     gint                   *win_y);
 145 void             gdk_display_warp_pointer          (GdkDisplay             *display,
 146                                                     GdkScreen              *screen,
 147                                                     gint                   x,
 148                                                     gint                   y);
 149 #endif /* GDK_DISABLE_DEPRECATED */
 150 #endif /* GDK_MULTIDEVICE_SAFE */
 151
 152 GdkDisplayDeviceHooks *gdk_display_set_device_hooks (GdkDisplay                  *display,
 153                                                      const GdkDisplayDeviceHooks *new_hooks);
 154
 155 GdkDisplay *gdk_display_open_default_libgtk_only (void);
 156
 157 gboolean gdk_display_supports_cursor_alpha     (GdkDisplay    *display);
 158 gboolean gdk_display_supports_cursor_color     (GdkDisplay    *display);
 159 guint    gdk_display_get_default_cursor_size   (GdkDisplay    *display);
 160 void     gdk_display_get_maximal_cursor_size   (GdkDisplay    *display,
 161                                                 guint         *width,
 162                                                 guint         *height);
 163
 164 GdkWindow *gdk_display_get_default_group       (GdkDisplay *display);
 165
 166 gboolean gdk_display_supports_selection_notification (GdkDisplay *display);
 167 gboolean gdk_display_request_selection_notification  (GdkDisplay *display,
 168                                                       GdkAtom     selection);
 169
 170 gboolean gdk_display_supports_clipboard_persistence (GdkDisplay    *display);
 171 void     gdk_display_store_clipboard                (GdkDisplay    *display,
 172                                                      GdkWindow     *clipboard_window,
 173                                                      guint32        time_,
 174                                                      const GdkAtom *targets,
 175                                                      gint           n_targets);
 176
 177 gboolean gdk_display_supports_shapes           (GdkDisplay    *display);
 178 gboolean gdk_display_supports_input_shapes     (GdkDisplay    *display);
 179 gboolean gdk_display_supports_composite        (GdkDisplay    *display);
 180 void     gdk_display_notify_startup_complete   (GdkDisplay    *display,
 181                                                 const gchar   *startup_id);
 182
 183 GdkDeviceManager * gdk_display_get_device_manager (GdkDisplay *display);
 184
 185 GdkAppLaunchContext *gdk_display_get_app_launch_context (GdkDisplay *display);
 186
 187 G_END_DECLS
 188
 189 #endif  /* __GDK_DISPLAY_H__ */