luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-05 00:46:16 +01:00
Code Issues Packages Projects Releases Wiki Activity
fbe3ce89a8
glib/gio/gapplication.h

207 lines
10 KiB
C
Raw Normal View History

new GApplication implementation
2010-10-06 19:08:26 +02:00
/*
* Copyright © 2010 Codethink Limited
Merge the wip/gapplication branch This adds a GApplication object to GIO, which is the core of an application support class, supporting - uniqueness - exporting actions (simple scripting) - standard actions (quit, activate) The implementation for Linux uses D-Bus, takes a name on the session bus, and exports a org.gtk.Application interface. Implementations for Win32 and OS X are still missing.
2010-06-07 19:25:39 +02:00
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation; either version 2 of the licence or (at
* your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* 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.
*
new GApplication implementation
2010-10-06 19:08:26 +02:00
* Authors: Ryan Lortie <desrt@desrt.ca>
Merge the wip/gapplication branch This adds a GApplication object to GIO, which is the core of an application support class, supporting - uniqueness - exporting actions (simple scripting) - standard actions (quit, activate) The implementation for Linux uses D-Bus, takes a name on the session bus, and exports a org.gtk.Application interface. Implementations for Win32 and OS X are still missing.
2010-06-07 19:25:39 +02:00
*/
Move single-include guards inside include guards gcc has optimizations for include guards that only work if they are outermost in the the header. https://bugzilla.gnome.org/show_bug.cgi?id=689810
2012-12-28 05:43:14 +01:00
#ifndef __G_APPLICATION_H__
#define __G_APPLICATION_H__
Merge the wip/gapplication branch This adds a GApplication object to GIO, which is the core of an application support class, supporting - uniqueness - exporting actions (simple scripting) - standard actions (quit, activate) The implementation for Linux uses D-Bus, takes a name on the session bus, and exports a org.gtk.Application interface. Implementations for Win32 and OS X are still missing.
2010-06-07 19:25:39 +02:00
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif
#include <gio/giotypes.h>
G_BEGIN_DECLS
new GApplication implementation
2010-10-06 19:08:26 +02:00
#define G_TYPE_APPLICATION (g_application_get_type ())
#define G_APPLICATION(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
G_TYPE_APPLICATION, GApplication))
#define G_APPLICATION_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), \
G_TYPE_APPLICATION, GApplicationClass))
#define G_IS_APPLICATION(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), G_TYPE_APPLICATION))
#define G_IS_APPLICATION_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_APPLICATION))
#define G_APPLICATION_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), \
G_TYPE_APPLICATION, GApplicationClass))
Merge the wip/gapplication branch This adds a GApplication object to GIO, which is the core of an application support class, supporting - uniqueness - exporting actions (simple scripting) - standard actions (quit, activate) The implementation for Linux uses D-Bus, takes a name on the session bus, and exports a org.gtk.Application interface. Implementations for Win32 and OS X are still missing.
2010-06-07 19:25:39 +02:00
new GApplication implementation
2010-10-06 19:08:26 +02:00
typedef struct _GApplicationPrivate GApplicationPrivate;
typedef struct _GApplicationClass GApplicationClass;
Merge the wip/gapplication branch This adds a GApplication object to GIO, which is the core of an application support class, supporting - uniqueness - exporting actions (simple scripting) - standard actions (quit, activate) The implementation for Linux uses D-Bus, takes a name on the session bus, and exports a org.gtk.Application interface. Implementations for Win32 and OS X are still missing.
2010-06-07 19:25:39 +02:00
/**
* GApplication:
*
GApplication: document Since properly in header files, 2.26 -> 2.28 https://bugzilla.gnome.org/show_bug.cgi?id=641783
2011-02-07 23:53:29 +01:00
* Since: 2.28
Merge the wip/gapplication branch This adds a GApplication object to GIO, which is the core of an application support class, supporting - uniqueness - exporting actions (simple scripting) - standard actions (quit, activate) The implementation for Linux uses D-Bus, takes a name on the session bus, and exports a org.gtk.Application interface. Implementations for Win32 and OS X are still missing.
2010-06-07 19:25:39 +02:00
*/
struct _GApplication
{
/*< private >*/
GObject parent_instance;
GApplicationPrivate *priv;
};
struct _GApplicationClass
{
/*< private >*/
GObjectClass parent_class;
/*< public >*/
/* signals */
GApplication: reduce GVariant abuse Don't use GVariant* as the representation for the argument array.
2010-10-19 19:38:00 +02:00
void (* startup) (GApplication *application);
new GApplication implementation
2010-10-06 19:08:26 +02:00
GApplication: reduce GVariant abuse Don't use GVariant* as the representation for the argument array.
2010-10-19 19:38:00 +02:00
void (* activate) (GApplication *application);
new GApplication implementation
2010-10-06 19:08:26 +02:00
GApplication: reduce GVariant abuse Don't use GVariant* as the representation for the argument array.
2010-10-19 19:38:00 +02:00
void (* open) (GApplication *application,
GFile **files,
gint n_files,
const gchar *hint);
new GApplication implementation
2010-10-06 19:08:26 +02:00
GApplication: reduce GVariant abuse Don't use GVariant* as the representation for the argument array.
2010-10-19 19:38:00 +02:00
int (* command_line) (GApplication *application,
GApplicationCommandLine *command_line);
Merge the wip/gapplication branch This adds a GApplication object to GIO, which is the core of an application support class, supporting - uniqueness - exporting actions (simple scripting) - standard actions (quit, activate) The implementation for Linux uses D-Bus, takes a name on the session bus, and exports a org.gtk.Application interface. Implementations for Win32 and OS X are still missing.
2010-06-07 19:25:39 +02:00
/* vfuncs */
Annotate GApplication::local_command_line Also add some documentation. https://bugzilla.gnome.org/show_bug.cgi?id=690670
2012-12-27 20:55:30 +01:00
/**
* 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
*/
GApplication: reduce GVariant abuse Don't use GVariant* as the representation for the argument array.
2010-10-19 19:38:00 +02:00
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);
GApplication: introduce ::shutdown Introduce ::shutdown as a dual to ::startup. https://bugzilla.gnome.org/show_bug.cgi?id=643934
2011-09-14 19:42:35 +02:00
void (* shutdown) (GApplication *application);
Merge the wip/gapplication branch This adds a GApplication object to GIO, which is the core of an application support class, supporting - uniqueness - exporting actions (simple scripting) - standard actions (quit, activate) The implementation for Linux uses D-Bus, takes a name on the session bus, and exports a org.gtk.Application interface. Implementations for Win32 and OS X are still missing.
2010-06-07 19:25:39 +02:00
application: Add dbus register/unregister hooks When the application is using its D-Bus backend, it is useful to be able to export extra D-Bus objects at the right time, i.e. *before* the application tries to own the bus name. This is accomplished here by adding a hook in GApplicationClass for this; and a corresponding hook that will be called on unregistration to undo whatever the register hook did. Bug #675509.
2012-05-05 16:52:28 +02:00
gboolean (* dbus_register) (GApplication *application,
GDBusConnection *connection,
const gchar *object_path,
GError **error);
void (* dbus_unregister) (GApplication *application,
GDBusConnection *connection,
const gchar *object_path);
Merge the wip/gapplication branch This adds a GApplication object to GIO, which is the core of an application support class, supporting - uniqueness - exporting actions (simple scripting) - standard actions (quit, activate) The implementation for Linux uses D-Bus, takes a name on the session bus, and exports a org.gtk.Application interface. Implementations for Win32 and OS X are still missing.
2010-06-07 19:25:39 +02:00
/*< private >*/
application: Add dbus register/unregister hooks When the application is using its D-Bus backend, it is useful to be able to export extra D-Bus objects at the right time, i.e. *before* the application tries to own the bus name. This is accomplished here by adding a hook in GApplicationClass for this; and a corresponding hook that will be called on unregistration to undo whatever the register hook did. Bug #675509.
2012-05-05 16:52:28 +02:00
gpointer padding[9];
Merge the wip/gapplication branch This adds a GApplication object to GIO, which is the core of an application support class, supporting - uniqueness - exporting actions (simple scripting) - standard actions (quit, activate) The implementation for Linux uses D-Bus, takes a name on the session bus, and exports a org.gtk.Application interface. Implementations for Win32 and OS X are still missing.
2010-06-07 19:25:39 +02:00
};
new GApplication implementation
2010-10-06 19:08:26 +02:00
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
GType g_application_get_type (void) G_GNUC_CONST;
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
gboolean g_application_id_is_valid (const gchar *application_id);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
GApplication * g_application_new (const gchar *application_id,
GApplicationFlags flags);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
const gchar * g_application_get_application_id (GApplication *application);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
void g_application_set_application_id (GApplication *application,
const gchar *application_id);
GApplication: add accessor for DBus information Provide public access to the GDBusConnect and object path that GApplication is using. Prevents others from having to guess these things for themselves based on the application ID. https://bugzilla.gnome.org/show_bug.cgi?id=671249
2012-04-30 18:20:54 +02:00
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);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
guint g_application_get_inactivity_timeout (GApplication *application);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
void g_application_set_inactivity_timeout (GApplication *application,
guint inactivity_timeout);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
GApplicationFlags g_application_get_flags (GApplication *application);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
void g_application_set_flags (GApplication *application,
GApplicationFlags flags);
GApplication: implement GActionMap and deprecate g_application_set_action_group().
2011-12-02 16:32:28 +01:00
GLIB_DEPRECATED
GApplication: fill in action group implementation
2010-10-11 17:54:51 +02:00
void g_application_set_action_group (GApplication *application,
GActionGroup *action_group);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
gboolean g_application_get_is_registered (GApplication *application);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
gboolean g_application_get_is_remote (GApplication *application);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
gboolean g_application_register (GApplication *application,
GCancellable *cancellable,
GError **error);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
void g_application_hold (GApplication *application);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
void g_application_release (GApplication *application);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
void g_application_activate (GApplication *application);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
void g_application_open (GApplication *application,
More documentation fixups
2010-10-25 14:42:36 +02:00
GFile **files,
new GApplication implementation
2010-10-06 19:08:26 +02:00
gint n_files,
const gchar *hint);
various: add GLIB_AVAILABLE_IN_ALL everywhere else Add the GLIB_AVAILABLE_IN_ALL annotation to all old functions (that haven't already been annotated with the GLIB_AVAILABLE_IN_* macros or a deprecation macro). If we discover in the future that we cannot use only one macro on Windows, it will be an easy sed patch to fix that. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-12-06 20:04:59 +01:00
GLIB_AVAILABLE_IN_ALL
new GApplication implementation
2010-10-06 19:08:26 +02:00
int g_application_run (GApplication *application,
int argc,
char **argv);
Merge the wip/gapplication branch This adds a GApplication object to GIO, which is the core of an application support class, supporting - uniqueness - exporting actions (simple scripting) - standard actions (quit, activate) The implementation for Linux uses D-Bus, takes a name on the session bus, and exports a org.gtk.Application interface. Implementations for Win32 and OS X are still missing.
2010-06-07 19:25:39 +02:00
gio: GLIB_AVAILABLE_IN to more APIs Useful on its own, but also for a future patch for symbol visibility. https://bugzilla.gnome.org/show_bug.cgi?id=688681
2012-11-29 15:03:32 +01:00
GLIB_AVAILABLE_IN_2_32
GApplication: add g_application_quit() A long requested feature; this quits the application immediately, ignoring the hold count. https://bugzilla.gnome.org/show_bug.cgi?id=670485
2012-02-20 21:41:35 +01:00
void g_application_quit (GApplication *application);
Annotate API introduced for 2.32 with GLIB_AVAILABLE_IN_2_32 https://bugzilla.gnome.org/show_bug.cgi?id=676816
2012-05-25 14:59:09 +02:00
GLIB_AVAILABLE_IN_2_32
GApplication: add default application
2011-09-30 05:52:16 +02:00
GApplication * g_application_get_default (void);
Annotate API introduced for 2.32 with GLIB_AVAILABLE_IN_2_32 https://bugzilla.gnome.org/show_bug.cgi?id=676816
2012-05-25 14:59:09 +02:00
GLIB_AVAILABLE_IN_2_32
GApplication: add default application
2011-09-30 05:52:16 +02:00
void g_application_set_default (GApplication *application);
application: introduce methods to mark the application as busy This feature is intended for clients that want to signal a desktop shell their busy state, for instance because a long-running operation is pending. The API works in a similar way to g_application_hold and g_application_release: applications can call g_application_mark_busy() to increase a counter that will keep the application marked as busy until the counter reaches zero again. The busy state is exported read-only on the org.gtk.Application interface for clients to use. https://bugzilla.gnome.org/show_bug.cgi?id=672018
2013-04-03 20:12:03 +02:00
GLIB_AVAILABLE_IN_2_38
void g_application_mark_busy (GApplication *application);
GLIB_AVAILABLE_IN_2_38
void g_application_unmark_busy (GApplication *application);
Merge the wip/gapplication branch This adds a GApplication object to GIO, which is the core of an application support class, supporting - uniqueness - exporting actions (simple scripting) - standard actions (quit, activate) The implementation for Linux uses D-Bus, takes a name on the session bus, and exports a org.gtk.Application interface. Implementations for Win32 and OS X are still missing.
2010-06-07 19:25:39 +02:00
G_END_DECLS
#endif /* __G_APPLICATION_H__ */
Reference in New Issue Copy Permalink