* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* Author: Ryan Lortie <desrt@desrt.ca>
*/
#include "config.h"
+#include "gtkapplication.h"
+
#include <stdlib.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#include <string.h>
-#include "gtkapplication.h"
+#include "gtkapplicationprivate.h"
+#include "gtkclipboard.h"
#include "gtkmarshalers.h"
#include "gtkmain.h"
-#include "gtkapplicationwindow.h"
+#include "gtkrecentmanager.h"
#include "gtkaccelmapprivate.h"
-#include "gactionmuxer.h"
+#include "gtkintl.h"
#ifdef GDK_WINDOWING_QUARTZ
-#include "gtkquartz-menu.h"
+#include "gtkmodelmenu-quartz.h"
#import <Cocoa/Cocoa.h>
+#include <Carbon/Carbon.h>
+#include "gtkmessagedialog.h"
#endif
#include <gdk/gdk.h>
#include <gdk/x11/gdkx.h>
#endif
+extern void _gtk_accessibility_shutdown (void);
+
/**
* SECTION:gtkapplication
* @title: GtkApplication
* a one-size-fits-all application model.
*
* Currently, GtkApplication handles GTK+ initialization, application
- * uniqueness, provides some basic scriptability and desktop shell integration
- * by exporting actions and menus and manages a list of toplevel windows whose
- * life-cycle is automatically tied to the life-cycle of your application.
+ * uniqueness, session management, provides some basic scriptability and
+ * desktop shell integration by exporting actions and menus and manages a
+ * list of toplevel windows whose life-cycle is automatically tied to the
+ * life-cycle of your application.
*
* While GtkApplication works fine with plain #GtkWindows, it is recommended
* to use it together with #GtkApplicationWindow.
*
+ * When GDK threads are enabled, GtkApplication will acquire the GDK
+ * lock when invoking actions that arrive from other processes. The GDK
+ * lock is not touched for local action invocations. In order to have
+ * actions invoked in a predictable context it is therefore recommended
+ * that the GDK lock be held while invoking actions locally with
+ * g_action_group_activate_action(). The same applies to actions
+ * associated with #GtkApplicationWindow and to the 'activate' and
+ * 'open' #GApplication methods.
+ *
+ * To set an application menu for a GtkApplication, use
+ * gtk_application_set_app_menu(). The #GMenuModel that this function
+ * expects is usually constructed using #GtkBuilder, as seen in the
+ * following example. To specify a menubar that will be shown by
+ * #GtkApplicationWindows, use gtk_application_set_menubar(). Use the base
+ * #GActionMap interface to add actions, to respond to the user
+ * selecting these menu items.
+ *
+ * GTK+ displays these menus as expected, depending on the platform
+ * the application is running on.
+ *
+ * <figure label="Menu integration in OS X">
+ * <graphic fileref="bloatpad-osx.png" format="PNG"/>
+ * </figure>
+ *
+ * <figure label="Menu integration in GNOME">
+ * <graphic fileref="bloatpad-gnome.png" format="PNG"/>
+ * </figure>
+ *
+ * <figure label="Menu integration in Xfce">
+ * <graphic fileref="bloatpad-xfce.png" format="PNG"/>
+ * </figure>
+ *
* <example id="gtkapplication"><title>A simple application</title>
* <programlisting>
* <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../examples/bloatpad.c">
* </xi:include>
* </programlisting>
* </example>
+ *
+ * GtkApplication optionally registers with a session manager
+ * of the users session (if you set the #GtkApplication:register-session
+ * property) and offers various functionality related to the session
+ * life-cycle.
+ *
+ * An application can block various ways to end the session with
+ * the gtk_application_inhibit() function. Typical use cases for
+ * this kind of inhibiting are long-running, uninterruptible operations,
+ * such as burning a CD or performing a disk backup. The session
+ * manager may not honor the inhibitor, but it can be expected to
+ * inform the user about the negative consequences of ending the
+ * session while inhibitors are present.
*/
enum {
static guint gtk_application_signals[LAST_SIGNAL];
+enum {
+ PROP_ZERO,
+ PROP_REGISTER_SESSION,
+ PROP_APP_MENU,
+ PROP_MENUBAR,
+ PROP_ACTIVE_WINDOW
+};
+
G_DEFINE_TYPE (GtkApplication, gtk_application, G_TYPE_APPLICATION)
struct _GtkApplicationPrivate
{
GList *windows;
+ gboolean register_session;
+
+ GMenuModel *app_menu;
+ GMenuModel *menubar;
+
#ifdef GDK_WINDOWING_X11
- GDBusConnection *session;
- gchar *window_prefix;
+ GDBusConnection *session_bus;
+ const gchar *application_id;
+ const gchar *object_path;
+
+ gchar *app_menu_path;
+ guint app_menu_id;
+
+ gchar *menubar_path;
+ guint menubar_id;
+
guint next_id;
+
+ GDBusProxy *sm_proxy;
+ GDBusProxy *client_proxy;
+ gchar *app_id;
+ gchar *client_path;
#endif
#ifdef GDK_WINDOWING_QUARTZ
- GActionMuxer *muxer;
GMenu *combined;
+
+ GSList *inhibitors;
+ gint quit_inhibit;
+ guint next_cookie;
#endif
};
#ifdef GDK_WINDOWING_X11
-typedef struct
-{
- guint action_export_id;
- guint window_id;
-} GtkApplicationWindowInfo;
-
static void
-gtk_application_window_realized_x11 (GtkWindow *window,
- gpointer user_data)
+gtk_application_x11_publish_menu (GtkApplication *application,
+ const gchar *type,
+ GMenuModel *model,
+ guint *id,
+ gchar **path)
{
- GtkApplication *application = user_data;
- GtkApplicationWindowInfo *info;
- GdkWindow *gdkwindow;
- gchar *window_path;
- const gchar *unique_id;
- const gchar *app_id;
-
- gdkwindow = gtk_widget_get_window (GTK_WIDGET (window));
+ gint i;
- if (!GDK_IS_X11_WINDOW (gdkwindow))
+ if (application->priv->session_bus == NULL)
return;
- info = g_object_get_data (G_OBJECT (window), "GtkApplication::window-info");
+ /* unexport any existing menu */
+ if (*id)
+ {
+ g_dbus_connection_unexport_menu_model (application->priv->session_bus, *id);
+ g_free (*path);
+ *path = NULL;
+ *id = 0;
+ }
- window_path = g_strdup_printf ("%s%d", application->priv->window_prefix, info->window_id);
- gdk_x11_window_set_utf8_property (gdkwindow, "_DBUS_OBJECT_PATH", window_path);
- g_free (window_path);
+ /* export the new menu, if there is one */
+ if (model != NULL)
+ {
+ /* try getting the preferred name */
+ *path = g_strconcat (application->priv->object_path, "/menus/", type, NULL);
+ *id = g_dbus_connection_export_menu_model (application->priv->session_bus, *path, model, NULL);
- unique_id = g_dbus_connection_get_unique_name (application->priv->session);
- gdk_x11_window_set_utf8_property (gdkwindow, "_DBUS_UNIQUE_NAME", unique_id);
+ /* keep trying until we get a working name... */
+ for (i = 0; *id == 0; i++)
+ {
+ g_free (*path);
+ *path = g_strdup_printf ("%s/menus/%s%d", application->priv->object_path, type, i);
+ *id = g_dbus_connection_export_menu_model (application->priv->session_bus, *path, model, NULL);
+ }
+ }
+}
- app_id = g_application_get_application_id (G_APPLICATION (application));
- gdk_x11_window_set_utf8_property (gdkwindow, "_DBUS_APPLICATION_ID", app_id);
+static void
+gtk_application_set_app_menu_x11 (GtkApplication *application,
+ GMenuModel *app_menu)
+{
+ gtk_application_x11_publish_menu (application, "appmenu", app_menu,
+ &application->priv->app_menu_id,
+ &application->priv->app_menu_path);
+}
+
+static void
+gtk_application_set_menubar_x11 (GtkApplication *application,
+ GMenuModel *menubar)
+{
+ gtk_application_x11_publish_menu (application, "menubar", menubar,
+ &application->priv->menubar_id,
+ &application->priv->menubar_path);
}
static void
gtk_application_window_added_x11 (GtkApplication *application,
GtkWindow *window)
{
- GtkApplicationWindowInfo *info;
-
- if (application->priv->session == NULL)
- return;
-
- if (!GTK_IS_APPLICATION_WINDOW (window))
+ if (application->priv->session_bus == NULL)
return;
- /* GtkApplicationWindow associates with us when it is first created,
- * so surely it's not realized yet...
- */
- g_assert (!gtk_widget_get_realized (GTK_WIDGET (window)));
+ if (GTK_IS_APPLICATION_WINDOW (window))
+ {
+ GtkApplicationWindow *app_window = GTK_APPLICATION_WINDOW (window);
+ gboolean success;
- /* ...but we want to know when it is. */
- g_signal_connect (window, "realize", G_CALLBACK (gtk_application_window_realized_x11), application);
+ /* GtkApplicationWindow associates with us when it is first created,
+ * so surely it's not realized yet...
+ */
+ g_assert (!gtk_widget_get_realized (GTK_WIDGET (window)));
- info = g_slice_new (GtkApplicationWindowInfo);
- do
- {
- gchar *window_path;
+ do
+ {
+ gchar *window_path;
+ guint window_id;
- info->window_id = application->priv->next_id++;
- window_path = g_strdup_printf ("%s%d", application->priv->window_prefix, info->window_id);
- info->action_export_id = g_dbus_connection_export_action_group (application->priv->session, window_path,
- G_ACTION_GROUP (window), NULL);
- g_free (window_path);
+ window_id = application->priv->next_id++;
+ window_path = g_strdup_printf ("%s/window/%u", application->priv->object_path, window_id);
+ success = gtk_application_window_publish (app_window, application->priv->session_bus, window_path, window_id);
+ g_free (window_path);
+ }
+ while (!success);
}
- while (!info->action_export_id);
-
- g_object_set_data (G_OBJECT (window), "GtkApplication::window-info", info);
}
static void
gtk_application_window_removed_x11 (GtkApplication *application,
GtkWindow *window)
{
- GtkApplicationWindowInfo *info;
-
- if (application->priv->session == NULL)
+ if (application->priv->session_bus == NULL)
return;
- if (!GTK_IS_APPLICATION_WINDOW (window))
- return;
+ if (GTK_IS_APPLICATION_WINDOW (window))
+ gtk_application_window_unpublish (GTK_APPLICATION_WINDOW (window));
+}
- info = g_object_steal_data (G_OBJECT (window), "GtkApplication::window-info");
+static void gtk_application_startup_session_dbus (GtkApplication *app);
- g_dbus_connection_unexport_action_group (application->priv->session, info->action_export_id);
+static void
+gtk_application_startup_x11 (GtkApplication *application)
+{
+ application->priv->session_bus = g_application_get_dbus_connection (G_APPLICATION (application));
+ application->priv->object_path = g_application_get_dbus_object_path (G_APPLICATION (application));
- g_slice_free (GtkApplicationWindowInfo, info);
+ gtk_application_startup_session_dbus (GTK_APPLICATION (application));
}
-static gchar *
-window_prefix_from_appid (const gchar *appid)
+static void
+gtk_application_shutdown_x11 (GtkApplication *application)
{
- gchar *appid_path, *iter;
+ gtk_application_set_app_menu_x11 (application, NULL);
+ gtk_application_set_menubar_x11 (application, NULL);
- appid_path = g_strconcat ("/", appid, "/windows/", NULL);
- for (iter = appid_path; *iter; iter++)
- {
- if (*iter == '.')
- *iter = '/';
+ application->priv->session_bus = NULL;
+ application->priv->object_path = NULL;
- if (*iter == '-')
- *iter = '_';
- }
-
- return appid_path;
+ g_clear_object (&application->priv->sm_proxy);
+ g_clear_object (&application->priv->client_proxy);
+ g_free (application->priv->app_id);
+ g_free (application->priv->client_path);
}
-static void
-gtk_application_startup_x11 (GtkApplication *application)
+const gchar *
+gtk_application_get_app_menu_object_path (GtkApplication *application)
{
- const gchar *application_id;
-
- application_id = g_application_get_application_id (G_APPLICATION (application));
- application->priv->session = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, NULL);
- application->priv->window_prefix = window_prefix_from_appid (application_id);
+ return application->priv->app_menu_path;
}
-static void
-gtk_application_shutdown_x11 (GtkApplication *application)
+const gchar *
+gtk_application_get_menubar_object_path (GtkApplication *application)
{
- g_free (application->priv->window_prefix);
- application->priv->window_prefix = NULL;
- application->priv->session = NULL;
+ return application->priv->menubar_path;
}
+
#endif
#ifdef GDK_WINDOWING_QUARTZ
+
+typedef struct {
+ guint cookie;
+ GtkApplicationInhibitFlags flags;
+ char *reason;
+ GtkWindow *window;
+} GtkApplicationQuartzInhibitor;
+
+static void
+gtk_application_quartz_inhibitor_free (GtkApplicationQuartzInhibitor *inhibitor)
+{
+ g_free (inhibitor->reason);
+ g_clear_object (&inhibitor->window);
+ g_slice_free (GtkApplicationQuartzInhibitor, inhibitor);
+}
+
static void
gtk_application_menu_changed_quartz (GObject *object,
GParamSpec *pspec,
GMenu *combined;
combined = g_menu_new ();
- g_menu_append_submenu (combined, "Application", g_application_get_app_menu (G_APPLICATION (object)));
- g_menu_append_section (combined, NULL, g_application_get_menubar (G_APPLICATION (object)));
+ g_menu_append_submenu (combined, "Application", gtk_application_get_app_menu (application));
+ g_menu_append_section (combined, NULL, gtk_application_get_menubar (application));
- gtk_quartz_set_main_menu (G_MENU_MODEL (combined), G_ACTION_OBSERVABLE (application->priv->muxer));
+ gtk_quartz_set_main_menu (G_MENU_MODEL (combined), application);
+
+ g_object_unref (combined);
}
+static void gtk_application_startup_session_quartz (GtkApplication *app);
+
static void
gtk_application_startup_quartz (GtkApplication *application)
{
[NSApp finishLaunching];
- application->priv->muxer = g_action_muxer_new ();
- g_action_muxer_insert (application->priv->muxer, "app", G_ACTION_GROUP (application));
-
g_signal_connect (application, "notify::app-menu", G_CALLBACK (gtk_application_menu_changed_quartz), NULL);
g_signal_connect (application, "notify::menubar", G_CALLBACK (gtk_application_menu_changed_quartz), NULL);
gtk_application_menu_changed_quartz (G_OBJECT (application), NULL, NULL);
+
+ gtk_application_startup_session_quartz (application);
}
static void
gtk_application_shutdown_quartz (GtkApplication *application)
{
- g_signal_handlers_disconnect_by_func (application, gtk_application_menu_changed_quartz, NULL);
+ gtk_quartz_clear_main_menu ();
- g_object_unref (application->priv->muxer);
- application->priv->muxer = NULL;
-}
+ g_signal_handlers_disconnect_by_func (application, gtk_application_menu_changed_quartz, NULL);
-static void
-gtk_application_focus_changed (GtkApplication *application,
- GtkWindow *window)
-{
- if (G_IS_ACTION_GROUP (window))
- g_action_muxer_insert (application->priv->muxer, "win", G_ACTION_GROUP (window));
- else
- g_action_muxer_remove (application->priv->muxer, "win");
+ g_slist_free_full (application->priv->inhibitors,
+ (GDestroyNotify) gtk_application_quartz_inhibitor_free);
+ application->priv->inhibitors = NULL;
}
#endif
priv->windows = g_list_concat (link, priv->windows);
}
-#ifdef GDK_WINDOWING_QUARTZ
- gtk_application_focus_changed (application, window);
-#endif
+ g_object_notify (G_OBJECT (application), "active-window");
return FALSE;
}
gtk_application_shutdown_quartz (GTK_APPLICATION (application));
#endif
+ /* Keep this section in sync with gtk_main() */
+
+ /* Try storing all clipboard data we have */
+ _gtk_clipboard_store_all ();
+
+ /* Synchronize the recent manager singleton */
+ _gtk_recent_manager_sync ();
+
+ _gtk_accessibility_shutdown ();
+
G_APPLICATION_CLASS (gtk_application_parent_class)
->shutdown (application);
}
const gchar *key;
GVariant *value;
+ gdk_threads_enter ();
+
g_variant_iter_init (&iter, platform_data);
while (g_variant_iter_loop (&iter, "{&sv}", &key, &value))
{
display = gdk_display_get_default ();
id = g_variant_get_string (value, NULL);
- gdk_x11_display_set_startup_notification_id (display, id);
+ if (GDK_IS_X11_DISPLAY (display))
+ gdk_x11_display_set_startup_notification_id (display, id);
}
#endif
}
GVariant *platform_data)
{
gdk_notify_startup_complete ();
+
+ gdk_threads_leave ();
}
static void
application->priv = G_TYPE_INSTANCE_GET_PRIVATE (application,
GTK_TYPE_APPLICATION,
GtkApplicationPrivate);
+
+#ifdef GDK_WINDOWING_X11
+ application->priv->next_id = 1;
+#endif
}
static void
#ifdef GDK_WINDOWING_X11
gtk_application_window_added_x11 (application, window);
#endif
+
+ g_object_notify (G_OBJECT (application), "active-window");
}
static void
GtkWindow *window)
{
GtkApplicationPrivate *priv = application->priv;
+ gpointer old_active;
+
+ old_active = priv->windows;
#ifdef GDK_WINDOWING_X11
gtk_application_window_removed_x11 (application, window);
g_application_release (G_APPLICATION (application));
priv->windows = g_list_remove (priv->windows, window);
gtk_window_set_application (window, NULL);
+
+ if (priv->windows != old_active)
+ g_object_notify (G_OBJECT (application), "active-window");
}
static void
}
static void
-gtk_application_notify (GObject *object,
- GParamSpec *pspec)
+gtk_application_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
{
- if (strcmp (pspec->name, "app-menu") == 0 ||
- strcmp (pspec->name, "menubar") == 0)
+ GtkApplication *application = GTK_APPLICATION (object);
+
+ switch (prop_id)
{
- GMenuModel *model;
- g_object_get (object, pspec->name, &model, NULL);
- if (model)
- {
- extract_accels_from_menu (model, GTK_APPLICATION (object));
- g_object_unref (model);
- }
+ case PROP_REGISTER_SESSION:
+ g_value_set_boolean (value, application->priv->register_session);
+ break;
+
+ case PROP_APP_MENU:
+ g_value_set_object (value, gtk_application_get_app_menu (application));
+ break;
+
+ case PROP_MENUBAR:
+ g_value_set_object (value, gtk_application_get_menubar (application));
+ break;
+
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
}
+}
+
+static void
+gtk_application_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec)
+{
+ GtkApplication *application = GTK_APPLICATION (object);
+
+ switch (prop_id)
+ {
+ case PROP_REGISTER_SESSION:
+ application->priv->register_session = g_value_get_boolean (value);
+ break;
+
+ case PROP_APP_MENU:
+ gtk_application_set_app_menu (application, g_value_get_object (value));
+ break;
+
+ case PROP_MENUBAR:
+ gtk_application_set_menubar (application, g_value_get_object (value));
+ break;
+
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
- if (G_OBJECT_CLASS (gtk_application_parent_class)->notify)
- G_OBJECT_CLASS (gtk_application_parent_class)->notify (object, pspec);
+static void
+gtk_application_finalize (GObject *object)
+{
+ GtkApplication *application = GTK_APPLICATION (object);
+
+ g_clear_object (&application->priv->app_menu);
+ g_clear_object (&application->priv->menubar);
+
+ G_OBJECT_CLASS (gtk_application_parent_class)
+ ->finalize (object);
}
static void
GObjectClass *object_class = G_OBJECT_CLASS (class);
GApplicationClass *application_class = G_APPLICATION_CLASS (class);
- object_class->notify = gtk_application_notify;
+ object_class->get_property = gtk_application_get_property;
+ object_class->set_property = gtk_application_set_property;
+ object_class->finalize = gtk_application_finalize;
application_class->add_platform_data = gtk_application_add_platform_data;
application_class->before_emit = gtk_application_before_emit;
NULL, NULL,
g_cclosure_marshal_VOID__OBJECT,
G_TYPE_NONE, 1, GTK_TYPE_WINDOW);
+
+ /**
+ * GtkApplication:register-session:
+ *
+ * Set this property to %TRUE to register with the session manager.
+ *
+ * Since: 3.4
+ */
+ g_object_class_install_property (object_class, PROP_REGISTER_SESSION,
+ g_param_spec_boolean ("register-session",
+ P_("Register session"),
+ P_("Register with the session manager"),
+ FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+
+ g_object_class_install_property (object_class, PROP_APP_MENU,
+ g_param_spec_object ("app-menu",
+ P_("Application menu"),
+ P_("The GMenuModel for the application menu"),
+ G_TYPE_MENU_MODEL,
+ G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+
+ g_object_class_install_property (object_class, PROP_MENUBAR,
+ g_param_spec_object ("menubar",
+ P_("Menubar"),
+ P_("The GMenuModel for the menubar"),
+ G_TYPE_MENU_MODEL,
+ G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+
+ g_object_class_install_property (object_class, PROP_ACTIVE_WINDOW,
+ g_param_spec_object ("active-window",
+ P_("Active window"),
+ P_("The window which most recently had focus"),
+ GTK_TYPE_WINDOW,
+ G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
}
/**
* gtk_application_new:
- * @application_id: the application id
+ * @application_id: (allow-none): The application ID.
* @flags: the application flags
*
* Creates a new #GtkApplication instance.
*
- * This function calls g_type_init() for you. gtk_init() is called
- * as soon as the application gets registered as the primary instance.
+ * When using #GtkApplication, it is not necessary to call gtk_init()
+ * manually. It is called as soon as the application gets registered as
+ * the primary instance.
+ *
+ * Concretely, gtk_init() is called in the default handler for the
+ * #GApplication::startup signal. Therefore, #GtkApplication subclasses should
+ * chain up in their #GApplication:startup handler before using any GTK+ API.
+ *
+ * Note that commandline arguments are not passed to gtk_init().
+ * All GTK+ functionality that is available via commandline arguments
+ * can also be achieved by setting suitable environment variables
+ * such as <envar>G_DEBUG</envar>, so this should not be a big
+ * problem. If you absolutely must support GTK+ commandline arguments,
+ * you can explicitly call gtk_init() before creating the application
+ * instance.
+ *
+ * If non-%NULL, the application ID must be valid. See
+ * g_application_id_is_valid().
*
- * The application id must be valid. See g_application_id_is_valid().
+ * If no application ID is given then some features (most notably application
+ * uniqueness) will be disabled. A null application ID is only allowed with
+ * GTK+ 3.6 or later.
*
* Returns: a new #GtkApplication instance
+ *
+ * Since: 3.0
*/
GtkApplication *
gtk_application_new (const gchar *application_id,
GApplicationFlags flags)
{
- g_return_val_if_fail (g_application_id_is_valid (application_id), NULL);
-
- g_type_init ();
+ g_return_val_if_fail (application_id == NULL || g_application_id_is_valid (application_id), NULL);
return g_object_new (GTK_TYPE_APPLICATION,
"application-id", application_id,
* @application: a #GtkApplication
* @window: a #GtkWindow
*
- * Adds a window from @application.
+ * Adds a window to @application.
*
* This call is equivalent to setting the #GtkWindow:application
* property of @window to @application.
return application->priv->windows;
}
+/**
+ * gtk_application_get_window_by_id:
+ * @application: a #GtkApplication
+ * @id: an identifier number
+ *
+ * Returns the #GtkApplicationWindow with the given ID.
+ *
+ * Returns: (transfer none): the window with ID @id, or
+ * %NULL if there is no window with this ID
+ *
+ * Since: 3.6
+ */
+GtkWindow *
+gtk_application_get_window_by_id (GtkApplication *application,
+ guint id)
+{
+ GList *l;
+
+ g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
+
+ for (l = application->priv->windows; l != NULL; l = l->next)
+ {
+ if (GTK_IS_APPLICATION_WINDOW (l->data) &&
+ gtk_application_window_get_id (GTK_APPLICATION_WINDOW (l->data)) == id)
+ return l->data;
+ }
+
+ return NULL;
+}
+
+/**
+ * gtk_application_get_active_window:
+ * @application: a #GtkApplication
+ *
+ * Gets the "active" window for the application.
+ *
+ * The active window is the one that was most recently focused (within
+ * the application). This window may not have the focus at the moment
+ * if another application has it -- this is just the most
+ * recently-focused window within this application.
+ *
+ * Returns: (transfer none): the active window
+ *
+ * Since: 3.6
+ **/
+GtkWindow *
+gtk_application_get_active_window (GtkApplication *application)
+{
+ g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
+
+ return application->priv->windows ? application->priv->windows->data : NULL;
+}
+
/**
* gtk_application_add_accelerator:
* @application: a #GtkApplication
* is pressed.
*
* @accelerator must be a string that can be parsed by
- * gtk_accelerator_parse(), e.g. "<Primary>q" or "<Control><Alt>p".
+ * gtk_accelerator_parse(), e.g. "<Primary>q" or
+ * "<Control><Alt>p".
*
* @action_name must be the name of an action as it would be used
* in the app menu, i.e. actions that have been added to the application
* with a "win." prefix.
*
* GtkApplication also extracts accelerators out of 'accel' attributes
- * in the #GMenuModels passed to g_application_set_app_menu() and
- * g_application_set_menubar(), which is usually more convenient
+ * in the #GMenuModels passed to gtk_application_set_app_menu() and
+ * gtk_application_set_menubar(), which is usually more convenient
* than calling this function for each accelerator.
*
* Since: 3.4
gtk_accel_map_change_entry (accel_path, 0, 0, FALSE);
g_free (accel_path);
}
+
+/**
+ * gtk_application_set_app_menu:
+ * @application: a #GtkApplication
+ * @app_menu: (allow-none): a #GMenuModel, or %NULL
+ *
+ * Sets or unsets the application menu for @application.
+ *
+ * This can only be done in the primary instance of the application,
+ * after it has been registered. #GApplication:startup is a good place
+ * to call this.
+ *
+ * The application menu is a single menu containing items that typically
+ * impact the application as a whole, rather than acting on a specific
+ * window or document. For example, you would expect to see
+ * "Preferences" or "Quit" in an application menu, but not "Save" or
+ * "Print".
+ *
+ * If supported, the application menu will be rendered by the desktop
+ * environment.
+ *
+ * Use the base #GActionMap interface to add actions, to respond to the user
+ * selecting these menu items.
+ *
+ * Since: 3.4
+ */
+void
+gtk_application_set_app_menu (GtkApplication *application,
+ GMenuModel *app_menu)
+{
+ g_return_if_fail (GTK_IS_APPLICATION (application));
+ g_return_if_fail (g_application_get_is_registered (G_APPLICATION (application)));
+ g_return_if_fail (!g_application_get_is_remote (G_APPLICATION (application)));
+
+ if (app_menu != application->priv->app_menu)
+ {
+ if (application->priv->app_menu != NULL)
+ g_object_unref (application->priv->app_menu);
+
+ application->priv->app_menu = app_menu;
+
+ if (application->priv->app_menu != NULL)
+ g_object_ref (application->priv->app_menu);
+
+ if (app_menu)
+ extract_accels_from_menu (app_menu, application);
+
+#ifdef GDK_WINDOWING_X11
+ gtk_application_set_app_menu_x11 (application, app_menu);
+#endif
+
+ g_object_notify (G_OBJECT (application), "app-menu");
+ }
+}
+
+/**
+ * gtk_application_get_app_menu:
+ * @application: a #GtkApplication
+ *
+ * Returns the menu model that has been set with
+ * gtk_application_set_app_menu().
+ *
+ * Returns: (transfer none): the application menu of @application
+ *
+ * Since: 3.4
+ */
+GMenuModel *
+gtk_application_get_app_menu (GtkApplication *application)
+{
+ g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
+
+ return application->priv->app_menu;
+}
+
+/**
+ * gtk_application_set_menubar:
+ * @application: a #GtkApplication
+ * @menubar: (allow-none): a #GMenuModel, or %NULL
+ *
+ * Sets or unsets the menubar for windows of @application.
+ *
+ * This is a menubar in the traditional sense.
+ *
+ * This can only be done in the primary instance of the application,
+ * after it has been registered. #GApplication:startup is a good place
+ * to call this.
+ *
+ * Depending on the desktop environment, this may appear at the top of
+ * each window, or at the top of the screen. In some environments, if
+ * both the application menu and the menubar are set, the application
+ * menu will be presented as if it were the first item of the menubar.
+ * Other environments treat the two as completely separate -- for
+ * example, the application menu may be rendered by the desktop shell
+ * while the menubar (if set) remains in each individual window.
+ *
+ * Use the base #GActionMap interface to add actions, to respond to the user
+ * selecting these menu items.
+ *
+ * Since: 3.4
+ */
+void
+gtk_application_set_menubar (GtkApplication *application,
+ GMenuModel *menubar)
+{
+ g_return_if_fail (GTK_IS_APPLICATION (application));
+ g_return_if_fail (g_application_get_is_registered (G_APPLICATION (application)));
+ g_return_if_fail (!g_application_get_is_remote (G_APPLICATION (application)));
+
+ if (menubar != application->priv->menubar)
+ {
+ if (application->priv->menubar != NULL)
+ g_object_unref (application->priv->menubar);
+
+ application->priv->menubar = menubar;
+
+ if (application->priv->menubar != NULL)
+ g_object_ref (application->priv->menubar);
+
+ if (menubar)
+ extract_accels_from_menu (menubar, application);
+
+#ifdef GDK_WINDOWING_X11
+ gtk_application_set_menubar_x11 (application, menubar);
+#endif
+
+ g_object_notify (G_OBJECT (application), "menubar");
+ }
+}
+
+/**
+ * gtk_application_get_menubar:
+ * @application: a #GtkApplication
+ *
+ * Returns the menu model that has been set with
+ * gtk_application_set_menubar().
+ *
+ * Returns: (transfer none): the menubar for windows of @application
+ *
+ * Since: 3.4
+ */
+GMenuModel *
+gtk_application_get_menubar (GtkApplication *application)
+{
+ g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
+
+ return application->priv->menubar;
+}
+
+#if defined(GDK_WINDOWING_X11)
+
+/* D-Bus Session Management
+ *
+ * The protocol and the D-Bus API are described here:
+ * http://live.gnome.org/SessionManagement/GnomeSession
+ * http://people.gnome.org/~mccann/gnome-session/docs/gnome-session.html
+ */
+
+static void
+unregister_client (GtkApplication *app)
+{
+ GError *error = NULL;
+
+ g_debug ("Unregistering client");
+
+ g_dbus_proxy_call_sync (app->priv->sm_proxy,
+ "UnregisterClient",
+ g_variant_new ("(o)", app->priv->client_path),
+ G_DBUS_CALL_FLAGS_NONE,
+ G_MAXINT,
+ NULL,
+ &error);
+
+ if (error)
+ {
+ g_warning ("Failed to unregister client: %s", error->message);
+ g_error_free (error);
+ }
+
+ g_clear_object (&app->priv->client_proxy);
+
+ g_free (app->priv->client_path);
+ app->priv->client_path = NULL;
+}
+
+static void
+gtk_application_quit_response (GtkApplication *application,
+ gboolean will_quit,
+ const gchar *reason)
+{
+ g_debug ("Calling EndSessionResponse %d '%s'", will_quit, reason);
+
+ g_dbus_proxy_call (application->priv->client_proxy,
+ "EndSessionResponse",
+ g_variant_new ("(bs)", will_quit, reason ? reason : ""),
+ G_DBUS_CALL_FLAGS_NONE,
+ G_MAXINT,
+ NULL, NULL, NULL);
+}
+static void
+client_proxy_signal (GDBusProxy *proxy,
+ const gchar *sender_name,
+ const gchar *signal_name,
+ GVariant *parameters,
+ GtkApplication *app)
+{
+ if (strcmp (signal_name, "QueryEndSession") == 0)
+ {
+ g_debug ("Received QueryEndSession");
+ gtk_application_quit_response (app, TRUE, NULL);
+ }
+ else if (strcmp (signal_name, "CancelEndSession") == 0)
+ {
+ g_debug ("Received CancelEndSession");
+ }
+ else if (strcmp (signal_name, "EndSession") == 0)
+ {
+ g_debug ("Received EndSession");
+ gtk_application_quit_response (app, TRUE, NULL);
+ unregister_client (app);
+ g_application_quit (G_APPLICATION (app));
+ }
+ else if (strcmp (signal_name, "Stop") == 0)
+ {
+ g_debug ("Received Stop");
+ unregister_client (app);
+ g_application_quit (G_APPLICATION (app));
+ }
+}
+
+static void
+gtk_application_startup_session_dbus (GtkApplication *app)
+{
+ static gchar *client_id;
+ GError *error = NULL;
+ GVariant *res;
+
+ if (app->priv->session_bus == NULL)
+ return;
+
+ if (client_id == NULL)
+ {
+ const gchar *desktop_autostart_id;
+
+ desktop_autostart_id = g_getenv ("DESKTOP_AUTOSTART_ID");
+ /* Unset DESKTOP_AUTOSTART_ID in order to avoid child processes to
+ * use the same client id.
+ */
+ g_unsetenv ("DESKTOP_AUTOSTART_ID");
+ client_id = g_strdup (desktop_autostart_id ? desktop_autostart_id : "");
+ }
+
+ g_debug ("Connecting to session manager");
+
+ app->priv->sm_proxy = g_dbus_proxy_new_sync (app->priv->session_bus,
+ G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES |
+ G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS,
+ NULL,
+ "org.gnome.SessionManager",
+ "/org/gnome/SessionManager",
+ "org.gnome.SessionManager",
+ NULL,
+ &error);
+ if (error)
+ {
+ g_warning ("Failed to get a session proxy: %s", error->message);
+ g_error_free (error);
+ return;
+ }
+
+ /* FIXME: should we reuse the D-Bus application id here ? */
+ app->priv->app_id = g_strdup (g_get_prgname ());
+
+ if (!app->priv->register_session)
+ return;
+
+ g_debug ("Registering client '%s' '%s'", app->priv->app_id, client_id);
+
+ res = g_dbus_proxy_call_sync (app->priv->sm_proxy,
+ "RegisterClient",
+ g_variant_new ("(ss)", app->priv->app_id, client_id),
+ G_DBUS_CALL_FLAGS_NONE,
+ G_MAXINT,
+ NULL,
+ &error);
+
+ if (error)
+ {
+ g_warning ("Failed to register client: %s", error->message);
+ g_error_free (error);
+ g_clear_object (&app->priv->sm_proxy);
+ return;
+ }
+
+ g_variant_get (res, "(o)", &app->priv->client_path);
+ g_variant_unref (res);
+
+ g_debug ("Registered client at '%s'", app->priv->client_path);
+
+ app->priv->client_proxy = g_dbus_proxy_new_sync (app->priv->session_bus, 0,
+ NULL,
+ "org.gnome.SessionManager",
+ app->priv->client_path,
+ "org.gnome.SessionManager.ClientPrivate",
+ NULL,
+ &error);
+ if (error)
+ {
+ g_warning ("Failed to get client proxy: %s", error->message);
+ g_error_free (error);
+ g_clear_object (&app->priv->sm_proxy);
+ g_free (app->priv->client_path);
+ app->priv->client_path = NULL;
+ return;
+ }
+
+ g_signal_connect (app->priv->client_proxy, "g-signal", G_CALLBACK (client_proxy_signal), app);
+}
+
+
+
+/**
+ * GtkApplicationInhibitFlags:
+ * @GTK_APPLICATION_INHIBIT_LOGOUT: Inhibit ending the user session
+ * by logging out or by shutting down the computer
+ * @GTK_APPLICATION_INHIBIT_SWITCH: Inhibit user switching
+ * @GTK_APPLICATION_INHIBIT_SUSPEND: Inhibit suspending the
+ * session or computer
+ * @GTK_APPLICATION_INHIBIT_IDLE: Inhibit the session being
+ * marked as idle (and possibly locked)
+ *
+ * Types of user actions that may be blocked by gtk_application_inhibit().
+ *
+ * Since: 3.4
+ */
+
+/**
+ * gtk_application_inhibit:
+ * @application: the #GApplication
+ * @window: (allow-none): a #GtkWindow, or %NULL
+ * @flags: what types of actions should be inhibited
+ * @reason: (allow-none): a short, human-readable string that explains
+ * why these operations are inhibited
+ *
+ * Inform the session manager that certain types of actions should be
+ * inhibited. This is not guaranteed to work on all platforms and for
+ * all types of actions.
+ *
+ * Applications should invoke this method when they begin an operation
+ * that should not be interrupted, such as creating a CD or DVD. The
+ * types of actions that may be blocked are specified by the @flags
+ * parameter. When the application completes the operation it should
+ * call gtk_application_uninhibit() to remove the inhibitor. Note that
+ * an application can have multiple inhibitors, and all of the must
+ * be individually removed. Inhibitors are also cleared when the
+ * application exits.
+ *
+ * Applications should not expect that they will always be able to block
+ * the action. In most cases, users will be given the option to force
+ * the action to take place.
+ *
+ * Reasons should be short and to the point.
+ *
+ * If @window is given, the session manager may point the user to
+ * this window to find out more about why the action is inhibited.
+ *
+ * Returns: A non-zero cookie that is used to uniquely identify this
+ * request. It should be used as an argument to gtk_application_uninhibit()
+ * in order to remove the request. If the platform does not support
+ * inhibiting or the request failed for some reason, 0 is returned.
+ *
+ * Since: 3.4
+ */
+guint
+gtk_application_inhibit (GtkApplication *application,
+ GtkWindow *window,
+ GtkApplicationInhibitFlags flags,
+ const gchar *reason)
+{
+ GVariant *res;
+ GError *error = NULL;
+ guint cookie;
+ guint xid = 0;
+
+ g_return_val_if_fail (GTK_IS_APPLICATION (application), 0);
+ g_return_val_if_fail (!g_application_get_is_remote (G_APPLICATION (application)), 0);
+ g_return_val_if_fail (application->priv->sm_proxy != NULL, 0);
+
+ if (window != NULL)
+ {
+ GdkWindow *gdkwindow;
+
+ gdkwindow = gtk_widget_get_window (GTK_WIDGET (window));
+ if (gdkwindow == NULL)
+ g_warning ("Inhibit called with an unrealized window");
+#ifdef GDK_WINDOWING_X11
+ else if (GDK_IS_X11_WINDOW (gdkwindow))
+ xid = GDK_WINDOW_XID (gdkwindow);
+#endif
+ }
+
+ res = g_dbus_proxy_call_sync (application->priv->sm_proxy,
+ "Inhibit",
+ g_variant_new ("(susu)",
+ application->priv->app_id,
+ xid,
+ reason,
+ flags),
+ G_DBUS_CALL_FLAGS_NONE,
+ G_MAXINT,
+ NULL,
+ &error);
+ if (error)
+ {
+ g_warning ("Calling Inhibit failed: %s", error->message);
+ g_error_free (error);
+ return 0;
+ }
+
+ g_variant_get (res, "(u)", &cookie);
+ g_variant_unref (res);
+
+ return cookie;
+}
+
+/**
+ * gtk_application_uninhibit:
+ * @application: the #GApplication
+ * @cookie: a cookie that was returned by gtk_application_inhibit()
+ *
+ * Removes an inhibitor that has been established with gtk_application_inhibit().
+ * Inhibitors are also cleared when the application exits.
+ *
+ * Since: 3.4
+ */
+void
+gtk_application_uninhibit (GtkApplication *application,
+ guint cookie)
+{
+ g_return_if_fail (GTK_IS_APPLICATION (application));
+ g_return_if_fail (!g_application_get_is_remote (G_APPLICATION (application)));
+ g_return_if_fail (application->priv->sm_proxy != NULL);
+
+ g_dbus_proxy_call (application->priv->sm_proxy,
+ "Uninhibit",
+ g_variant_new ("(u)", cookie),
+ G_DBUS_CALL_FLAGS_NONE,
+ G_MAXINT,
+ NULL, NULL, NULL);
+}
+
+/**
+ * gtk_application_is_inhibited:
+ * @application: the #GApplication
+ * @flags: what types of actions should be queried
+ *
+ * Determines if any of the actions specified in @flags are
+ * currently inhibited (possibly by another application).
+ *
+ * Returns: %TRUE if any of the actions specified in @flags are inhibited
+ *
+ * Since: 3.4
+ */
+gboolean
+gtk_application_is_inhibited (GtkApplication *application,
+ GtkApplicationInhibitFlags flags)
+{
+ GVariant *res;
+ GError *error = NULL;
+ gboolean inhibited;
+
+ g_return_val_if_fail (GTK_IS_APPLICATION (application), FALSE);
+ g_return_val_if_fail (!g_application_get_is_remote (G_APPLICATION (application)), FALSE);
+ g_return_val_if_fail (application->priv->sm_proxy != NULL, FALSE);
+
+ res = g_dbus_proxy_call_sync (application->priv->sm_proxy,
+ "IsInhibited",
+ g_variant_new ("(u)", flags),
+ G_DBUS_CALL_FLAGS_NONE,
+ G_MAXINT,
+ NULL,
+ &error);
+ if (error)
+ {
+ g_warning ("Calling IsInhibited failed: %s", error->message);
+ g_error_free (error);
+ return FALSE;
+ }
+
+ g_variant_get (res, "(b)", &inhibited);
+ g_variant_unref (res);
+
+ return inhibited;
+}
+
+#elif defined(GDK_WINDOWING_QUARTZ)
+
+/* OS X implementation copied from EggSMClient, but simplified since
+ * it doesn't need to interact with the user.
+ */
+
+static gboolean
+idle_will_quit (gpointer data)
+{
+ GtkApplication *app = data;
+
+ if (app->priv->quit_inhibit == 0)
+ g_application_quit (G_APPLICATION (app));
+ else
+ {
+ GtkApplicationQuartzInhibitor *inhibitor;
+ GSList *iter;
+ GtkWidget *dialog;
+
+ for (iter = app->priv->inhibitors; iter; iter = iter->next)
+ {
+ inhibitor = iter->data;
+ if (inhibitor->flags & GTK_APPLICATION_INHIBIT_LOGOUT)
+ break;
+ }
+ g_assert (inhibitor != NULL);
+
+ dialog = gtk_message_dialog_new (inhibitor->window,
+ GTK_DIALOG_MODAL,
+ GTK_MESSAGE_ERROR,
+ GTK_BUTTONS_OK,
+ _("%s cannot quit at this time:\n\n%s"),
+ g_get_application_name (),
+ inhibitor->reason);
+ g_signal_connect_swapped (dialog,
+ "response",
+ G_CALLBACK (gtk_widget_destroy),
+ dialog);
+ gtk_widget_show_all (dialog);
+ }
+
+ return G_SOURCE_REMOVE;
+}
+
+static pascal OSErr
+quit_requested (const AppleEvent *aevt,
+ AppleEvent *reply,
+ long refcon)
+{
+ GtkApplication *app = GSIZE_TO_POINTER ((gsize)refcon);
+
+ /* Don't emit the "quit" signal immediately, since we're
+ * called from a weird point in the guts of gdkeventloop-quartz.c
+ */
+ g_idle_add_full (G_PRIORITY_DEFAULT, idle_will_quit, app, NULL);
+
+ return app->priv->quit_inhibit == 0 ? noErr : userCanceledErr;
+}
+
+static void
+gtk_application_startup_session_quartz (GtkApplication *app)
+{
+ if (app->priv->register_session)
+ AEInstallEventHandler (kCoreEventClass, kAEQuitApplication,
+ NewAEEventHandlerUPP (quit_requested),
+ (long)GPOINTER_TO_SIZE (app), false);
+}
+
+guint
+gtk_application_inhibit (GtkApplication *application,
+ GtkWindow *window,
+ GtkApplicationInhibitFlags flags,
+ const gchar *reason)
+{
+ GtkApplicationQuartzInhibitor *inhibitor;
+
+ g_return_val_if_fail (GTK_IS_APPLICATION (application), 0);
+ g_return_val_if_fail (flags != 0, 0);
+
+ inhibitor = g_slice_new (GtkApplicationQuartzInhibitor);
+ inhibitor->cookie = ++application->priv->next_cookie;
+ inhibitor->flags = flags;
+ inhibitor->reason = g_strdup (reason);
+ inhibitor->window = window ? g_object_ref (window) : NULL;
+
+ application->priv->inhibitors = g_slist_prepend (application->priv->inhibitors, inhibitor);
+
+ if (flags & GTK_APPLICATION_INHIBIT_LOGOUT)
+ application->priv->quit_inhibit++;
+
+ return inhibitor->cookie;
+}
+
+void
+gtk_application_uninhibit (GtkApplication *application,
+ guint cookie)
+{
+ GSList *iter;
+
+ for (iter = application->priv->inhibitors; iter; iter = iter->next)
+ {
+ GtkApplicationQuartzInhibitor *inhibitor = iter->data;
+
+ if (inhibitor->cookie == cookie)
+ {
+ if (inhibitor->flags & GTK_APPLICATION_INHIBIT_LOGOUT)
+ application->priv->quit_inhibit--;
+ gtk_application_quartz_inhibitor_free (inhibitor);
+ application->priv->inhibitors = g_slist_delete_link (application->priv->inhibitors, iter);
+ return;
+ }
+ }
+
+ g_warning ("Invalid inhibitor cookie");
+}
+
+gboolean
+gtk_application_is_inhibited (GtkApplication *application,
+ GtkApplicationInhibitFlags flags)
+{
+ if (flags & GTK_APPLICATION_INHIBIT_LOGOUT)
+ return application->priv->quit_inhibit > 0;
+
+ return FALSE;
+}
+
+#else
+
+/* Trivial implementation.
+ *
+ * For the inhibit API on Windows, see
+ * http://msdn.microsoft.com/en-us/library/ms700677%28VS.85%29.aspx
+ */
+
+guint
+gtk_application_inhibit (GtkApplication *application,
+ GtkWindow *window,
+ GtkApplicationInhibitFlags flags,
+ const gchar *reason)
+{
+ return 0;
+}
+
+void
+gtk_application_uninhibit (GtkApplication *application,
+ guint cookie)
+{
+}
+
+gboolean
+gtk_application_is_inhibited (GtkApplication *application,
+ GtkApplicationInhibitFlags flags)
+{
+ return FALSE;
+}
+
+#endif
projects / ~andy / gtk / blobdiff