Pileus Git - ~andy/gtk/blob - gtk/gtkapplication.c

   1 /*
   2  * Copyright © 2010 Codethink Limited
   3  *
   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.
   8  *
   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.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  *
  19  * Author: Ryan Lortie <desrt@desrt.ca>
  20  */
  21
  22 #include "config.h"
  23
  24 #include <stdlib.h>
  25 #include <unistd.h>
  26 #include <string.h>
  27
  28 #include "gtkapplication.h"
  29 #include "gtkmarshalers.h"
  30 #include "gtkwindow.h"
  31 #include "gtkmain.h"
  32
  33 #include <gdk/gdk.h>
  34 #ifdef GDK_WINDOWING_X11
  35 #include <gdk/x11/gdkx.h>
  36 #endif
  37
  38 /**
  39  * SECTION:gtkapplication
  40  * @title: GtkApplication
  41  * @short_description: Application class
  42  *
  43  * #GtkApplication is a class that handles many important aspects
  44  * of a GTK+ application in a convenient fashion, without enforcing
  45  * a one-size-fits-all application model.
  46  *
  47  * Currently, GtkApplication handles GTK+ initialization, application
  48  * uniqueness, provides some basic scriptability by exporting 'actions',
  49  * implements some standard actions itself (such as 'Quit') and manages
  50  * a list of toplevel windows whose life-cycle is automatically tied to
  51  * the life-cycle of your application.
  52  *
  53  * <example id="gtkapplication"><title>A simple application</title>
  54  * <programlisting>
  55  * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gtk/tests/gtk-example-application.c">
  56  *  <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
  57  * </xi:include>
  58  * </programlisting>
  59  * </example>
  60  */
  61
  62 G_DEFINE_TYPE (GtkApplication, gtk_application, G_TYPE_APPLICATION)
  63
  64 struct _GtkApplicationPrivate
  65 {
  66   GList *windows;
  67 };
  68
  69 static void
  70 gtk_application_startup (GApplication *application)
  71 {
  72   gtk_init (0, 0);
  73 }
  74
  75 static void
  76 gtk_application_quit_mainloop (GApplication *application)
  77 {
  78   gtk_main_quit ();
  79 }
  80
  81 static void
  82 gtk_application_run_mainloop (GApplication *application)
  83 {
  84   gtk_main ();
  85 }
  86
  87 static void
  88 gtk_application_add_platform_data (GApplication    *application,
  89                                    GVariantBuilder *builder)
  90 {
  91   const gchar *startup_id;
  92
  93   startup_id = getenv ("DESKTOP_STARTUP_ID");
  94
  95   if (startup_id && g_utf8_validate (startup_id, -1, NULL))
  96     g_variant_builder_add (builder, "{sv}", "desktop-startup-id",
  97                            g_variant_new_string (startup_id));
  98 }
  99
 100 static void
 101 gtk_application_before_emit (GApplication *application,
 102                              GVariant     *platform_data)
 103 {
 104   GVariantIter iter;
 105   const gchar *key;
 106   GVariant *value;
 107
 108   g_variant_iter_init (&iter, platform_data);
 109   while (g_variant_iter_loop (&iter, "{&sv}", &key, &value))
 110     {
 111       if (strcmp (key, "desktop-startup-id") == 0)
 112         {
 113           GdkDisplay *display;
 114           const gchar *id;
 115
 116           display = gdk_display_get_default ();
 117           id = g_variant_get_string (value, NULL);
 118           gdk_x11_display_set_startup_notification_id (display, id);
 119        }
 120     }
 121 }
 122
 123 static void
 124 gtk_application_after_emit (GApplication *application,
 125                             GVariant     *platform_data)
 126 {
 127   gdk_notify_startup_complete ();
 128 }
 129
 130 static void
 131 gtk_application_init (GtkApplication *application)
 132 {
 133   application->priv = G_TYPE_INSTANCE_GET_PRIVATE (application,
 134                                                    GTK_TYPE_APPLICATION,
 135                                                    GtkApplicationPrivate);
 136 }
 137
 138 static void
 139 gtk_application_class_init (GtkApplicationClass *class)
 140 {
 141   GApplicationClass *application_class = G_APPLICATION_CLASS (class);
 142
 143   application_class->add_platform_data = gtk_application_add_platform_data;
 144   application_class->before_emit = gtk_application_before_emit;
 145   application_class->after_emit = gtk_application_after_emit;
 146   application_class->startup = gtk_application_startup;
 147
 148   application_class->quit_mainloop = gtk_application_quit_mainloop;
 149   application_class->run_mainloop = gtk_application_run_mainloop;
 150
 151   g_type_class_add_private (class, sizeof (GtkApplicationPrivate));
 152 }
 153
 154 /**
 155  * gtk_application_new:
 156  * @application_id: the application id
 157  * @flags: the application flags
 158  *
 159  * Creates a new #GtkApplication instance.
 160  *
 161  * This function calls g_type_init() for you. gtk_init() is called
 162  * as soon as the application gets registered as the primary instance.
 163  *
 164  * The application id must be valid. See g_application_id_is_valid().
 165  *
 166  * Returns: a new #GtkApplication instance
 167  */
 168 GtkApplication *
 169 gtk_application_new (const gchar       *application_id,
 170                      GApplicationFlags  flags)
 171 {
 172   g_return_val_if_fail (g_application_id_is_valid (application_id), NULL);
 173
 174   g_type_init ();
 175
 176   return g_object_new (GTK_TYPE_APPLICATION,
 177                        "application-id", application_id,
 178                        "flags", flags,
 179                        NULL);
 180 }
 181
 182 /**
 183  * gtk_application_add_window:
 184  * @application: a #GtkApplication
 185  * @window: a #GtkWindow
 186  *
 187  * Adds a window from @application.
 188  *
 189  * This call is equivalent to setting the #GtkWindow:application
 190  * property of @window to @application.
 191  *
 192  * Since: 3.0
 193  **/
 194 void
 195 gtk_application_add_window (GtkApplication *application,
 196                             GtkWindow      *window)
 197 {
 198   GtkApplicationPrivate *priv;
 199
 200   g_return_if_fail (GTK_IS_APPLICATION (application));
 201
 202   priv = application->priv;
 203
 204   if (!g_list_find (priv->windows, window))
 205     {
 206       priv->windows = g_list_prepend (priv->windows, window);
 207       gtk_window_set_application (window, application);
 208       g_application_hold (G_APPLICATION (application));
 209     }
 210 }
 211
 212 /**
 213  * gtk_application_remove_window:
 214  * @application: a #GtkApplication
 215  * @window: a #GtkWindow
 216  *
 217  * Remove a window from @application.
 218  *
 219  * If @window belongs to @application then this call is equivalent to
 220  * setting the #GtkWindow:application property of @window to
 221  * %NULL.
 222  *
 223  * The application may stop running as a result of a call to this
 224  * function.
 225  *
 226  * Since: 3.0
 227  **/
 228 void
 229 gtk_application_remove_window (GtkApplication *application,
 230                                GtkWindow      *window)
 231 {
 232   GtkApplicationPrivate *priv;
 233
 234   g_return_if_fail (GTK_IS_APPLICATION (application));
 235
 236   priv = application->priv;
 237   if (g_list_find (priv->windows, window))
 238     {
 239       priv->windows = g_list_remove (priv->windows, window);
 240       g_application_release (G_APPLICATION (application));
 241       gtk_window_set_application (window, NULL);
 242     }
 243 }
 244
 245 /**
 246  * gtk_application_get_windows:
 247  * @application: a #GtkApplication
 248  *
 249  * Gets a list of the #GtkWindow<!-- -->s associated with @application.
 250  *
 251  * The list that is returned should not be modified in any way.
 252  *
 253  * Returns: a #GList of #GtkWindow
 254  *
 255  * Since: 3.0
 256  **/
 257 GList *
 258 gtk_application_get_windows (GtkApplication *application)
 259 {
 260   g_return_val_if_fail (GTK_IS_APPLICATION (application), NULL);
 261
 262   return application->priv->windows;
 263 }