* 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.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
*
* Authors: Ryan Lortie <desrt@desrt.ca>
*/
+#ifndef __G_APPLICATION_H__
+#define __G_APPLICATION_H__
+
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif
-#ifndef __G_APPLICATION_H__
-#define __G_APPLICATION_H__
-
#include <gio/giotypes.h>
G_BEGIN_DECLS
/**
* GApplication:
*
- * The <structname>GApplication</structname> structure contains private
- * data and should only be accessed using the provided API
- *
- * Since: 2.26
+ * Since: 2.28
*/
struct _GApplication
{
GApplicationPrivate *priv;
};
-/**
- * GApplicationClass:
- * @startup: invoked on the primary instance immediately after registration
- * @activate: invoked on the primary instance when an activation occurs
- * @open: invoked on the primary instance when there are files to open
- * @local_command_line: invoked (locally) when the process has been invoked via commandline execution. The
- * virtual function has the chance to inspect (and possibly replace) the list of command line arguments. See
- * g_application_run() for more information.
- * @before_emit: invoked on the primary instance before 'activate', 'open' or any action invocation
- * @after_emit: invoked on the primary instance after 'activate', 'open' or any action invocation
- * @add_platform_data: invoked (locally) to add 'platform data' to be sent to the primary instance when
- * activating, opening or invoking actions
- * @quit_mainloop: invoked on the primary instance when the use count of the application drops to zero (and
- * after any inactivity timeout, if requested)
- * @run_mainloop: invoked on the primary instance from g_application_run() if the use-count is non-zero
- *
- * Since: 2.26
- */
struct _GApplicationClass
{
/*< private >*/
/*< public >*/
/* signals */
- void (* startup) (GApplication *application);
+ void (* startup) (GApplication *application);
- void (* activate) (GApplication *application);
+ void (* activate) (GApplication *application);
- void (* open) (GApplication *application,
- GFile **files,
- gint n_files,
- const gchar *hint);
+ void (* open) (GApplication *application,
+ GFile **files,
+ gint n_files,
+ const gchar *hint);
- int (* command_line) (GApplication *application,
- GApplicationCommandLine *command_line);
+ int (* command_line) (GApplication *application,
+ GApplicationCommandLine *command_line);
/* vfuncs */
- gboolean (* local_command_line) (GApplication *application,
- GVariant **arguments,
- int *exit_status);
-
- void (* before_emit) (GApplication *application,
- GVariant *platform_data);
- void (* after_emit) (GApplication *application,
- GVariant *platform_data);
- void (* add_platform_data) (GApplication *application,
- GVariantBuilder *builder);
- void (* quit_mainloop) (GApplication *application);
- void (* run_mainloop) (GApplication *application);
+
+ /**
+ * GApplicationClass::local_command_line:
+ * @application: a #GApplication
+ * @arguments: (inout) (array zero-terminated=1): array of command line arguments
+ * @exit_status: (out): exit status to fill after processing the command line.
+ *
+ * This virtual function is always invoked in the local instance. It
+ * gets passed a pointer to a %NULL-terminated copy of @argv and is
+ * expected to remove arguments that it handled (shifting up remaining
+ * arguments).
+ *
+ * The last argument to local_command_line() is a pointer to the @status
+ * variable which can used to set the exit status that is returned from
+ * g_application_run().
+ *
+ * See g_application_run() for more details on #GApplication startup.
+ *
+ * Returns: %TRUE if the commandline has been completely handled
+ */
+ gboolean (* local_command_line) (GApplication *application,
+ gchar ***arguments,
+ int *exit_status);
+
+ void (* before_emit) (GApplication *application,
+ GVariant *platform_data);
+ void (* after_emit) (GApplication *application,
+ GVariant *platform_data);
+ void (* add_platform_data) (GApplication *application,
+ GVariantBuilder *builder);
+ void (* quit_mainloop) (GApplication *application);
+ void (* run_mainloop) (GApplication *application);
+ void (* shutdown) (GApplication *application);
+
+ gboolean (* dbus_register) (GApplication *application,
+ GDBusConnection *connection,
+ const gchar *object_path,
+ GError **error);
+ void (* dbus_unregister) (GApplication *application,
+ GDBusConnection *connection,
+ const gchar *object_path);
+ gint (* handle_local_options)(GApplication *application,
+ GVariantDict *options);
/*< private >*/
- gpointer padding[12];
+ gpointer padding[8];
};
+GLIB_AVAILABLE_IN_ALL
GType g_application_get_type (void) G_GNUC_CONST;
+GLIB_AVAILABLE_IN_ALL
gboolean g_application_id_is_valid (const gchar *application_id);
+GLIB_AVAILABLE_IN_ALL
GApplication * g_application_new (const gchar *application_id,
GApplicationFlags flags);
+GLIB_AVAILABLE_IN_ALL
const gchar * g_application_get_application_id (GApplication *application);
+GLIB_AVAILABLE_IN_ALL
void g_application_set_application_id (GApplication *application,
const gchar *application_id);
+GLIB_AVAILABLE_IN_2_34
+GDBusConnection * g_application_get_dbus_connection (GApplication *application);
+GLIB_AVAILABLE_IN_2_34
+const gchar * g_application_get_dbus_object_path (GApplication *application);
+
+GLIB_AVAILABLE_IN_ALL
guint g_application_get_inactivity_timeout (GApplication *application);
+GLIB_AVAILABLE_IN_ALL
void g_application_set_inactivity_timeout (GApplication *application,
guint inactivity_timeout);
+GLIB_AVAILABLE_IN_ALL
GApplicationFlags g_application_get_flags (GApplication *application);
+GLIB_AVAILABLE_IN_ALL
void g_application_set_flags (GApplication *application,
GApplicationFlags flags);
+GLIB_AVAILABLE_IN_2_42
+const gchar * g_application_get_resource_base_path (GApplication *application);
+GLIB_AVAILABLE_IN_2_42
+void g_application_set_resource_base_path (GApplication *application,
+ const gchar *resource_path);
+
+GLIB_DEPRECATED
+void g_application_set_action_group (GApplication *application,
+ GActionGroup *action_group);
+
+GLIB_AVAILABLE_IN_2_40
+void g_application_add_main_option_entries (GApplication *application,
+ const GOptionEntry *entries);
+
+GLIB_AVAILABLE_IN_2_42
+void g_application_add_main_option (GApplication *application,
+ const char *long_name,
+ char short_name,
+ GOptionFlags flags,
+ GOptionArg arg,
+ const char *description,
+ const char *arg_description);
+GLIB_AVAILABLE_IN_2_40
+void g_application_add_option_group (GApplication *application,
+ GOptionGroup *group);
+
+GLIB_AVAILABLE_IN_ALL
gboolean g_application_get_is_registered (GApplication *application);
+GLIB_AVAILABLE_IN_ALL
gboolean g_application_get_is_remote (GApplication *application);
+GLIB_AVAILABLE_IN_ALL
gboolean g_application_register (GApplication *application,
GCancellable *cancellable,
GError **error);
+GLIB_AVAILABLE_IN_ALL
void g_application_hold (GApplication *application);
+GLIB_AVAILABLE_IN_ALL
void g_application_release (GApplication *application);
+GLIB_AVAILABLE_IN_ALL
void g_application_activate (GApplication *application);
+GLIB_AVAILABLE_IN_ALL
void g_application_open (GApplication *application,
- GFile **file,
+ GFile **files,
gint n_files,
const gchar *hint);
+GLIB_AVAILABLE_IN_ALL
int g_application_run (GApplication *application,
int argc,
char **argv);
-int g_application_run_with_arguments (GApplication *application,
- GVariant *arguments);
+
+GLIB_AVAILABLE_IN_2_32
+void g_application_quit (GApplication *application);
+
+GLIB_AVAILABLE_IN_2_32
+GApplication * g_application_get_default (void);
+GLIB_AVAILABLE_IN_2_32
+void g_application_set_default (GApplication *application);
+
+GLIB_AVAILABLE_IN_2_38
+void g_application_mark_busy (GApplication *application);
+GLIB_AVAILABLE_IN_2_38
+void g_application_unmark_busy (GApplication *application);
+
+GLIB_AVAILABLE_IN_2_40
+void g_application_send_notification (GApplication *application,
+ const gchar *id,
+ GNotification *notification);
+GLIB_AVAILABLE_IN_2_40
+void g_application_withdraw_notification (GApplication *application,
+ const gchar *id);
G_END_DECLS