2 * Copyright © 2010 Codethink Limited
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 licence, 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, see <http://www.gnu.org/licenses/>.
17 * Author: Ryan Lortie <desrt@desrt.ca>
22 #include "gtkapplication.h"
30 #include "gtkapplicationprivate.h"
31 #include "gtkclipboard.h"
32 #include "gtkmarshalers.h"
34 #include "gtkrecentmanager.h"
35 #include "gtkaccelmapprivate.h"
36 #include "gactionmuxer.h"
39 #ifdef GDK_WINDOWING_QUARTZ
40 #include "gtkquartz-menu.h"
41 #import <Cocoa/Cocoa.h>
42 #include <Carbon/Carbon.h>
43 #include "gtkmessagedialog.h"
47 #ifdef GDK_WINDOWING_X11
48 #include <gdk/x11/gdkx.h>
52 * SECTION:gtkapplication
53 * @title: GtkApplication
54 * @short_description: Application class
56 * #GtkApplication is a class that handles many important aspects
57 * of a GTK+ application in a convenient fashion, without enforcing
58 * a one-size-fits-all application model.
60 * Currently, GtkApplication handles GTK+ initialization, application
61 * uniqueness, session management, provides some basic scriptability and
62 * desktop shell integration by exporting actions and menus and manages a
63 * list of toplevel windows whose life-cycle is automatically tied to the
64 * life-cycle of your application.
66 * While GtkApplication works fine with plain #GtkWindows, it is recommended
67 * to use it together with #GtkApplicationWindow.
69 * When GDK threads are enabled, GtkApplication will acquire the GDK
70 * lock when invoking actions that arrive from other processes. The GDK
71 * lock is not touched for local action invocations. In order to have
72 * actions invoked in a predictable context it is therefore recommended
73 * that the GDK lock be held while invoking actions locally with
74 * g_action_group_activate_action(). The same applies to actions
75 * associated with #GtkApplicationWindow and to the 'activate' and
76 * 'open' #GApplication methods.
78 * To set an application menu for a GtkApplication, use
79 * gtk_application_set_app_menu(). The #GMenuModel that this function
80 * expects is usually constructed using #GtkBuilder, as seen in the
81 * following example. To specify a menubar that will be shown by
82 * #GApplicationWindows, use gtk_application_set_menubar(). Use the base
83 * #GActionMap interface to add actions, to respond to the user
84 * selecting these menu items.
86 * GTK+ displays these menus as expected, depending on the platform
87 * the application is running on.
89 * <figure label="Menu integration in OS X">
90 * <graphic fileref="bloatpad-osx.png" format="PNG"/>
93 * <figure label="Menu integration in GNOME">
94 * <graphic fileref="bloatpad-gnome.png" format="PNG"/>
97 * <figure label="Menu integration in Xfce">
98 * <graphic fileref="bloatpad-xfce.png" format="PNG"/>
101 * <example id="gtkapplication"><title>A simple application</title>
103 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../examples/bloatpad.c">
104 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
109 * GtkApplication optionally registers with a session manager
110 * of the users session (if you set the #GtkApplication:register-session
111 * property) and offers various functionality related to the session
114 * An application can block various ways to end the session with
115 * the gtk_application_inhibit() function. Typical use cases for
116 * this kind of inhibiting are long-running, uninterruptible operations,
117 * such as burning a CD or performing a disk backup. The session
118 * manager may not honor the inhibitor, but it can be expected to
119 * inform the user about the negative consequences of ending the
120 * session while inhibitors are present.
129 static guint gtk_application_signals[LAST_SIGNAL];
133 PROP_REGISTER_SESSION,
138 G_DEFINE_TYPE (GtkApplication, gtk_application, G_TYPE_APPLICATION)
140 struct _GtkApplicationPrivate
144 gboolean register_session;
146 GMenuModel *app_menu;
149 #ifdef GDK_WINDOWING_X11
150 GDBusConnection *session_bus;
151 const gchar *application_id;
152 const gchar *object_path;
154 gchar *app_menu_path;
162 GDBusProxy *sm_proxy;
163 GDBusProxy *client_proxy;
168 #ifdef GDK_WINDOWING_QUARTZ
178 #ifdef GDK_WINDOWING_X11
180 gtk_application_x11_publish_menu (GtkApplication *application,
188 if (application->priv->session_bus == NULL)
191 /* unexport any existing menu */
194 g_dbus_connection_unexport_menu_model (application->priv->session_bus, *id);
200 /* export the new menu, if there is one */
203 /* try getting the preferred name */
204 *path = g_strconcat (application->priv->object_path, "/menus/", type, NULL);
205 *id = g_dbus_connection_export_menu_model (application->priv->session_bus, *path, model, NULL);
207 /* keep trying until we get a working name... */
208 for (i = 0; *id == 0; i++)
211 *path = g_strdup_printf ("%s/menus/%s%d", application->priv->object_path, type, i);
212 *id = g_dbus_connection_export_menu_model (application->priv->session_bus, *path, model, NULL);
218 gtk_application_set_app_menu_x11 (GtkApplication *application,
219 GMenuModel *app_menu)
221 gtk_application_x11_publish_menu (application, "appmenu", app_menu,
222 &application->priv->app_menu_id,
223 &application->priv->app_menu_path);
227 gtk_application_set_menubar_x11 (GtkApplication *application,
230 gtk_application_x11_publish_menu (application, "menubar", menubar,
231 &application->priv->menubar_id,
232 &application->priv->menubar_path);
236 gtk_application_window_added_x11 (GtkApplication *application,
239 if (application->priv->session_bus == NULL)
242 if (GTK_IS_APPLICATION_WINDOW (window))
244 GtkApplicationWindow *app_window = GTK_APPLICATION_WINDOW (window);
247 /* GtkApplicationWindow associates with us when it is first created,
248 * so surely it's not realized yet...
250 g_assert (!gtk_widget_get_realized (GTK_WIDGET (window)));
257 window_id = application->priv->next_id++;
258 window_path = g_strdup_printf ("%s/window/%u", application->priv->object_path, window_id);
259 success = gtk_application_window_publish (app_window, application->priv->session_bus, window_path, window_id);
260 g_free (window_path);
267 gtk_application_window_removed_x11 (GtkApplication *application,
270 if (application->priv->session_bus == NULL)
273 if (GTK_IS_APPLICATION_WINDOW (window))
274 gtk_application_window_unpublish (GTK_APPLICATION_WINDOW (window));
277 static void gtk_application_startup_session_dbus (GtkApplication *app);
280 gtk_application_startup_x11 (GtkApplication *application)
282 application->priv->session_bus = g_application_get_dbus_connection (G_APPLICATION (application));
283 application->priv->object_path = g_application_get_dbus_object_path (G_APPLICATION (application));
285 gtk_application_startup_session_dbus (GTK_APPLICATION (application));
289 gtk_application_shutdown_x11 (GtkApplication *application)
291 application->priv->session_bus = NULL;
292 application->priv->object_path = NULL;
294 g_clear_object (&application->priv->sm_proxy);
295 g_clear_object (&application->priv->client_proxy);
296 g_free (application->priv->app_id);
297 g_free (application->priv->client_path);
301 gtk_application_get_app_menu_object_path (GtkApplication *application)
303 return application->priv->app_menu_path;
307 gtk_application_get_menubar_object_path (GtkApplication *application)
309 return application->priv->menubar_path;
314 #ifdef GDK_WINDOWING_QUARTZ
318 GtkApplicationInhibitFlags flags;
321 } GtkApplicationQuartzInhibitor;
324 gtk_application_quartz_inhibitor_free (GtkApplicationQuartzInhibitor *inhibitor)
326 g_free (inhibitor->reason);
327 g_clear_object (&inhibitor->window);
328 g_slice_free (GtkApplicationQuartzInhibitor, inhibitor);
332 gtk_application_menu_changed_quartz (GObject *object,
336 GtkApplication *application = GTK_APPLICATION (object);
339 combined = g_menu_new ();
340 g_menu_append_submenu (combined, "Application", gtk_application_get_app_menu (application));
341 g_menu_append_section (combined, NULL, gtk_application_get_menubar (application));
343 gtk_quartz_set_main_menu (G_MENU_MODEL (combined), G_ACTION_OBSERVABLE (application->priv->muxer));
346 static void gtk_application_startup_session_quartz (GtkApplication *app);
349 gtk_application_startup_quartz (GtkApplication *application)
351 [NSApp finishLaunching];
353 application->priv->muxer = g_action_muxer_new ();
354 g_action_muxer_insert (application->priv->muxer, "app", G_ACTION_GROUP (application));
356 g_signal_connect (application, "notify::app-menu", G_CALLBACK (gtk_application_menu_changed_quartz), NULL);
357 g_signal_connect (application, "notify::menubar", G_CALLBACK (gtk_application_menu_changed_quartz), NULL);
358 gtk_application_menu_changed_quartz (G_OBJECT (application), NULL, NULL);
360 gtk_application_startup_session_quartz (application);
364 gtk_application_shutdown_quartz (GtkApplication *application)
366 g_signal_handlers_disconnect_by_func (application, gtk_application_menu_changed_quartz, NULL);
368 g_object_unref (application->priv->muxer);
369 application->priv->muxer = NULL;
371 g_slist_free_full (application->priv->inhibitors,
372 (GDestroyNotify) gtk_application_quartz_inhibitor_free);
373 application->priv->inhibitors = NULL;
377 gtk_application_focus_changed (GtkApplication *application,
380 if (G_IS_ACTION_GROUP (window))
381 g_action_muxer_insert (application->priv->muxer, "win", G_ACTION_GROUP (window));
383 g_action_muxer_remove (application->priv->muxer, "win");
388 gtk_application_focus_in_event_cb (GtkWindow *window,
389 GdkEventFocus *event,
390 GtkApplication *application)
392 GtkApplicationPrivate *priv = application->priv;
395 /* Keep the window list sorted by most-recently-focused. */
396 link = g_list_find (priv->windows, window);
397 if (link != NULL && link != priv->windows)
399 priv->windows = g_list_remove_link (priv->windows, link);
400 priv->windows = g_list_concat (link, priv->windows);
403 #ifdef GDK_WINDOWING_QUARTZ
404 gtk_application_focus_changed (application, window);
411 gtk_application_startup (GApplication *application)
413 G_APPLICATION_CLASS (gtk_application_parent_class)
414 ->startup (application);
418 #ifdef GDK_WINDOWING_X11
419 gtk_application_startup_x11 (GTK_APPLICATION (application));
422 #ifdef GDK_WINDOWING_QUARTZ
423 gtk_application_startup_quartz (GTK_APPLICATION (application));
428 gtk_application_shutdown (GApplication *application)
430 #ifdef GDK_WINDOWING_X11
431 gtk_application_shutdown_x11 (GTK_APPLICATION (application));
434 #ifdef GDK_WINDOWING_QUARTZ
435 gtk_application_shutdown_quartz (GTK_APPLICATION (application));
438 /* Try storing all clipboard data we have */
439 _gtk_clipboard_store_all ();
441 /* Synchronize the recent manager singleton */
442 _gtk_recent_manager_sync ();
444 G_APPLICATION_CLASS (gtk_application_parent_class)
445 ->shutdown (application);
449 gtk_application_add_platform_data (GApplication *application,
450 GVariantBuilder *builder)
452 const gchar *startup_id;
454 startup_id = getenv ("DESKTOP_STARTUP_ID");
456 if (startup_id && g_utf8_validate (startup_id, -1, NULL))
457 g_variant_builder_add (builder, "{sv}", "desktop-startup-id",
458 g_variant_new_string (startup_id));
462 gtk_application_before_emit (GApplication *application,
463 GVariant *platform_data)
469 gdk_threads_enter ();
471 g_variant_iter_init (&iter, platform_data);
472 while (g_variant_iter_loop (&iter, "{&sv}", &key, &value))
474 #ifdef GDK_WINDOWING_X11
475 if (strcmp (key, "desktop-startup-id") == 0)
480 display = gdk_display_get_default ();
481 id = g_variant_get_string (value, NULL);
482 if (GDK_IS_X11_DISPLAY (display))
483 gdk_x11_display_set_startup_notification_id (display, id);
490 gtk_application_after_emit (GApplication *application,
491 GVariant *platform_data)
493 gdk_notify_startup_complete ();
495 gdk_threads_leave ();
499 gtk_application_init (GtkApplication *application)
501 application->priv = G_TYPE_INSTANCE_GET_PRIVATE (application,
502 GTK_TYPE_APPLICATION,
503 GtkApplicationPrivate);
505 #ifdef GDK_WINDOWING_X11
506 application->priv->next_id = 1;
511 gtk_application_window_added (GtkApplication *application,
514 GtkApplicationPrivate *priv = application->priv;
516 priv->windows = g_list_prepend (priv->windows, window);
517 gtk_window_set_application (window, application);
518 g_application_hold (G_APPLICATION (application));
520 g_signal_connect (window, "focus-in-event",
521 G_CALLBACK (gtk_application_focus_in_event_cb),
524 #ifdef GDK_WINDOWING_X11
525 gtk_application_window_added_x11 (application, window);
530 gtk_application_window_removed (GtkApplication *application,
533 GtkApplicationPrivate *priv = application->priv;
535 #ifdef GDK_WINDOWING_X11
536 gtk_application_window_removed_x11 (application, window);
539 g_signal_handlers_disconnect_by_func (window,
540 gtk_application_focus_in_event_cb,
543 g_application_release (G_APPLICATION (application));
544 priv->windows = g_list_remove (priv->windows, window);
545 gtk_window_set_application (window, NULL);
549 extract_accel_from_menu_item (GMenuModel *model,
553 GMenuAttributeIter *iter;
556 const gchar *accel = NULL;
557 const gchar *action = NULL;
558 GVariant *target = NULL;
560 iter = g_menu_model_iterate_item_attributes (model, item);
561 while (g_menu_attribute_iter_get_next (iter, &key, &value))
563 if (g_str_equal (key, "action") && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
564 action = g_variant_get_string (value, NULL);
565 else if (g_str_equal (key, "accel") && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
566 accel = g_variant_get_string (value, NULL);
567 else if (g_str_equal (key, "target"))
568 target = g_variant_ref (value);
569 g_variant_unref (value);
571 g_object_unref (iter);
574 gtk_application_add_accelerator (app, accel, action, target);
577 g_variant_unref (target);
581 extract_accels_from_menu (GMenuModel *model,
589 for (i = 0; i < g_menu_model_get_n_items (model); i++)
591 extract_accel_from_menu_item (model, i, app);
593 iter = g_menu_model_iterate_item_links (model, i);
594 while (g_menu_link_iter_get_next (iter, &key, &m))
596 extract_accels_from_menu (m, app);
599 g_object_unref (iter);
604 gtk_application_get_property (GObject *object,
609 GtkApplication *application = GTK_APPLICATION (object);
613 case PROP_REGISTER_SESSION:
614 g_value_set_boolean (value, application->priv->register_session);
618 g_value_set_object (value, gtk_application_get_app_menu (application));
622 g_value_set_object (value, gtk_application_get_menubar (application));
626 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
632 gtk_application_set_property (GObject *object,
637 GtkApplication *application = GTK_APPLICATION (object);
641 case PROP_REGISTER_SESSION:
642 application->priv->register_session = g_value_get_boolean (value);
646 gtk_application_set_app_menu (application, g_value_get_object (value));
650 gtk_application_set_menubar (application, g_value_get_object (value));
654 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
660 gtk_application_finalize (GObject *object)
662 GtkApplication *application = GTK_APPLICATION (object);
664 g_clear_object (&application->priv->app_menu);
665 g_clear_object (&application->priv->menubar);
667 G_OBJECT_CLASS (gtk_application_parent_class)
672 gtk_application_class_init (GtkApplicationClass *class)
674 GObjectClass *object_class = G_OBJECT_CLASS (class);
675 GApplicationClass *application_class = G_APPLICATION_CLASS (class);
677 object_class->get_property = gtk_application_get_property;
678 object_class->set_property = gtk_application_set_property;
679 object_class->finalize = gtk_application_finalize;
681 application_class->add_platform_data = gtk_application_add_platform_data;
682 application_class->before_emit = gtk_application_before_emit;
683 application_class->after_emit = gtk_application_after_emit;
684 application_class->startup = gtk_application_startup;
685 application_class->shutdown = gtk_application_shutdown;
687 class->window_added = gtk_application_window_added;
688 class->window_removed = gtk_application_window_removed;
690 g_type_class_add_private (class, sizeof (GtkApplicationPrivate));
693 * GtkApplication::window-added:
694 * @application: the #GtkApplication which emitted the signal
695 * @window: the newly-added #GtkWindow
697 * Emitted when a #GtkWindow is added to @application through
698 * gtk_application_add_window().
702 gtk_application_signals[WINDOW_ADDED] =
703 g_signal_new ("window-added", GTK_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
704 G_STRUCT_OFFSET (GtkApplicationClass, window_added),
706 g_cclosure_marshal_VOID__OBJECT,
707 G_TYPE_NONE, 1, GTK_TYPE_WINDOW);
710 * GtkApplication::window-removed:
711 * @application: the #GtkApplication which emitted the signal
712 * @window: the #GtkWindow that is being removed
714 * Emitted when a #GtkWindow is removed from @application,
715 * either as a side-effect of being destroyed or explicitly
716 * through gtk_application_remove_window().
720 gtk_application_signals[WINDOW_REMOVED] =
721 g_signal_new ("window-removed", GTK_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
722 G_STRUCT_OFFSET (GtkApplicationClass, window_removed),
724 g_cclosure_marshal_VOID__OBJECT,
725 G_TYPE_NONE, 1, GTK_TYPE_WINDOW);
728 * GtkApplication:register-session:
730 * Set this property to %TRUE to register with the session manager.
734 g_object_class_install_property (object_class, PROP_REGISTER_SESSION,
735 g_param_spec_boolean ("register-session",
736 P_("Register session"),
737 P_("Register with the session manager"),
738 FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
740 g_object_class_install_property (object_class, PROP_APP_MENU,
741 g_param_spec_object ("app-menu",
742 P_("Application menu"),
743 P_("The GMenuModel for the application menu"),
745 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
747 g_object_class_install_property (object_class, PROP_MENUBAR,
748 g_param_spec_object ("menubar",
750 P_("The GMenuModel for the menubar"),
752 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
756 * gtk_application_new:
757 * @application_id: the application id
758 * @flags: the application flags
760 * Creates a new #GtkApplication instance.
762 * This function calls g_type_init() for you. gtk_init() is called
763 * as soon as the application gets registered as the primary instance.
765 * Concretely, gtk_init() is called in the default handler for the
766 * #GApplication:startup signal. Therefore, #GtkApplication subclasses should
767 * chain up in their #GApplication:startup handler before using any GTK+ API.
769 * Note that commandline arguments are not passed to gtk_init().
770 * All GTK+ functionality that is available via commandline arguments
771 * can also be achieved by setting suitable environment variables
772 * such as <envar>G_DEBUG</envar>, so this should not be a big
773 * problem. If you absolutely must support GTK+ commandline arguments,
774 * you can explicitly call gtk_init() before creating the application
777 * The application id must be valid. See g_application_id_is_valid().
779 * Returns: a new #GtkApplication instance
784 gtk_application_new (const gchar *application_id,
785 GApplicationFlags flags)
787 g_return_val_if_fail (g_application_id_is_valid (application_id), NULL);
791 return g_object_new (GTK_TYPE_APPLICATION,
792 "application-id", application_id,
798 * gtk_application_add_window:
799 * @application: a #GtkApplication
800 * @window: a #GtkWindow
802 * Adds a window to @application.
804 * This call is equivalent to setting the #GtkWindow:application
805 * property of @window to @application.
807 * Normally, the connection between the application and the window
808 * will remain until the window is destroyed, but you can explicitly
809 * remove it with gtk_application_remove_window().
811 * GTK+ will keep the application running as long as it has
817 gtk_application_add_window (GtkApplication *application,
820 g_return_if_fail (GTK_IS_APPLICATION (application));
822 if (!g_list_find (application->priv->windows, window))
823 g_signal_emit (application,
824 gtk_application_signals[WINDOW_ADDED], 0, window);
828 * gtk_application_remove_window:
829 * @application: a #GtkApplication
830 * @window: a #GtkWindow
832 * Remove a window from @application.
834 * If @window belongs to @application then this call is equivalent to
835 * setting the #GtkWindow:application property of @window to
838 * The application may stop running as a result of a call to this
844 gtk_application_remove_window (GtkApplication *application,
847 g_return_if_fail (GTK_IS_APPLICATION (application));
849 if (g_list_find (application->priv->windows, window))
850 g_signal_emit (application,
851 gtk_application_signals[WINDOW_REMOVED], 0, window);
855 * gtk_application_get_windows:
856 * @application: a #GtkApplication
858 * Gets a list of the #GtkWindows associated with @application.
860 * The list is sorted by most recently focused window, such that the first
861 * element is the currently focused window. (Useful for choosing a parent
862 * for a transient window.)
864 * The list that is returned should not be modified in any way. It will
865 * only remain valid until the next focus change or window creation or
868 * Returns: (element-type GtkWindow) (transfer none): a #GList of #GtkWindow
873 gtk_application_get_windows (GtkApplication *application)
875 g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
877 return application->priv->windows;
881 * gtk_application_get_window_by_id:
882 * @application: a #GtkApplication
883 * @id: an identifier number
885 * Returns: (transfer none): the #GtkApplicationWindow with ID @id, or
886 * %NULL if there is no window with this ID
891 gtk_application_get_window_by_id (GtkApplication *application,
896 g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
898 for (l = application->priv->windows; l != NULL; l = l->next)
900 if (GTK_IS_APPLICATION_WINDOW (l->data) &&
901 gtk_application_window_get_id (GTK_APPLICATION_WINDOW (l->data)) == id)
909 * gtk_application_add_accelerator:
910 * @application: a #GtkApplication
911 * @accelerator: accelerator string
912 * @action_name: the name of the action to activate
913 * @parameter: (allow-none): parameter to pass when activating the action,
914 * or %NULL if the action does not accept an activation parameter
916 * Installs an accelerator that will cause the named action
917 * to be activated when the key combination specificed by @accelerator
920 * @accelerator must be a string that can be parsed by
921 * gtk_accelerator_parse(), e.g. "<Primary>q" or "<Control><Alt>p".
923 * @action_name must be the name of an action as it would be used
924 * in the app menu, i.e. actions that have been added to the application
925 * are referred to with an "app." prefix, and window-specific actions
926 * with a "win." prefix.
928 * GtkApplication also extracts accelerators out of 'accel' attributes
929 * in the #GMenuModels passed to gtk_application_set_app_menu() and
930 * gtk_application_set_menubar(), which is usually more convenient
931 * than calling this function for each accelerator.
936 gtk_application_add_accelerator (GtkApplication *application,
937 const gchar *accelerator,
938 const gchar *action_name,
943 GdkModifierType accel_mods;
945 g_return_if_fail (GTK_IS_APPLICATION (application));
947 /* Call this here, since gtk_init() is only getting called in startup() */
948 _gtk_accel_map_init ();
950 gtk_accelerator_parse (accelerator, &accel_key, &accel_mods);
954 g_warning ("Failed to parse accelerator: '%s'\n", accelerator);
958 accel_path = _gtk_accel_path_for_action (action_name, parameter);
960 if (gtk_accel_map_lookup_entry (accel_path, NULL))
961 gtk_accel_map_change_entry (accel_path, accel_key, accel_mods, TRUE);
963 gtk_accel_map_add_entry (accel_path, accel_key, accel_mods);
969 * gtk_application_remove_accelerator:
970 * @application: a #GtkApplication
971 * @action_name: the name of the action to activate
972 * @parameter: (allow-none): parameter to pass when activating the action,
973 * or %NULL if the action does not accept an activation parameter
975 * Removes an accelerator that has been previously added
976 * with gtk_application_add_accelerator().
981 gtk_application_remove_accelerator (GtkApplication *application,
982 const gchar *action_name,
987 g_return_if_fail (GTK_IS_APPLICATION (application));
989 accel_path = _gtk_accel_path_for_action (action_name, parameter);
991 if (!gtk_accel_map_lookup_entry (accel_path, NULL))
993 g_warning ("No accelerator found for '%s'\n", accel_path);
998 gtk_accel_map_change_entry (accel_path, 0, 0, FALSE);
1003 * gtk_application_set_app_menu:
1004 * @application: a #GtkApplication
1005 * @app_menu: (allow-none): a #GMenuModel, or %NULL
1007 * Sets or unsets the application menu for @application.
1009 * This can only be done in the primary instance of the application,
1010 * after it has been registered. #GApplication:startup is a good place
1013 * The application menu is a single menu containing items that typically
1014 * impact the application as a whole, rather than acting on a specific
1015 * window or document. For example, you would expect to see
1016 * "Preferences" or "Quit" in an application menu, but not "Save" or
1019 * If supported, the application menu will be rendered by the desktop
1022 * Use the base #GActionMap interface to add actions, to respond to the user
1023 * selecting these menu items.
1028 gtk_application_set_app_menu (GtkApplication *application,
1029 GMenuModel *app_menu)
1031 g_return_if_fail (GTK_IS_APPLICATION (application));
1032 g_return_if_fail (g_application_get_is_registered (G_APPLICATION (application)));
1033 g_return_if_fail (!g_application_get_is_remote (G_APPLICATION (application)));
1035 if (app_menu != application->priv->app_menu)
1037 if (application->priv->app_menu != NULL)
1038 g_object_unref (application->priv->app_menu);
1040 application->priv->app_menu = app_menu;
1042 if (application->priv->app_menu != NULL)
1043 g_object_ref (application->priv->app_menu);
1045 extract_accels_from_menu (app_menu, application);
1047 #ifdef GDK_WINDOWING_X11
1048 gtk_application_set_app_menu_x11 (application, app_menu);
1051 g_object_notify (G_OBJECT (application), "app-menu");
1056 * gtk_application_get_app_menu:
1057 * @application: a #GtkApplication
1059 * Returns the menu model that has been set with
1060 * gtk_application_set_app_menu().
1062 * Returns: (transfer none): the application menu of @application
1067 gtk_application_get_app_menu (GtkApplication *application)
1069 g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
1071 return application->priv->app_menu;
1075 * gtk_application_set_menubar:
1076 * @application: a #GtkApplication
1077 * @menubar: (allow-none): a #GMenuModel, or %NULL
1079 * Sets or unsets the menubar for windows of @application.
1081 * This is a menubar in the traditional sense.
1083 * This can only be done in the primary instance of the application,
1084 * after it has been registered. #GApplication:startup is a good place
1087 * Depending on the desktop environment, this may appear at the top of
1088 * each window, or at the top of the screen. In some environments, if
1089 * both the application menu and the menubar are set, the application
1090 * menu will be presented as if it were the first item of the menubar.
1091 * Other environments treat the two as completely separate -- for
1092 * example, the application menu may be rendered by the desktop shell
1093 * while the menubar (if set) remains in each individual window.
1095 * Use the base #GActionMap interface to add actions, to respond to the user
1096 * selecting these menu items.
1101 gtk_application_set_menubar (GtkApplication *application,
1102 GMenuModel *menubar)
1104 g_return_if_fail (GTK_IS_APPLICATION (application));
1105 g_return_if_fail (g_application_get_is_registered (G_APPLICATION (application)));
1106 g_return_if_fail (!g_application_get_is_remote (G_APPLICATION (application)));
1108 if (menubar != application->priv->menubar)
1110 if (application->priv->menubar != NULL)
1111 g_object_unref (application->priv->menubar);
1113 application->priv->menubar = menubar;
1115 if (application->priv->menubar != NULL)
1116 g_object_ref (application->priv->menubar);
1118 extract_accels_from_menu (menubar, application);
1120 #ifdef GDK_WINDOWING_X11
1121 gtk_application_set_menubar_x11 (application, menubar);
1124 g_object_notify (G_OBJECT (application), "menubar");
1129 * gtk_application_get_menubar:
1130 * @application: a #GtkApplication
1132 * Returns the menu model that has been set with
1133 * gtk_application_set_menubar().
1135 * Returns: (transfer none): the menubar for windows of @application
1140 gtk_application_get_menubar (GtkApplication *application)
1142 g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
1144 return application->priv->menubar;
1147 #if defined(GDK_WINDOWING_X11)
1149 /* D-Bus Session Management
1151 * The protocol and the D-Bus API are described here:
1152 * http://live.gnome.org/SessionManagement/GnomeSession
1153 * http://people.gnome.org/~mccann/gnome-session/docs/gnome-session.html
1157 unregister_client (GtkApplication *app)
1159 GError *error = NULL;
1161 g_debug ("Unregistering client");
1163 g_dbus_proxy_call_sync (app->priv->sm_proxy,
1165 g_variant_new ("(o)", app->priv->client_path),
1166 G_DBUS_CALL_FLAGS_NONE,
1173 g_warning ("Failed to unregister client: %s", error->message);
1174 g_error_free (error);
1177 g_clear_object (&app->priv->client_proxy);
1179 g_free (app->priv->client_path);
1180 app->priv->client_path = NULL;
1184 gtk_application_quit_response (GtkApplication *application,
1186 const gchar *reason)
1188 g_debug ("Calling EndSessionResponse %d '%s'", will_quit, reason);
1190 g_dbus_proxy_call (application->priv->client_proxy,
1191 "EndSessionResponse",
1192 g_variant_new ("(bs)", will_quit, reason ? reason : ""),
1193 G_DBUS_CALL_FLAGS_NONE,
1198 client_proxy_signal (GDBusProxy *proxy,
1199 const gchar *sender_name,
1200 const gchar *signal_name,
1201 GVariant *parameters,
1202 GtkApplication *app)
1204 if (strcmp (signal_name, "QueryEndSession") == 0)
1206 g_debug ("Received QueryEndSession");
1207 gtk_application_quit_response (app, TRUE, NULL);
1209 else if (strcmp (signal_name, "CancelEndSession") == 0)
1211 g_debug ("Received CancelEndSession");
1213 else if (strcmp (signal_name, "EndSession") == 0)
1215 g_debug ("Received EndSession");
1216 gtk_application_quit_response (app, TRUE, NULL);
1217 unregister_client (app);
1218 g_application_quit (G_APPLICATION (app));
1220 else if (strcmp (signal_name, "Stop") == 0)
1222 g_debug ("Received Stop");
1223 unregister_client (app);
1224 g_application_quit (G_APPLICATION (app));
1229 gtk_application_startup_session_dbus (GtkApplication *app)
1231 static gchar *client_id;
1232 GError *error = NULL;
1235 if (app->priv->session_bus == NULL)
1238 if (client_id == NULL)
1240 const gchar *desktop_autostart_id;
1242 desktop_autostart_id = g_getenv ("DESKTOP_AUTOSTART_ID");
1243 /* Unset DESKTOP_AUTOSTART_ID in order to avoid child processes to
1244 * use the same client id.
1246 g_unsetenv ("DESKTOP_AUTOSTART_ID");
1247 client_id = g_strdup (desktop_autostart_id ? desktop_autostart_id : "");
1250 g_debug ("Connecting to session manager");
1252 app->priv->sm_proxy = g_dbus_proxy_new_sync (app->priv->session_bus,
1253 G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES |
1254 G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS,
1256 "org.gnome.SessionManager",
1257 "/org/gnome/SessionManager",
1258 "org.gnome.SessionManager",
1263 g_warning ("Failed to get a session proxy: %s", error->message);
1264 g_error_free (error);
1268 /* FIXME: should we reuse the D-Bus application id here ? */
1269 app->priv->app_id = g_strdup (g_get_prgname ());
1271 if (!app->priv->register_session)
1274 g_debug ("Registering client '%s' '%s'", app->priv->app_id, client_id);
1276 res = g_dbus_proxy_call_sync (app->priv->sm_proxy,
1278 g_variant_new ("(ss)", app->priv->app_id, client_id),
1279 G_DBUS_CALL_FLAGS_NONE,
1286 g_warning ("Failed to register client: %s", error->message);
1287 g_error_free (error);
1288 g_clear_object (&app->priv->sm_proxy);
1292 g_variant_get (res, "(o)", &app->priv->client_path);
1293 g_variant_unref (res);
1295 g_debug ("Registered client at '%s'", app->priv->client_path);
1297 app->priv->client_proxy = g_dbus_proxy_new_sync (app->priv->session_bus, 0,
1299 "org.gnome.SessionManager",
1300 app->priv->client_path,
1301 "org.gnome.SessionManager.ClientPrivate",
1306 g_warning ("Failed to get client proxy: %s", error->message);
1307 g_error_free (error);
1308 g_clear_object (&app->priv->sm_proxy);
1309 g_free (app->priv->client_path);
1310 app->priv->client_path = NULL;
1314 g_signal_connect (app->priv->client_proxy, "g-signal", G_CALLBACK (client_proxy_signal), app);
1320 * GtkApplicationInhibitFlags:
1321 * @GTK_APPLICATION_INHIBIT_LOGOUT: Inhibit ending the user session
1322 * by logging out or by shutting down the computer
1323 * @GTK_APPLICATION_INHIBIT_SWITCH: Inhibit user switching
1324 * @GTK_APPLICATION_INHIBIT_SUSPEND: Inhibit suspending the
1325 * session or computer
1326 * @GTK_APPLICATION_INHIBIT_IDLE: Inhibit the session being
1327 * marked as idle (and possibly locked)
1329 * Types of user actions that may be blocked by gtk_application_inhibit().
1335 * gtk_application_inhibit:
1336 * @application: the #GApplication
1337 * @window: (allow-none): a #GtkWindow, or %NULL
1338 * @flags: what types of actions should be inhibited
1339 * @reason: (allow-none): a short, human-readable string that explains
1340 * why these operations are inhibited
1342 * Inform the session manager that certain types of actions should be
1343 * inhibited. This is not guaranteed to work on all platforms and for
1344 * all types of actions.
1346 * Applications should invoke this method when they begin an operation
1347 * that should not be interrupted, such as creating a CD or DVD. The
1348 * types of actions that may be blocked are specified by the @flags
1349 * parameter. When the application completes the operation it should
1350 * call g_application_uninhibit() to remove the inhibitor. Note that
1351 * an application can have multiple inhibitors, and all of the must
1352 * be individually removed. Inhibitors are also cleared when the
1353 * application exits.
1355 * Applications should not expect that they will always be able to block
1356 * the action. In most cases, users will be given the option to force
1357 * the action to take place.
1359 * Reasons should be short and to the point.
1361 * If @window is given, the session manager may point the user to
1362 * this window to find out more about why the action is inhibited.
1364 * Returns: A non-zero cookie that is used to uniquely identify this
1365 * request. It should be used as an argument to g_application_uninhibit()
1366 * in order to remove the request. If the platform does not support
1367 * inhibiting or the request failed for some reason, 0 is returned.
1372 gtk_application_inhibit (GtkApplication *application,
1374 GtkApplicationInhibitFlags flags,
1375 const gchar *reason)
1378 GError *error = NULL;
1382 g_return_val_if_fail (GTK_IS_APPLICATION (application), 0);
1383 g_return_val_if_fail (!g_application_get_is_remote (G_APPLICATION (application)), 0);
1384 g_return_val_if_fail (application->priv->sm_proxy != NULL, 0);
1387 xid = GDK_WINDOW_XID (gtk_widget_get_window (GTK_WIDGET (window)));
1391 res = g_dbus_proxy_call_sync (application->priv->sm_proxy,
1393 g_variant_new ("(susu)",
1394 application->priv->app_id,
1398 G_DBUS_CALL_FLAGS_NONE,
1404 g_warning ("Calling Inhibit failed: %s", error->message);
1405 g_error_free (error);
1409 g_variant_get (res, "(u)", &cookie);
1410 g_variant_unref (res);
1416 * gtk_application_uninhibit:
1417 * @application: the #GApplication
1418 * @cookie: a cookie that was returned by g_application_inhibit()
1420 * Removes an inhibitor that has been established with g_application_inhibit().
1421 * Inhibitors are also cleared when the application exits.
1426 gtk_application_uninhibit (GtkApplication *application,
1429 g_return_if_fail (GTK_IS_APPLICATION (application));
1430 g_return_if_fail (!g_application_get_is_remote (G_APPLICATION (application)));
1431 g_return_if_fail (application->priv->sm_proxy != NULL);
1433 g_dbus_proxy_call (application->priv->sm_proxy,
1435 g_variant_new ("(u)", cookie),
1436 G_DBUS_CALL_FLAGS_NONE,
1442 * gtk_application_is_inhibited:
1443 * @application: the #GApplication
1444 * @flags: what types of actions should be queried
1446 * Determines if any of the actions specified in @flags are
1447 * currently inhibited (possibly by another application).
1449 * Returns: %TRUE if any of the actions specified in @flags are inhibited
1454 gtk_application_is_inhibited (GtkApplication *application,
1455 GtkApplicationInhibitFlags flags)
1458 GError *error = NULL;
1461 g_return_val_if_fail (GTK_IS_APPLICATION (application), FALSE);
1462 g_return_val_if_fail (!g_application_get_is_remote (G_APPLICATION (application)), FALSE);
1463 g_return_val_if_fail (application->priv->sm_proxy != NULL, FALSE);
1465 res = g_dbus_proxy_call_sync (application->priv->sm_proxy,
1467 g_variant_new ("(u)", flags),
1468 G_DBUS_CALL_FLAGS_NONE,
1474 g_warning ("Calling IsInhibited failed: %s", error->message);
1475 g_error_free (error);
1479 g_variant_get (res, "(b)", &inhibited);
1480 g_variant_unref (res);
1485 #elif defined(GDK_WINDOWING_QUARTZ)
1487 /* OS X implementation copied from EggSMClient, but simplified since
1488 * it doesn't need to interact with the user.
1492 idle_will_quit (gpointer data)
1494 GtkApplication *app = data;
1496 if (app->priv->quit_inhibit == 0)
1497 g_application_quit (G_APPLICATION (app));
1500 GtkApplicationQuartzInhibitor *inhibitor;
1504 for (iter = app->priv->inhibitors; iter; iter = iter->next)
1506 inhibitor = iter->data;
1507 if (inhibitor->flags & GTK_APPLICATION_INHIBIT_LOGOUT)
1510 g_assert (inhibitor != NULL);
1512 dialog = gtk_message_dialog_new (inhibitor->window,
1516 _("%s cannot quit at this time:\n\n%s"),
1517 g_get_application_name (),
1519 g_signal_connect_swapped (dialog,
1521 G_CALLBACK (gtk_widget_destroy),
1523 gtk_widget_show_all (dialog);
1526 return G_SOURCE_REMOVE;
1530 quit_requested (const AppleEvent *aevt,
1534 GtkApplication *app = GSIZE_TO_POINTER ((gsize)refcon);
1536 /* Don't emit the "quit" signal immediately, since we're
1537 * called from a weird point in the guts of gdkeventloop-quartz.c
1539 g_idle_add_full (G_PRIORITY_DEFAULT, idle_will_quit, app, NULL);
1541 return app->priv->quit_inhibit == 0 ? noErr : userCanceledErr;
1545 gtk_application_startup_session_quartz (GtkApplication *app)
1547 if (app->priv->register_session)
1548 AEInstallEventHandler (kCoreEventClass, kAEQuitApplication,
1549 NewAEEventHandlerUPP (quit_requested),
1550 (long)GPOINTER_TO_SIZE (app), false);
1554 gtk_application_inhibit (GtkApplication *application,
1556 GtkApplicationInhibitFlags flags,
1557 const gchar *reason)
1559 GtkApplicationQuartzInhibitor *inhibitor;
1561 g_return_val_if_fail (GTK_IS_APPLICATION (application), 0);
1562 g_return_val_if_fail (flags != 0, 0);
1564 inhibitor = g_slice_new (GtkApplicationQuartzInhibitor);
1565 inhibitor->cookie = ++application->priv->next_cookie;
1566 inhibitor->flags = flags;
1567 inhibitor->reason = g_strdup (reason);
1568 inhibitor->window = window ? g_object_ref (window) : NULL;
1570 application->priv->inhibitors = g_slist_prepend (application->priv->inhibitors, inhibitor);
1572 if (flags & GTK_APPLICATION_INHIBIT_LOGOUT)
1573 application->priv->quit_inhibit++;
1575 return inhibitor->cookie;
1579 gtk_application_uninhibit (GtkApplication *application,
1584 for (iter = application->priv->inhibitors; iter; iter = iter->next)
1586 GtkApplicationQuartzInhibitor *inhibitor = iter->data;
1588 if (inhibitor->cookie == cookie)
1590 if (inhibitor->flags & GTK_APPLICATION_INHIBIT_LOGOUT)
1591 application->priv->quit_inhibit--;
1592 gtk_application_quartz_inhibitor_free (inhibitor);
1593 application->priv->inhibitors = g_slist_delete_link (application->priv->inhibitors, iter);
1598 g_warning ("Invalid inhibitor cookie");
1602 gtk_application_is_inhibited (GtkApplication *application,
1603 GtkApplicationInhibitFlags flags)
1605 if (flags & GTK_APPLICATION_INHIBIT_LOGOUT)
1606 return application->priv->quit_inhibit > 0;
1613 /* Trivial implementation.
1615 * For the inhibit API on Windows, see
1616 * http://msdn.microsoft.com/en-us/library/ms700677%28VS.85%29.aspx
1620 gtk_application_inhibit (GtkApplication *application,
1622 GtkApplicationInhibitFlags flags,
1623 const gchar *reason)
1629 gtk_application_uninhibit (GtkApplication *application,
1635 gtk_application_is_inhibited (GtkApplication *application,
1636 GtkApplicationInhibitFlags flags)