gio/gapplication.h

   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.1 of the License, 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
  15  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  16  *
  17  * Authors: Ryan Lortie <desrt@desrt.ca>
  18  */
  19
  20 #ifndef __G_APPLICATION_H__
  21 #define __G_APPLICATION_H__
  22
  23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #include <gio/giotypes.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define G_TYPE_APPLICATION                                  (g_application_get_type ())
  32 #define G_APPLICATION(inst)                                 (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
  33                                                              G_TYPE_APPLICATION, GApplication))
  34 #define G_APPLICATION_CLASS(class)                          (G_TYPE_CHECK_CLASS_CAST ((class),                       \
  35                                                              G_TYPE_APPLICATION, GApplicationClass))
  36 #define G_IS_APPLICATION(inst)                              (G_TYPE_CHECK_INSTANCE_TYPE ((inst), G_TYPE_APPLICATION))
  37 #define G_IS_APPLICATION_CLASS(class)                       (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_APPLICATION))
  38 #define G_APPLICATION_GET_CLASS(inst)                       (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
  39                                                              G_TYPE_APPLICATION, GApplicationClass))
  40
  41 typedef struct _GApplicationPrivate                         GApplicationPrivate;
  42 typedef struct _GApplicationClass                           GApplicationClass;
  43
  44 struct _GApplication
  45 {
  46   /*< private >*/
  47   GObject parent_instance;
  48
  49   GApplicationPrivate *priv;
  50 };
  51
  52 struct _GApplicationClass
  53 {
  54   /*< private >*/
  55   GObjectClass parent_class;
  56
  57   /*< public >*/
  58   /* signals */
  59   void                      (* startup)             (GApplication              *application);
  60
  61   void                      (* activate)            (GApplication              *application);
  62
  63   void                      (* open)                (GApplication              *application,
  64                                                      GFile                    **files,
  65                                                      gint                       n_files,
  66                                                      const gchar               *hint);
  67
  68   int                       (* command_line)        (GApplication              *application,
  69                                                      GApplicationCommandLine   *command_line);
  70
  71   /* vfuncs */
  72
  73   /**
  74    * GApplicationClass::local_command_line:
  75    * @application: a #GApplication
  76    * @arguments: (inout) (array zero-terminated=1): array of command line arguments
  77    * @exit_status: (out): exit status to fill after processing the command line.
  78    *
  79    * This virtual function is always invoked in the local instance. It
  80    * gets passed a pointer to a %NULL-terminated copy of @argv and is
  81    * expected to remove arguments that it handled (shifting up remaining
  82    * arguments).
  83    *
  84    * The last argument to local_command_line() is a pointer to the @status
  85    * variable which can used to set the exit status that is returned from
  86    * g_application_run().
  87    *
  88    * See g_application_run() for more details on #GApplication startup.
  89    *
  90    * Returns: %TRUE if the commandline has been completely handled
  91    */
  92   gboolean                  (* local_command_line)  (GApplication              *application,
  93                                                      gchar                   ***arguments,
  94                                                      int                       *exit_status);
  95
  96   void                      (* before_emit)         (GApplication              *application,
  97                                                      GVariant                  *platform_data);
  98   void                      (* after_emit)          (GApplication              *application,
  99                                                      GVariant                  *platform_data);
 100   void                      (* add_platform_data)   (GApplication              *application,
 101                                                      GVariantBuilder           *builder);
 102   void                      (* quit_mainloop)       (GApplication              *application);
 103   void                      (* run_mainloop)        (GApplication              *application);
 104   void                      (* shutdown)            (GApplication              *application);
 105
 106   gboolean                  (* dbus_register)       (GApplication              *application,
 107                                                      GDBusConnection           *connection,
 108                                                      const gchar               *object_path,
 109                                                      GError                   **error);
 110   void                      (* dbus_unregister)     (GApplication              *application,
 111                                                      GDBusConnection           *connection,
 112                                                      const gchar               *object_path);
 113   gint                      (* handle_local_options)(GApplication              *application,
 114                                                      GVariantDict              *options);
 115
 116   /*< private >*/
 117   gpointer padding[8];
 118 };
 119
 120 GLIB_AVAILABLE_IN_ALL
 121 GType                   g_application_get_type                          (void) G_GNUC_CONST;
 122
 123 GLIB_AVAILABLE_IN_ALL
 124 gboolean                g_application_id_is_valid                       (const gchar              *application_id);
 125
 126 GLIB_AVAILABLE_IN_ALL
 127 GApplication *          g_application_new                               (const gchar              *application_id,
 128                                                                          GApplicationFlags         flags);
 129
 130 GLIB_AVAILABLE_IN_ALL
 131 const gchar *           g_application_get_application_id                (GApplication             *application);
 132 GLIB_AVAILABLE_IN_ALL
 133 void                    g_application_set_application_id                (GApplication             *application,
 134                                                                          const gchar              *application_id);
 135
 136 GLIB_AVAILABLE_IN_2_34
 137 GDBusConnection *       g_application_get_dbus_connection               (GApplication             *application);
 138 GLIB_AVAILABLE_IN_2_34
 139 const gchar *           g_application_get_dbus_object_path              (GApplication             *application);
 140
 141 GLIB_AVAILABLE_IN_ALL
 142 guint                   g_application_get_inactivity_timeout            (GApplication             *application);
 143 GLIB_AVAILABLE_IN_ALL
 144 void                    g_application_set_inactivity_timeout            (GApplication             *application,
 145                                                                          guint                     inactivity_timeout);
 146
 147 GLIB_AVAILABLE_IN_ALL
 148 GApplicationFlags       g_application_get_flags                         (GApplication             *application);
 149 GLIB_AVAILABLE_IN_ALL
 150 void                    g_application_set_flags                         (GApplication             *application,
 151                                                                          GApplicationFlags         flags);
 152
 153 GLIB_AVAILABLE_IN_2_42
 154 const gchar *           g_application_get_resource_base_path            (GApplication             *application);
 155 GLIB_AVAILABLE_IN_2_42
 156 void                    g_application_set_resource_base_path            (GApplication             *application,
 157                                                                          const gchar              *resource_path);
 158
 159 GLIB_DEPRECATED
 160 void                    g_application_set_action_group                  (GApplication             *application,
 161                                                                          GActionGroup             *action_group);
 162
 163 GLIB_AVAILABLE_IN_2_40
 164 void                    g_application_add_main_option_entries           (GApplication             *application,
 165                                                                          const GOptionEntry       *entries);
 166
 167 GLIB_AVAILABLE_IN_2_42
 168 void                    g_application_add_main_option                   (GApplication             *application,
 169                                                                          const char               *long_name,
 170                                                                          char                      short_name,
 171                                                                          GOptionFlags              flags,
 172                                                                          GOptionArg                arg,
 173                                                                          const char               *description,
 174                                                                          const char               *arg_description);
 175 GLIB_AVAILABLE_IN_2_40
 176 void                    g_application_add_option_group                  (GApplication             *application,
 177                                                                          GOptionGroup             *group);
 178 GLIB_AVAILABLE_IN_2_56
 179 void                    g_application_set_option_context_parameter_string (GApplication             *application,
 180                                                                            const gchar              *parameter_string);
 181 GLIB_AVAILABLE_IN_2_56
 182 void                    g_application_set_option_context_summary        (GApplication             *application,
 183                                                                          const gchar              *summary);
 184 GLIB_AVAILABLE_IN_2_56
 185 void                    g_application_set_option_context_description    (GApplication             *application,
 186                                                                          const gchar              *description);
 187 GLIB_AVAILABLE_IN_ALL
 188 gboolean                g_application_get_is_registered                 (GApplication             *application);
 189 GLIB_AVAILABLE_IN_ALL
 190 gboolean                g_application_get_is_remote                     (GApplication             *application);
 191
 192 GLIB_AVAILABLE_IN_ALL
 193 gboolean                g_application_register                          (GApplication             *application,
 194                                                                          GCancellable             *cancellable,
 195                                                                          GError                  **error);
 196
 197 GLIB_AVAILABLE_IN_ALL
 198 void                    g_application_hold                              (GApplication             *application);
 199 GLIB_AVAILABLE_IN_ALL
 200 void                    g_application_release                           (GApplication             *application);
 201
 202 GLIB_AVAILABLE_IN_ALL
 203 void                    g_application_activate                          (GApplication             *application);
 204
 205 GLIB_AVAILABLE_IN_ALL
 206 void                    g_application_open                              (GApplication             *application,
 207                                                                          GFile                   **files,
 208                                                                          gint                      n_files,
 209                                                                          const gchar              *hint);
 210
 211 GLIB_AVAILABLE_IN_ALL
 212 int                     g_application_run                               (GApplication             *application,
 213                                                                          int                       argc,
 214                                                                          char                    **argv);
 215
 216 GLIB_AVAILABLE_IN_2_32
 217 void                    g_application_quit                              (GApplication             *application);
 218
 219 GLIB_AVAILABLE_IN_2_32
 220 GApplication *          g_application_get_default                       (void);
 221 GLIB_AVAILABLE_IN_2_32
 222 void                    g_application_set_default                       (GApplication             *application);
 223
 224 GLIB_AVAILABLE_IN_2_38
 225 void                    g_application_mark_busy                         (GApplication             *application);
 226 GLIB_AVAILABLE_IN_2_38
 227 void                    g_application_unmark_busy                       (GApplication             *application);
 228 GLIB_AVAILABLE_IN_2_44
 229 gboolean                g_application_get_is_busy                       (GApplication             *application);
 230
 231 GLIB_AVAILABLE_IN_2_40
 232 void                    g_application_send_notification                 (GApplication             *application,
 233                                                                          const gchar              *id,
 234                                                                          GNotification            *notification);
 235 GLIB_AVAILABLE_IN_2_40
 236 void                    g_application_withdraw_notification             (GApplication             *application,
 237                                                                          const gchar              *id);
 238
 239 GLIB_AVAILABLE_IN_2_44
 240 void                    g_application_bind_busy_property                (GApplication             *application,
 241                                                                          gpointer                  object,
 242                                                                          const gchar              *property);
 243
 244 GLIB_AVAILABLE_IN_2_44
 245 void                    g_application_unbind_busy_property              (GApplication             *application,
 246                                                                          gpointer                  object,
 247                                                                          const gchar              *property);
 248
 249 G_END_DECLS
 250
 251 #endif /* __G_APPLICATION_H__ */