1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 2000 Red Hat, Inc.
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.
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.
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.
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/.
29 #include "gdkconfig.h"
30 #include "gdkdisplaymanagerprivate.h"
31 #include "gdkinternals.h"
32 #include "gdkkeysprivate.h"
33 #include "gdkmarshalers.h"
36 #ifdef GDK_WINDOWING_X11
40 #ifdef GDK_WINDOWING_QUARTZ
41 /* We immediately include gdkquartzdisplaymanager.h here instead of
42 * gdkquartz.h so that we do not have to enable -xobjective-c for the
43 * "generic" GDK source code.
45 #include "quartz/gdkquartzdisplaymanager.h"
48 #ifdef GDK_WINDOWING_BROADWAY
49 #include "broadway/gdkbroadwaydisplaymanager.h"
52 #ifdef GDK_WINDOWING_WIN32
53 #include "win32/gdkwin32.h"
56 #ifdef GDK_WINDOWING_WAYLAND
57 #include "wayland/gdkwayland.h"
61 * SECTION:gdkdisplaymanager
62 * @Short_description: Maintains a list of all open GdkDisplays
63 * @Title: GdkDisplayManager
65 * The purpose of the #GdkDisplayManager singleton object is to offer
66 * notification when displays appear or disappear or the default display
69 * You can use gdk_display_manager_get() to obtain the GdkDisplayManager
70 * singleton, but that should be rarely necessary. Typically, initializing
71 * GTK+ opens a display that you can work with without ever accessing the
74 * The GDK library can be built with support for multiple backends.
75 * The GdkDisplayManager object determines which backend is used
78 * When writing backend-specific code that is supposed to work with
79 * multiple GDK backends, you have to consider both compile time and
80 * runtime. At compile time, use the #GDK_WINDOWING_X11, #GDK_WINDOWING_WIN32
81 * macros, etc. to find out which backends are present in the GDK library
82 * you are building your application against. At runtime, use type-check
83 * macros like GDK_IS_X11_DISPLAY() to find out which backend is in use:
85 * <example id="backend-specific">
86 * <title>Backend-specific code</title>
88 * #ifdef GDK_WINDOWING_X11
89 * if (GDK_IS_X11_DISPLAY (display))
91 * /* make X11-specific calls here */
95 * #ifdef GDK_WINDOWING_QUARTZ
96 * if (GDK_IS_QUARTZ_DISPLAY (display))
98 * /* make Quartz-specific calls here */
102 * g_error ("Unsupported GDK backend");
118 static void gdk_display_manager_class_init (GdkDisplayManagerClass *klass);
119 static void gdk_display_manager_set_property (GObject *object,
123 static void gdk_display_manager_get_property (GObject *object,
128 static guint signals[LAST_SIGNAL] = { 0 };
130 G_DEFINE_TYPE (GdkDisplayManager, gdk_display_manager, G_TYPE_OBJECT)
133 gdk_display_manager_class_init (GdkDisplayManagerClass *klass)
135 GObjectClass *object_class = G_OBJECT_CLASS (klass);
137 object_class->set_property = gdk_display_manager_set_property;
138 object_class->get_property = gdk_display_manager_get_property;
140 klass->keyval_convert_case = _gdk_display_manager_real_keyval_convert_case;
143 * GdkDisplayManager::display-opened:
144 * @manager: the object on which the signal is emitted
145 * @display: the opened display
147 * The ::display-opened signal is emitted when a display is opened.
151 signals[DISPLAY_OPENED] =
152 g_signal_new (g_intern_static_string ("display-opened"),
153 G_OBJECT_CLASS_TYPE (object_class),
155 G_STRUCT_OFFSET (GdkDisplayManagerClass, display_opened),
157 _gdk_marshal_VOID__OBJECT,
162 g_object_class_install_property (object_class,
163 PROP_DEFAULT_DISPLAY,
164 g_param_spec_object ("default-display",
165 P_("Default Display"),
166 P_("The default display for GDK"),
168 G_PARAM_READWRITE|G_PARAM_STATIC_NAME|
169 G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
173 gdk_display_manager_init (GdkDisplayManager *manager)
178 gdk_display_manager_set_property (GObject *object,
185 case PROP_DEFAULT_DISPLAY:
186 gdk_display_manager_set_default_display (GDK_DISPLAY_MANAGER (object),
187 g_value_get_object (value));
190 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
196 gdk_display_manager_get_property (GObject *object,
203 case PROP_DEFAULT_DISPLAY:
204 g_value_set_object (value,
205 gdk_display_manager_get_default_display (GDK_DISPLAY_MANAGER (object)));
208 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
214 * gdk_display_manager_get:
216 * Gets the singleton #GdkDisplayManager object.
218 * When called for the first time, this function consults the
219 * <envar>GDK_BACKEND</envar> environment variable to find out which
220 * of the supported GDK backends to use (in case GDK has been compiled
221 * with multiple backends).
223 * Returns: (transfer none): The global #GdkDisplayManager singleton;
224 * gdk_parse_args(), gdk_init(), or gdk_init_check() must have
230 gdk_display_manager_get (void)
232 static GdkDisplayManager *manager = NULL;
236 const gchar *backend;
238 backend = g_getenv ("GDK_BACKEND");
239 #ifdef GDK_WINDOWING_QUARTZ
240 if (backend == NULL || strcmp (backend, "quartz") == 0)
241 manager = g_object_new (gdk_quartz_display_manager_get_type (), NULL);
244 #ifdef GDK_WINDOWING_WIN32
245 if (backend == NULL || strcmp (backend, "win32") == 0)
246 manager = g_object_new (gdk_win32_display_manager_get_type (), NULL);
249 #ifdef GDK_WINDOWING_WAYLAND
250 if (backend == NULL || strcmp (backend, "wayland") == 0)
251 manager = g_object_new (gdk_wayland_display_manager_get_type (), NULL);
254 #ifdef GDK_WINDOWING_X11
255 if (backend == NULL || strcmp (backend, "x11") == 0)
256 manager = g_object_new (gdk_x11_display_manager_get_type (), NULL);
259 #ifdef GDK_WINDOWING_BROADWAY
260 if (backend == NULL || strcmp (backend, "broadway") == 0)
261 manager = g_object_new (gdk_broadway_display_manager_get_type (), NULL);
265 g_error ("Unsupported GDK backend: %s", backend);
267 g_error ("No GDK backend found");
274 * gdk_display_manager_get_default_display:
275 * @manager: a #GdkDisplayManager
277 * Gets the default #GdkDisplay.
279 * Returns: (transfer none): a #GdkDisplay, or %NULL
280 * if there is no default display.
285 gdk_display_manager_get_default_display (GdkDisplayManager *manager)
287 return GDK_DISPLAY_MANAGER_GET_CLASS (manager)->get_default_display (manager);
291 * gdk_display_get_default:
293 * Gets the default #GdkDisplay. This is a convenience
295 * <literal>gdk_display_manager_get_default_display (gdk_display_manager_get ())</literal>.
297 * Returns: (transfer none): a #GdkDisplay, or %NULL if there is no default
303 gdk_display_get_default (void)
305 return gdk_display_manager_get_default_display (gdk_display_manager_get ());
309 * gdk_screen_get_default:
311 * Gets the default screen for the default display. (See
312 * gdk_display_get_default ()).
314 * Returns: (transfer none): a #GdkScreen, or %NULL if there is no default display.
319 gdk_screen_get_default (void)
321 GdkDisplay *default_display;
323 default_display = gdk_display_get_default ();
326 return gdk_display_get_default_screen (default_display);
332 * gdk_display_manager_set_default_display:
333 * @manager: a #GdkDisplayManager
334 * @display: a #GdkDisplay
336 * Sets @display as the default display.
341 gdk_display_manager_set_default_display (GdkDisplayManager *manager,
344 GDK_DISPLAY_MANAGER_GET_CLASS (manager)->set_default_display (manager, display);
346 g_object_notify (G_OBJECT (manager), "default-display");
350 * gdk_display_manager_list_displays:
351 * @manager: a #GdkDisplayManager
353 * List all currently open displays.
355 * Return value: (transfer container) (element-type GdkDisplay): a newly
356 * allocated #GSList of #GdkDisplay objects. Free with g_slist_free()
357 * when you are done with it.
362 gdk_display_manager_list_displays (GdkDisplayManager *manager)
364 return GDK_DISPLAY_MANAGER_GET_CLASS (manager)->list_displays (manager);
368 * gdk_display_manager_open_display:
369 * @manager: a #GdkDisplayManager
370 * @name: the name of the display to open
374 * Return value: (transfer none): a #GdkDisplay, or %NULL
375 * if the display could not be opened
380 gdk_display_manager_open_display (GdkDisplayManager *manager,
383 return GDK_DISPLAY_MANAGER_GET_CLASS (manager)->open_display (manager, name);
388 * @atom_name: a string.
389 * @only_if_exists: if %TRUE, GDK is allowed to not create a new atom, but
390 * just return %GDK_NONE if the requested atom doesn't already
391 * exists. Currently, the flag is ignored, since checking the
392 * existance of an atom is as expensive as creating it.
394 * Finds or creates an atom corresponding to a given string.
396 * Returns: (transfer none): the atom corresponding to @atom_name.
399 gdk_atom_intern (const gchar *atom_name,
400 gboolean only_if_exists)
402 GdkDisplayManager *manager = gdk_display_manager_get ();
404 return GDK_DISPLAY_MANAGER_GET_CLASS (manager)->atom_intern (manager, atom_name, TRUE);
408 * gdk_atom_intern_static_string:
409 * @atom_name: a static string
411 * Finds or creates an atom corresponding to a given string.
413 * Note that this function is identical to gdk_atom_intern() except
414 * that if a new #GdkAtom is created the string itself is used rather
415 * than a copy. This saves memory, but can only be used if the string
416 * will <emphasis>always</emphasis> exist. It can be used with statically
417 * allocated strings in the main program, but not with statically
418 * allocated memory in dynamically loaded modules, if you expect to
419 * ever unload the module again (e.g. do not use this function in
420 * GTK+ theme engines).
422 * Returns: (transfer none): the atom corresponding to @atom_name
427 gdk_atom_intern_static_string (const gchar *atom_name)
429 GdkDisplayManager *manager = gdk_display_manager_get ();
431 return GDK_DISPLAY_MANAGER_GET_CLASS (manager)->atom_intern (manager, atom_name, FALSE);
438 * Determines the string corresponding to an atom.
440 * Returns: a newly-allocated string containing the string
441 * corresponding to @atom. When you are done with the
442 * return value, you should free it using g_free().
445 gdk_atom_name (GdkAtom atom)
447 GdkDisplayManager *manager = gdk_display_manager_get ();
449 return GDK_DISPLAY_MANAGER_GET_CLASS (manager)->get_atom_name (manager, atom);