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 application->priv->next_id = 1;
509 gtk_application_window_added (GtkApplication *application,
512 GtkApplicationPrivate *priv = application->priv;
514 priv->windows = g_list_prepend (priv->windows, window);
515 gtk_window_set_application (window, application);
516 g_application_hold (G_APPLICATION (application));
518 g_signal_connect (window, "focus-in-event",
519 G_CALLBACK (gtk_application_focus_in_event_cb),
522 #ifdef GDK_WINDOWING_X11
523 gtk_application_window_added_x11 (application, window);
528 gtk_application_window_removed (GtkApplication *application,
531 GtkApplicationPrivate *priv = application->priv;
533 #ifdef GDK_WINDOWING_X11
534 gtk_application_window_removed_x11 (application, window);
537 g_signal_handlers_disconnect_by_func (window,
538 gtk_application_focus_in_event_cb,
541 g_application_release (G_APPLICATION (application));
542 priv->windows = g_list_remove (priv->windows, window);
543 gtk_window_set_application (window, NULL);
547 extract_accel_from_menu_item (GMenuModel *model,
551 GMenuAttributeIter *iter;
554 const gchar *accel = NULL;
555 const gchar *action = NULL;
556 GVariant *target = NULL;
558 iter = g_menu_model_iterate_item_attributes (model, item);
559 while (g_menu_attribute_iter_get_next (iter, &key, &value))
561 if (g_str_equal (key, "action") && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
562 action = g_variant_get_string (value, NULL);
563 else if (g_str_equal (key, "accel") && g_variant_is_of_type (value, G_VARIANT_TYPE_STRING))
564 accel = g_variant_get_string (value, NULL);
565 else if (g_str_equal (key, "target"))
566 target = g_variant_ref (value);
567 g_variant_unref (value);
569 g_object_unref (iter);
572 gtk_application_add_accelerator (app, accel, action, target);
575 g_variant_unref (target);
579 extract_accels_from_menu (GMenuModel *model,
587 for (i = 0; i < g_menu_model_get_n_items (model); i++)
589 extract_accel_from_menu_item (model, i, app);
591 iter = g_menu_model_iterate_item_links (model, i);
592 while (g_menu_link_iter_get_next (iter, &key, &m))
594 extract_accels_from_menu (m, app);
597 g_object_unref (iter);
602 gtk_application_get_property (GObject *object,
607 GtkApplication *application = GTK_APPLICATION (object);
611 case PROP_REGISTER_SESSION:
612 g_value_set_boolean (value, application->priv->register_session);
616 g_value_set_object (value, gtk_application_get_app_menu (application));
620 g_value_set_object (value, gtk_application_get_menubar (application));
624 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
630 gtk_application_set_property (GObject *object,
635 GtkApplication *application = GTK_APPLICATION (object);
639 case PROP_REGISTER_SESSION:
640 application->priv->register_session = g_value_get_boolean (value);
644 gtk_application_set_app_menu (application, g_value_get_object (value));
648 gtk_application_set_menubar (application, g_value_get_object (value));
652 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
658 gtk_application_finalize (GObject *object)
660 GtkApplication *application = GTK_APPLICATION (object);
662 g_clear_object (&application->priv->app_menu);
663 g_clear_object (&application->priv->menubar);
665 G_OBJECT_CLASS (gtk_application_parent_class)
670 gtk_application_class_init (GtkApplicationClass *class)
672 GObjectClass *object_class = G_OBJECT_CLASS (class);
673 GApplicationClass *application_class = G_APPLICATION_CLASS (class);
675 object_class->get_property = gtk_application_get_property;
676 object_class->set_property = gtk_application_set_property;
677 object_class->finalize = gtk_application_finalize;
679 application_class->add_platform_data = gtk_application_add_platform_data;
680 application_class->before_emit = gtk_application_before_emit;
681 application_class->after_emit = gtk_application_after_emit;
682 application_class->startup = gtk_application_startup;
683 application_class->shutdown = gtk_application_shutdown;
685 class->window_added = gtk_application_window_added;
686 class->window_removed = gtk_application_window_removed;
688 g_type_class_add_private (class, sizeof (GtkApplicationPrivate));
691 * GtkApplication::window-added:
692 * @application: the #GtkApplication which emitted the signal
693 * @window: the newly-added #GtkWindow
695 * Emitted when a #GtkWindow is added to @application through
696 * gtk_application_add_window().
700 gtk_application_signals[WINDOW_ADDED] =
701 g_signal_new ("window-added", GTK_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
702 G_STRUCT_OFFSET (GtkApplicationClass, window_added),
704 g_cclosure_marshal_VOID__OBJECT,
705 G_TYPE_NONE, 1, GTK_TYPE_WINDOW);
708 * GtkApplication::window-removed:
709 * @application: the #GtkApplication which emitted the signal
710 * @window: the #GtkWindow that is being removed
712 * Emitted when a #GtkWindow is removed from @application,
713 * either as a side-effect of being destroyed or explicitly
714 * through gtk_application_remove_window().
718 gtk_application_signals[WINDOW_REMOVED] =
719 g_signal_new ("window-removed", GTK_TYPE_APPLICATION, G_SIGNAL_RUN_FIRST,
720 G_STRUCT_OFFSET (GtkApplicationClass, window_removed),
722 g_cclosure_marshal_VOID__OBJECT,
723 G_TYPE_NONE, 1, GTK_TYPE_WINDOW);
726 * GtkApplication:register-session:
728 * Set this property to %TRUE to register with the session manager.
732 g_object_class_install_property (object_class, PROP_REGISTER_SESSION,
733 g_param_spec_boolean ("register-session",
734 P_("Register session"),
735 P_("Register with the session manager"),
736 FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
738 g_object_class_install_property (object_class, PROP_APP_MENU,
739 g_param_spec_object ("app-menu",
740 P_("Application menu"),
741 P_("The GMenuModel for the application menu"),
743 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
745 g_object_class_install_property (object_class, PROP_MENUBAR,
746 g_param_spec_object ("menubar",
748 P_("The GMenuModel for the menubar"),
750 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
754 * gtk_application_new:
755 * @application_id: the application id
756 * @flags: the application flags
758 * Creates a new #GtkApplication instance.
760 * This function calls g_type_init() for you. gtk_init() is called
761 * as soon as the application gets registered as the primary instance.
763 * Concretely, gtk_init() is called in the default handler for the
764 * #GApplication:startup signal. Therefore, #GtkApplication subclasses should
765 * chain up in their #GApplication:startup handler before using any GTK+ API.
767 * Note that commandline arguments are not passed to gtk_init().
768 * All GTK+ functionality that is available via commandline arguments
769 * can also be achieved by setting suitable environment variables
770 * such as <envar>G_DEBUG</envar>, so this should not be a big
771 * problem. If you absolutely must support GTK+ commandline arguments,
772 * you can explicitly call gtk_init() before creating the application
775 * The application id must be valid. See g_application_id_is_valid().
777 * Returns: a new #GtkApplication instance
782 gtk_application_new (const gchar *application_id,
783 GApplicationFlags flags)
785 g_return_val_if_fail (g_application_id_is_valid (application_id), NULL);
789 return g_object_new (GTK_TYPE_APPLICATION,
790 "application-id", application_id,
796 * gtk_application_add_window:
797 * @application: a #GtkApplication
798 * @window: a #GtkWindow
800 * Adds a window to @application.
802 * This call is equivalent to setting the #GtkWindow:application
803 * property of @window to @application.
805 * Normally, the connection between the application and the window
806 * will remain until the window is destroyed, but you can explicitly
807 * remove it with gtk_application_remove_window().
809 * GTK+ will keep the application running as long as it has
815 gtk_application_add_window (GtkApplication *application,
818 g_return_if_fail (GTK_IS_APPLICATION (application));
820 if (!g_list_find (application->priv->windows, window))
821 g_signal_emit (application,
822 gtk_application_signals[WINDOW_ADDED], 0, window);
826 * gtk_application_remove_window:
827 * @application: a #GtkApplication
828 * @window: a #GtkWindow
830 * Remove a window from @application.
832 * If @window belongs to @application then this call is equivalent to
833 * setting the #GtkWindow:application property of @window to
836 * The application may stop running as a result of a call to this
842 gtk_application_remove_window (GtkApplication *application,
845 g_return_if_fail (GTK_IS_APPLICATION (application));
847 if (g_list_find (application->priv->windows, window))
848 g_signal_emit (application,
849 gtk_application_signals[WINDOW_REMOVED], 0, window);
853 * gtk_application_get_windows:
854 * @application: a #GtkApplication
856 * Gets a list of the #GtkWindows associated with @application.
858 * The list is sorted by most recently focused window, such that the first
859 * element is the currently focused window. (Useful for choosing a parent
860 * for a transient window.)
862 * The list that is returned should not be modified in any way. It will
863 * only remain valid until the next focus change or window creation or
866 * Returns: (element-type GtkWindow) (transfer none): a #GList of #GtkWindow
871 gtk_application_get_windows (GtkApplication *application)
873 g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
875 return application->priv->windows;
879 * gtk_application_get_window_by_id:
880 * @application: a #GtkApplication
881 * @id: an identifier number
883 * Returns: (transfer none): the #GtkApplicationWindow with ID @id, or
884 * %NULL if there is no window with this ID
889 gtk_application_get_window_by_id (GtkApplication *application,
894 g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
896 for (l = application->priv->windows; l != NULL; l = l->next)
898 if (GTK_IS_APPLICATION_WINDOW (l->data) &&
899 gtk_application_window_get_id (GTK_APPLICATION_WINDOW (l->data)) == id)
907 * gtk_application_add_accelerator:
908 * @application: a #GtkApplication
909 * @accelerator: accelerator string
910 * @action_name: the name of the action to activate
911 * @parameter: (allow-none): parameter to pass when activating the action,
912 * or %NULL if the action does not accept an activation parameter
914 * Installs an accelerator that will cause the named action
915 * to be activated when the key combination specificed by @accelerator
918 * @accelerator must be a string that can be parsed by
919 * gtk_accelerator_parse(), e.g. "<Primary>q" or "<Control><Alt>p".
921 * @action_name must be the name of an action as it would be used
922 * in the app menu, i.e. actions that have been added to the application
923 * are referred to with an "app." prefix, and window-specific actions
924 * with a "win." prefix.
926 * GtkApplication also extracts accelerators out of 'accel' attributes
927 * in the #GMenuModels passed to gtk_application_set_app_menu() and
928 * gtk_application_set_menubar(), which is usually more convenient
929 * than calling this function for each accelerator.
934 gtk_application_add_accelerator (GtkApplication *application,
935 const gchar *accelerator,
936 const gchar *action_name,
941 GdkModifierType accel_mods;
943 g_return_if_fail (GTK_IS_APPLICATION (application));
945 /* Call this here, since gtk_init() is only getting called in startup() */
946 _gtk_accel_map_init ();
948 gtk_accelerator_parse (accelerator, &accel_key, &accel_mods);
952 g_warning ("Failed to parse accelerator: '%s'\n", accelerator);
956 accel_path = _gtk_accel_path_for_action (action_name, parameter);
958 if (gtk_accel_map_lookup_entry (accel_path, NULL))
959 gtk_accel_map_change_entry (accel_path, accel_key, accel_mods, TRUE);
961 gtk_accel_map_add_entry (accel_path, accel_key, accel_mods);
967 * gtk_application_remove_accelerator:
968 * @application: a #GtkApplication
969 * @action_name: the name of the action to activate
970 * @parameter: (allow-none): parameter to pass when activating the action,
971 * or %NULL if the action does not accept an activation parameter
973 * Removes an accelerator that has been previously added
974 * with gtk_application_add_accelerator().
979 gtk_application_remove_accelerator (GtkApplication *application,
980 const gchar *action_name,
985 g_return_if_fail (GTK_IS_APPLICATION (application));
987 accel_path = _gtk_accel_path_for_action (action_name, parameter);
989 if (!gtk_accel_map_lookup_entry (accel_path, NULL))
991 g_warning ("No accelerator found for '%s'\n", accel_path);
996 gtk_accel_map_change_entry (accel_path, 0, 0, FALSE);
1001 * gtk_application_set_app_menu:
1002 * @application: a #GtkApplication
1003 * @app_menu: (allow-none): a #GMenuModel, or %NULL
1005 * Sets or unsets the application menu for @application.
1007 * This can only be done in the primary instance of the application,
1008 * after it has been registered. #GApplication:startup is a good place
1011 * The application menu is a single menu containing items that typically
1012 * impact the application as a whole, rather than acting on a specific
1013 * window or document. For example, you would expect to see
1014 * "Preferences" or "Quit" in an application menu, but not "Save" or
1017 * If supported, the application menu will be rendered by the desktop
1020 * Use the base #GActionMap interface to add actions, to respond to the user
1021 * selecting these menu items.
1026 gtk_application_set_app_menu (GtkApplication *application,
1027 GMenuModel *app_menu)
1029 g_return_if_fail (GTK_IS_APPLICATION (application));
1030 g_return_if_fail (g_application_get_is_registered (G_APPLICATION (application)));
1031 g_return_if_fail (!g_application_get_is_remote (G_APPLICATION (application)));
1033 if (app_menu != application->priv->app_menu)
1035 if (application->priv->app_menu != NULL)
1036 g_object_unref (application->priv->app_menu);
1038 application->priv->app_menu = app_menu;
1040 if (application->priv->app_menu != NULL)
1041 g_object_ref (application->priv->app_menu);
1043 extract_accels_from_menu (app_menu, application);
1045 #ifdef GDK_WINDOWING_X11
1046 gtk_application_set_app_menu_x11 (application, app_menu);
1049 g_object_notify (G_OBJECT (application), "app-menu");
1054 * gtk_application_get_app_menu:
1055 * @application: a #GtkApplication
1057 * Returns the menu model that has been set with
1058 * gtk_application_set_app_menu().
1060 * Returns: (transfer none): the application menu of @application
1065 gtk_application_get_app_menu (GtkApplication *application)
1067 g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
1069 return application->priv->app_menu;
1073 * gtk_application_set_menubar:
1074 * @application: a #GtkApplication
1075 * @menubar: (allow-none): a #GMenuModel, or %NULL
1077 * Sets or unsets the menubar for windows of @application.
1079 * This is a menubar in the traditional sense.
1081 * This can only be done in the primary instance of the application,
1082 * after it has been registered. #GApplication:startup is a good place
1085 * Depending on the desktop environment, this may appear at the top of
1086 * each window, or at the top of the screen. In some environments, if
1087 * both the application menu and the menubar are set, the application
1088 * menu will be presented as if it were the first item of the menubar.
1089 * Other environments treat the two as completely separate -- for
1090 * example, the application menu may be rendered by the desktop shell
1091 * while the menubar (if set) remains in each individual window.
1093 * Use the base #GActionMap interface to add actions, to respond to the user
1094 * selecting these menu items.
1099 gtk_application_set_menubar (GtkApplication *application,
1100 GMenuModel *menubar)
1102 g_return_if_fail (GTK_IS_APPLICATION (application));
1103 g_return_if_fail (g_application_get_is_registered (G_APPLICATION (application)));
1104 g_return_if_fail (!g_application_get_is_remote (G_APPLICATION (application)));
1106 if (menubar != application->priv->menubar)
1108 if (application->priv->menubar != NULL)
1109 g_object_unref (application->priv->menubar);
1111 application->priv->menubar = menubar;
1113 if (application->priv->menubar != NULL)
1114 g_object_ref (application->priv->menubar);
1116 extract_accels_from_menu (menubar, application);
1118 #ifdef GDK_WINDOWING_X11
1119 gtk_application_set_menubar_x11 (application, menubar);
1122 g_object_notify (G_OBJECT (application), "menubar");
1127 * gtk_application_get_menubar:
1128 * @application: a #GtkApplication
1130 * Returns the menu model that has been set with
1131 * gtk_application_set_menubar().
1133 * Returns: (transfer none): the menubar for windows of @application
1138 gtk_application_get_menubar (GtkApplication *application)
1140 g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
1142 return application->priv->menubar;
1145 #if defined(GDK_WINDOWING_X11)
1147 /* D-Bus Session Management
1149 * The protocol and the D-Bus API are described here:
1150 * http://live.gnome.org/SessionManagement/GnomeSession
1151 * http://people.gnome.org/~mccann/gnome-session/docs/gnome-session.html
1155 unregister_client (GtkApplication *app)
1157 GError *error = NULL;
1159 g_debug ("Unregistering client");
1161 g_dbus_proxy_call_sync (app->priv->sm_proxy,
1163 g_variant_new ("(o)", app->priv->client_path),
1164 G_DBUS_CALL_FLAGS_NONE,
1171 g_warning ("Failed to unregister client: %s", error->message);
1172 g_error_free (error);
1175 g_clear_object (&app->priv->client_proxy);
1177 g_free (app->priv->client_path);
1178 app->priv->client_path = NULL;
1182 gtk_application_quit_response (GtkApplication *application,
1184 const gchar *reason)
1186 g_debug ("Calling EndSessionResponse %d '%s'", will_quit, reason);
1188 g_dbus_proxy_call (application->priv->client_proxy,
1189 "EndSessionResponse",
1190 g_variant_new ("(bs)", will_quit, reason ? reason : ""),
1191 G_DBUS_CALL_FLAGS_NONE,
1196 client_proxy_signal (GDBusProxy *proxy,
1197 const gchar *sender_name,
1198 const gchar *signal_name,
1199 GVariant *parameters,
1200 GtkApplication *app)
1202 if (strcmp (signal_name, "QueryEndSession") == 0)
1204 g_debug ("Received QueryEndSession");
1205 gtk_application_quit_response (app, TRUE, NULL);
1207 else if (strcmp (signal_name, "CancelEndSession") == 0)
1209 g_debug ("Received CancelEndSession");
1211 else if (strcmp (signal_name, "EndSession") == 0)
1213 g_debug ("Received EndSession");
1214 gtk_application_quit_response (app, TRUE, NULL);
1215 unregister_client (app);
1216 g_application_quit (G_APPLICATION (app));
1218 else if (strcmp (signal_name, "Stop") == 0)
1220 g_debug ("Received Stop");
1221 unregister_client (app);
1222 g_application_quit (G_APPLICATION (app));
1227 gtk_application_startup_session_dbus (GtkApplication *app)
1229 static gchar *client_id;
1230 GError *error = NULL;
1233 if (app->priv->session_bus == NULL)
1236 if (client_id == NULL)
1238 const gchar *desktop_autostart_id;
1240 desktop_autostart_id = g_getenv ("DESKTOP_AUTOSTART_ID");
1241 /* Unset DESKTOP_AUTOSTART_ID in order to avoid child processes to
1242 * use the same client id.
1244 g_unsetenv ("DESKTOP_AUTOSTART_ID");
1245 client_id = g_strdup (desktop_autostart_id ? desktop_autostart_id : "");
1248 g_debug ("Connecting to session manager");
1250 app->priv->sm_proxy = g_dbus_proxy_new_sync (app->priv->session_bus,
1251 G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES |
1252 G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS,
1254 "org.gnome.SessionManager",
1255 "/org/gnome/SessionManager",
1256 "org.gnome.SessionManager",
1261 g_warning ("Failed to get a session proxy: %s", error->message);
1262 g_error_free (error);
1266 /* FIXME: should we reuse the D-Bus application id here ? */
1267 app->priv->app_id = g_strdup (g_get_prgname ());
1269 if (!app->priv->register_session)
1272 g_debug ("Registering client '%s' '%s'", app->priv->app_id, client_id);
1274 res = g_dbus_proxy_call_sync (app->priv->sm_proxy,
1276 g_variant_new ("(ss)", app->priv->app_id, client_id),
1277 G_DBUS_CALL_FLAGS_NONE,
1284 g_warning ("Failed to register client: %s", error->message);
1285 g_error_free (error);
1286 g_clear_object (&app->priv->sm_proxy);
1290 g_variant_get (res, "(o)", &app->priv->client_path);
1291 g_variant_unref (res);
1293 g_debug ("Registered client at '%s'", app->priv->client_path);
1295 app->priv->client_proxy = g_dbus_proxy_new_sync (app->priv->session_bus, 0,
1297 "org.gnome.SessionManager",
1298 app->priv->client_path,
1299 "org.gnome.SessionManager.ClientPrivate",
1304 g_warning ("Failed to get client proxy: %s", error->message);
1305 g_error_free (error);
1306 g_clear_object (&app->priv->sm_proxy);
1307 g_free (app->priv->client_path);
1308 app->priv->client_path = NULL;
1312 g_signal_connect (app->priv->client_proxy, "g-signal", G_CALLBACK (client_proxy_signal), app);
1318 * GtkApplicationInhibitFlags:
1319 * @GTK_APPLICATION_INHIBIT_LOGOUT: Inhibit ending the user session
1320 * by logging out or by shutting down the computer
1321 * @GTK_APPLICATION_INHIBIT_SWITCH: Inhibit user switching
1322 * @GTK_APPLICATION_INHIBIT_SUSPEND: Inhibit suspending the
1323 * session or computer
1324 * @GTK_APPLICATION_INHIBIT_IDLE: Inhibit the session being
1325 * marked as idle (and possibly locked)
1327 * Types of user actions that may be blocked by gtk_application_inhibit().
1333 * gtk_application_inhibit:
1334 * @application: the #GApplication
1335 * @window: (allow-none): a #GtkWindow, or %NULL
1336 * @flags: what types of actions should be inhibited
1337 * @reason: (allow-none): a short, human-readable string that explains
1338 * why these operations are inhibited
1340 * Inform the session manager that certain types of actions should be
1341 * inhibited. This is not guaranteed to work on all platforms and for
1342 * all types of actions.
1344 * Applications should invoke this method when they begin an operation
1345 * that should not be interrupted, such as creating a CD or DVD. The
1346 * types of actions that may be blocked are specified by the @flags
1347 * parameter. When the application completes the operation it should
1348 * call g_application_uninhibit() to remove the inhibitor. Note that
1349 * an application can have multiple inhibitors, and all of the must
1350 * be individually removed. Inhibitors are also cleared when the
1351 * application exits.
1353 * Applications should not expect that they will always be able to block
1354 * the action. In most cases, users will be given the option to force
1355 * the action to take place.
1357 * Reasons should be short and to the point.
1359 * If @window is given, the session manager may point the user to
1360 * this window to find out more about why the action is inhibited.
1362 * Returns: A non-zero cookie that is used to uniquely identify this
1363 * request. It should be used as an argument to g_application_uninhibit()
1364 * in order to remove the request. If the platform does not support
1365 * inhibiting or the request failed for some reason, 0 is returned.
1370 gtk_application_inhibit (GtkApplication *application,
1372 GtkApplicationInhibitFlags flags,
1373 const gchar *reason)
1376 GError *error = NULL;
1380 g_return_val_if_fail (GTK_IS_APPLICATION (application), 0);
1381 g_return_val_if_fail (!g_application_get_is_remote (G_APPLICATION (application)), 0);
1382 g_return_val_if_fail (application->priv->sm_proxy != NULL, 0);
1385 xid = GDK_WINDOW_XID (gtk_widget_get_window (GTK_WIDGET (window)));
1389 res = g_dbus_proxy_call_sync (application->priv->sm_proxy,
1391 g_variant_new ("(susu)",
1392 application->priv->app_id,
1396 G_DBUS_CALL_FLAGS_NONE,
1402 g_warning ("Calling Inhibit failed: %s", error->message);
1403 g_error_free (error);
1407 g_variant_get (res, "(u)", &cookie);
1408 g_variant_unref (res);
1414 * gtk_application_uninhibit:
1415 * @application: the #GApplication
1416 * @cookie: a cookie that was returned by g_application_inhibit()
1418 * Removes an inhibitor that has been established with g_application_inhibit().
1419 * Inhibitors are also cleared when the application exits.
1424 gtk_application_uninhibit (GtkApplication *application,
1427 g_return_if_fail (GTK_IS_APPLICATION (application));
1428 g_return_if_fail (!g_application_get_is_remote (G_APPLICATION (application)));
1429 g_return_if_fail (application->priv->sm_proxy != NULL);
1431 g_dbus_proxy_call (application->priv->sm_proxy,
1433 g_variant_new ("(u)", cookie),
1434 G_DBUS_CALL_FLAGS_NONE,
1440 * gtk_application_is_inhibited:
1441 * @application: the #GApplication
1442 * @flags: what types of actions should be queried
1444 * Determines if any of the actions specified in @flags are
1445 * currently inhibited (possibly by another application).
1447 * Returns: %TRUE if any of the actions specified in @flags are inhibited
1452 gtk_application_is_inhibited (GtkApplication *application,
1453 GtkApplicationInhibitFlags flags)
1456 GError *error = NULL;
1459 g_return_val_if_fail (GTK_IS_APPLICATION (application), FALSE);
1460 g_return_val_if_fail (!g_application_get_is_remote (G_APPLICATION (application)), FALSE);
1461 g_return_val_if_fail (application->priv->sm_proxy != NULL, FALSE);
1463 res = g_dbus_proxy_call_sync (application->priv->sm_proxy,
1465 g_variant_new ("(u)", flags),
1466 G_DBUS_CALL_FLAGS_NONE,
1472 g_warning ("Calling IsInhibited failed: %s", error->message);
1473 g_error_free (error);
1477 g_variant_get (res, "(b)", &inhibited);
1478 g_variant_unref (res);
1483 #elif defined(GDK_WINDOWING_QUARTZ)
1485 /* OS X implementation copied from EggSMClient, but simplified since
1486 * it doesn't need to interact with the user.
1490 idle_will_quit (gpointer data)
1492 GtkApplication *app = data;
1494 if (app->priv->quit_inhibit == 0)
1495 g_application_quit (G_APPLICATION (app));
1498 GtkApplicationQuartzInhibitor *inhibitor;
1502 for (iter = app->priv->inhibitors; iter; iter = iter->next)
1504 inhibitor = iter->data;
1505 if (inhibitor->flags & GTK_APPLICATION_INHIBIT_LOGOUT)
1508 g_assert (inhibitor != NULL);
1510 dialog = gtk_message_dialog_new (inhibitor->window,
1514 _("%s cannot quit at this time:\n\n%s"),
1515 g_get_application_name (),
1517 g_signal_connect_swapped (dialog,
1519 G_CALLBACK (gtk_widget_destroy),
1521 gtk_widget_show_all (dialog);
1524 return G_SOURCE_REMOVE;
1528 quit_requested (const AppleEvent *aevt,
1532 GtkApplication *app = GSIZE_TO_POINTER ((gsize)refcon);
1534 /* Don't emit the "quit" signal immediately, since we're
1535 * called from a weird point in the guts of gdkeventloop-quartz.c
1537 g_idle_add_full (G_PRIORITY_DEFAULT, idle_will_quit, app, NULL);
1539 return app->priv->quit_inhibit == 0 ? noErr : userCanceledErr;
1543 gtk_application_startup_session_quartz (GtkApplication *app)
1545 if (app->priv->register_session)
1546 AEInstallEventHandler (kCoreEventClass, kAEQuitApplication,
1547 NewAEEventHandlerUPP (quit_requested),
1548 (long)GPOINTER_TO_SIZE (app), false);
1552 gtk_application_inhibit (GtkApplication *application,
1554 GtkApplicationInhibitFlags flags,
1555 const gchar *reason)
1557 GtkApplicationQuartzInhibitor *inhibitor;
1559 g_return_val_if_fail (GTK_IS_APPLICATION (application), 0);
1560 g_return_val_if_fail (flags != 0, 0);
1562 inhibitor = g_slice_new (GtkApplicationQuartzInhibitor);
1563 inhibitor->cookie = ++application->priv->next_cookie;
1564 inhibitor->flags = flags;
1565 inhibitor->reason = g_strdup (reason);
1566 inhibitor->window = window ? g_object_ref (window) : NULL;
1568 application->priv->inhibitors = g_slist_prepend (application->priv->inhibitors, inhibitor);
1570 if (flags & GTK_APPLICATION_INHIBIT_LOGOUT)
1571 application->priv->quit_inhibit++;
1573 return inhibitor->cookie;
1577 gtk_application_uninhibit (GtkApplication *application,
1582 for (iter = application->priv->inhibitors; iter; iter = iter->next)
1584 GtkApplicationQuartzInhibitor *inhibitor = iter->data;
1586 if (inhibitor->cookie == cookie)
1588 if (inhibitor->flags & GTK_APPLICATION_INHIBIT_LOGOUT)
1589 application->priv->quit_inhibit--;
1590 gtk_application_quartz_inhibitor_free (inhibitor);
1591 application->priv->inhibitors = g_slist_delete_link (application->priv->inhibitors, iter);
1596 g_warning ("Invalid inhibitor cookie");
1600 gtk_application_is_inhibited (GtkApplication *application,
1601 GtkApplicationInhibitFlags flags)
1603 if (flags & GTK_APPLICATION_INHIBIT_LOGOUT)
1604 return application->priv->quit_inhibit > 0;
1611 /* Trivial implementation.
1613 * For the inhibit API on Windows, see
1614 * http://msdn.microsoft.com/en-us/library/ms700677%28VS.85%29.aspx
1618 gtk_application_inhibit (GtkApplication *application,
1620 GtkApplicationInhibitFlags flags,
1621 const gchar *reason)
1627 gtk_application_uninhibit (GtkApplication *application,
1633 gtk_application_is_inhibited (GtkApplication *application,
1634 GtkApplicationInhibitFlags flags)