]> Pileus Git - ~andy/gtk/blob - gdk/gdkdisplay.h
Add deprecation annotations for deprecated functions
[~andy/gtk] / 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 GType       gdk_display_get_type (void) G_GNUC_CONST;
45 GdkDisplay *gdk_display_open                (const gchar *display_name);
46
47 const gchar * gdk_display_get_name         (GdkDisplay *display);
48
49 gint        gdk_display_get_n_screens      (GdkDisplay  *display);
50 GdkScreen * gdk_display_get_screen         (GdkDisplay  *display,
51                                             gint         screen_num);
52 GdkScreen * gdk_display_get_default_screen (GdkDisplay  *display);
53
54 #ifndef GDK_MULTIDEVICE_SAFE
55 #ifndef GDK_DISABLE_DEPRECATED
56 GDK_DEPRECATED_FOR(gdk_device_ungrab)
57 void        gdk_display_pointer_ungrab     (GdkDisplay  *display,
58                                             guint32      time_);
59 GDK_DEPRECATED_FOR(gdk_device_ungrab)
60 void        gdk_display_keyboard_ungrab    (GdkDisplay  *display,
61                                             guint32      time_);
62 GDK_DEPRECATED_FOR(gdk_display_device_is_grabbed)
63 gboolean    gdk_display_pointer_is_grabbed (GdkDisplay  *display);
64 #endif /* GDK_DISABLE_DEPRECATED */
65 #endif /* GDK_MULTIDEVICE_SAFE */
66
67 gboolean    gdk_display_device_is_grabbed  (GdkDisplay  *display,
68                                             GdkDevice   *device);
69 void        gdk_display_beep               (GdkDisplay  *display);
70 void        gdk_display_sync               (GdkDisplay  *display);
71 void        gdk_display_flush              (GdkDisplay  *display);
72
73 void        gdk_display_close                  (GdkDisplay  *display);
74 gboolean    gdk_display_is_closed          (GdkDisplay  *display);
75
76 #ifndef GDK_DISABLE_DEPRECATED
77 GDK_DEPRECATED_FOR(gdk_device_manager_list_devices)
78 GList *     gdk_display_list_devices       (GdkDisplay  *display);
79 #endif /* GDK_DISABLE_DEPRECATED */
80
81 GdkEvent* gdk_display_get_event  (GdkDisplay     *display);
82 GdkEvent* gdk_display_peek_event (GdkDisplay     *display);
83 void      gdk_display_put_event  (GdkDisplay     *display,
84                                   const GdkEvent *event);
85 gboolean  gdk_display_has_pending (GdkDisplay  *display);
86
87 void gdk_display_set_double_click_time     (GdkDisplay   *display,
88                                             guint         msec);
89 void gdk_display_set_double_click_distance (GdkDisplay   *display,
90                                             guint         distance);
91
92 GdkDisplay *gdk_display_get_default (void);
93
94 #ifndef GDK_MULTIDEVICE_SAFE
95 #ifndef GDK_DISABLE_DEPRECATED
96 GDK_DEPRECATED_FOR(gdk_device_get_position)
97 void             gdk_display_get_pointer           (GdkDisplay             *display,
98                                                     GdkScreen             **screen,
99                                                     gint                   *x,
100                                                     gint                   *y,
101                                                     GdkModifierType        *mask);
102 GDK_DEPRECATED_FOR(gdk_device_get_window_at_position)
103 GdkWindow *      gdk_display_get_window_at_pointer (GdkDisplay             *display,
104                                                     gint                   *win_x,
105                                                     gint                   *win_y);
106 GDK_DEPRECATED_FOR(gdk_device_warp)
107 void             gdk_display_warp_pointer          (GdkDisplay             *display,
108                                                     GdkScreen              *screen,
109                                                     gint                   x,
110                                                     gint                   y);
111 #endif /* GDK_DISABLE_DEPRECATED */
112 #endif /* GDK_MULTIDEVICE_SAFE */
113
114 GdkDisplay *gdk_display_open_default_libgtk_only (void);
115
116 gboolean gdk_display_supports_cursor_alpha     (GdkDisplay    *display);
117 gboolean gdk_display_supports_cursor_color     (GdkDisplay    *display);
118 guint    gdk_display_get_default_cursor_size   (GdkDisplay    *display);
119 void     gdk_display_get_maximal_cursor_size   (GdkDisplay    *display,
120                                                 guint         *width,
121                                                 guint         *height);
122
123 GdkWindow *gdk_display_get_default_group       (GdkDisplay *display); 
124
125 gboolean gdk_display_supports_selection_notification (GdkDisplay *display);
126 gboolean gdk_display_request_selection_notification  (GdkDisplay *display,
127                                                       GdkAtom     selection);
128
129 gboolean gdk_display_supports_clipboard_persistence (GdkDisplay    *display);
130 void     gdk_display_store_clipboard                (GdkDisplay    *display,
131                                                      GdkWindow     *clipboard_window,
132                                                      guint32        time_,
133                                                      const GdkAtom *targets,
134                                                      gint           n_targets);
135
136 gboolean gdk_display_supports_shapes           (GdkDisplay    *display);
137 gboolean gdk_display_supports_input_shapes     (GdkDisplay    *display);
138 gboolean gdk_display_supports_composite        (GdkDisplay    *display);
139 void     gdk_display_notify_startup_complete   (GdkDisplay    *display,
140                                                 const gchar   *startup_id);
141
142 GdkDeviceManager * gdk_display_get_device_manager (GdkDisplay *display);
143
144 GdkAppLaunchContext *gdk_display_get_app_launch_context (GdkDisplay *display);
145
146 G_END_DECLS
147
148 #endif  /* __GDK_DISPLAY_H__ */