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, write to the
16 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Authors: Ryan Lortie <desrt@desrt.ca>
22 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
23 #error "Only <gio/gio.h> can be included directly."
26 #ifndef __G_APPLICATION_H__
27 #define __G_APPLICATION_H__
29 #include <gio/giotypes.h>
33 #define G_TYPE_APPLICATION (g_application_get_type ())
34 #define G_APPLICATION(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
35 G_TYPE_APPLICATION, GApplication))
36 #define G_APPLICATION_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), \
37 G_TYPE_APPLICATION, GApplicationClass))
38 #define G_IS_APPLICATION(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), G_TYPE_APPLICATION))
39 #define G_IS_APPLICATION_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_APPLICATION))
40 #define G_APPLICATION_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), \
41 G_TYPE_APPLICATION, GApplicationClass))
43 typedef struct _GApplicationPrivate GApplicationPrivate;
44 typedef struct _GApplicationClass GApplicationClass;
49 * The <structname>GApplication</structname> structure contains private
50 * data and should only be accessed using the provided API
57 GObject parent_instance;
59 GApplicationPrivate *priv;
64 * @startup: invoked on the primary instance immediately after registration
65 * @activate: invoked on the primary instance when an activation occurs
66 * @open: invoked on the primary instance when there are files to open
67 * @local_command_line: invoked (locally) when the process has been invoked via commandline execution. The
68 * virtual function has the chance to inspect (and possibly replace) the list of command line arguments. See
69 * g_application_run() for more information.
70 * @before_emit: invoked on the primary instance before 'activate', 'open' or any action invocation
71 * @after_emit: invoked on the primary instance after 'activate', 'open' or any action invocation
72 * @add_platform_data: invoked (locally) to add 'platform data' to be sent to the primary instance when
73 * activating, opening or invoking actions
74 * @quit_mainloop: invoked on the primary instance when the use count of the application drops to zero (and
75 * after any inactivity timeout, if requested)
76 * @run_mainloop: invoked on the primary instance from g_application_run() if the use-count is non-zero
80 struct _GApplicationClass
83 GObjectClass parent_class;
87 void (* startup) (GApplication *application);
89 void (* activate) (GApplication *application);
91 void (* open) (GApplication *application,
96 int (* command_line) (GApplication *application,
97 GApplicationCommandLine *command_line);
100 gboolean (* local_command_line) (GApplication *application,
101 GVariant **arguments,
104 void (* before_emit) (GApplication *application,
105 GVariant *platform_data);
106 void (* after_emit) (GApplication *application,
107 GVariant *platform_data);
108 void (* add_platform_data) (GApplication *application,
109 GVariantBuilder *builder);
110 void (* quit_mainloop) (GApplication *application);
111 void (* run_mainloop) (GApplication *application);
114 gpointer padding[12];
117 GType g_application_get_type (void) G_GNUC_CONST;
119 gboolean g_application_id_is_valid (const gchar *application_id);
121 GApplication * g_application_new (const gchar *application_id,
122 GApplicationFlags flags);
124 const gchar * g_application_get_application_id (GApplication *application);
125 void g_application_set_application_id (GApplication *application,
126 const gchar *application_id);
128 guint g_application_get_inactivity_timeout (GApplication *application);
129 void g_application_set_inactivity_timeout (GApplication *application,
130 guint inactivity_timeout);
132 GApplicationFlags g_application_get_flags (GApplication *application);
133 void g_application_set_flags (GApplication *application,
134 GApplicationFlags flags);
136 void g_application_set_action_group (GApplication *application,
137 GActionGroup *action_group);
139 gboolean g_application_get_is_registered (GApplication *application);
140 gboolean g_application_get_is_remote (GApplication *application);
142 gboolean g_application_register (GApplication *application,
143 GCancellable *cancellable,
146 void g_application_hold (GApplication *application);
147 void g_application_release (GApplication *application);
149 void g_application_activate (GApplication *application);
151 void g_application_open (GApplication *application,
156 int g_application_run (GApplication *application,
159 int g_application_run_with_arguments (GApplication *application,
160 GVariant *arguments);
164 #endif /* __G_APPLICATION_H__ */