2 * Copyright © 2010 Codethink Limited
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as published
6 * by the Free Software Foundation; either version 2 of the licence or (at
7 * 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
15 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 * Authors: Ryan Lortie <desrt@desrt.ca>
20 #ifndef __G_APPLICATION_H__
21 #define __G_APPLICATION_H__
23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
27 #include <gio/giotypes.h>
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))
41 typedef struct _GApplicationPrivate GApplicationPrivate;
42 typedef struct _GApplicationClass GApplicationClass;
52 GObject parent_instance;
54 GApplicationPrivate *priv;
57 struct _GApplicationClass
60 GObjectClass parent_class;
64 void (* startup) (GApplication *application);
66 void (* activate) (GApplication *application);
68 void (* open) (GApplication *application,
73 int (* command_line) (GApplication *application,
74 GApplicationCommandLine *command_line);
79 * GApplicationClass::local_command_line:
80 * @application: a #GApplication
81 * @arguments: (inout) (array zero-terminated=1): array of command line arguments
82 * @exit_status: (out): exit status to fill after processing the command line.
84 * This virtual function is always invoked in the local instance. It
85 * gets passed a pointer to a %NULL-terminated copy of @argv and is
86 * expected to remove arguments that it handled (shifting up remaining
89 * The last argument to local_command_line() is a pointer to the @status
90 * variable which can used to set the exit status that is returned from
91 * g_application_run().
93 * See g_application_run() for more details on #GApplication startup.
95 * Returns: %TRUE if the commandline has been completely handled
97 gboolean (* local_command_line) (GApplication *application,
101 void (* before_emit) (GApplication *application,
102 GVariant *platform_data);
103 void (* after_emit) (GApplication *application,
104 GVariant *platform_data);
105 void (* add_platform_data) (GApplication *application,
106 GVariantBuilder *builder);
107 void (* quit_mainloop) (GApplication *application);
108 void (* run_mainloop) (GApplication *application);
109 void (* shutdown) (GApplication *application);
111 gboolean (* dbus_register) (GApplication *application,
112 GDBusConnection *connection,
113 const gchar *object_path,
115 void (* dbus_unregister) (GApplication *application,
116 GDBusConnection *connection,
117 const gchar *object_path);
123 GLIB_AVAILABLE_IN_ALL
124 GType g_application_get_type (void) G_GNUC_CONST;
126 GLIB_AVAILABLE_IN_ALL
127 gboolean g_application_id_is_valid (const gchar *application_id);
129 GLIB_AVAILABLE_IN_ALL
130 GApplication * g_application_new (const gchar *application_id,
131 GApplicationFlags flags);
133 GLIB_AVAILABLE_IN_ALL
134 const gchar * g_application_get_application_id (GApplication *application);
135 GLIB_AVAILABLE_IN_ALL
136 void g_application_set_application_id (GApplication *application,
137 const gchar *application_id);
139 GLIB_AVAILABLE_IN_2_34
140 GDBusConnection * g_application_get_dbus_connection (GApplication *application);
141 GLIB_AVAILABLE_IN_2_34
142 const gchar * g_application_get_dbus_object_path (GApplication *application);
144 GLIB_AVAILABLE_IN_ALL
145 guint g_application_get_inactivity_timeout (GApplication *application);
146 GLIB_AVAILABLE_IN_ALL
147 void g_application_set_inactivity_timeout (GApplication *application,
148 guint inactivity_timeout);
150 GLIB_AVAILABLE_IN_ALL
151 GApplicationFlags g_application_get_flags (GApplication *application);
152 GLIB_AVAILABLE_IN_ALL
153 void g_application_set_flags (GApplication *application,
154 GApplicationFlags flags);
157 void g_application_set_action_group (GApplication *application,
158 GActionGroup *action_group);
160 GLIB_AVAILABLE_IN_ALL
161 gboolean g_application_get_is_registered (GApplication *application);
162 GLIB_AVAILABLE_IN_ALL
163 gboolean g_application_get_is_remote (GApplication *application);
165 GLIB_AVAILABLE_IN_ALL
166 gboolean g_application_register (GApplication *application,
167 GCancellable *cancellable,
170 GLIB_AVAILABLE_IN_ALL
171 void g_application_hold (GApplication *application);
172 GLIB_AVAILABLE_IN_ALL
173 void g_application_release (GApplication *application);
175 GLIB_AVAILABLE_IN_ALL
176 void g_application_activate (GApplication *application);
178 GLIB_AVAILABLE_IN_ALL
179 void g_application_open (GApplication *application,
184 GLIB_AVAILABLE_IN_ALL
185 int g_application_run (GApplication *application,
189 GLIB_AVAILABLE_IN_2_32
190 void g_application_quit (GApplication *application);
192 GLIB_AVAILABLE_IN_2_32
193 GApplication * g_application_get_default (void);
194 GLIB_AVAILABLE_IN_2_32
195 void g_application_set_default (GApplication *application);
197 GLIB_AVAILABLE_IN_2_38
198 void g_application_mark_busy (GApplication *application);
199 GLIB_AVAILABLE_IN_2_38
200 void g_application_unmark_busy (GApplication *application);
202 GLIB_AVAILABLE_IN_2_40
203 void g_application_send_notification (GApplication *application,
205 GNotification *notification);
206 GLIB_AVAILABLE_IN_2_40
207 void g_application_withdraw_notification (GApplication *application,
212 #endif /* __G_APPLICATION_H__ */