mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-10-31 16:32:18 +01:00
b8db83940b
Adjust all docs to use the gi-docgen referencing syntax, reindent some of the comments, and add missing annotations to some async methods. The error arguments are not necessary with gi-docgen so they're removed. Confusingly enough, the docks for GAppInfo is spread between two files.
378 lines
20 KiB
C
378 lines
20 KiB
C
/* GIO - GLib Input, Output and Streaming Library
|
|
*
|
|
* Copyright (C) 2006-2007 Red Hat, Inc.
|
|
*
|
|
* SPDX-License-Identifier: LGPL-2.1-or-later
|
|
*
|
|
* This library 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.1 of the License, 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, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* Author: Alexander Larsson <alexl@redhat.com>
|
|
*/
|
|
|
|
#ifndef __G_APP_INFO_H__
|
|
#define __G_APP_INFO_H__
|
|
|
|
#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
|
|
|
|
#define G_TYPE_APP_INFO (g_app_info_get_type ())
|
|
#define G_APP_INFO(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_APP_INFO, GAppInfo))
|
|
#define G_IS_APP_INFO(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_APP_INFO))
|
|
#define G_APP_INFO_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_APP_INFO, GAppInfoIface))
|
|
|
|
#define G_TYPE_APP_LAUNCH_CONTEXT (g_app_launch_context_get_type ())
|
|
#define G_APP_LAUNCH_CONTEXT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContext))
|
|
#define G_APP_LAUNCH_CONTEXT_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContextClass))
|
|
#define G_IS_APP_LAUNCH_CONTEXT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_APP_LAUNCH_CONTEXT))
|
|
#define G_IS_APP_LAUNCH_CONTEXT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_APP_LAUNCH_CONTEXT))
|
|
#define G_APP_LAUNCH_CONTEXT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_APP_LAUNCH_CONTEXT, GAppLaunchContextClass))
|
|
|
|
typedef struct _GAppLaunchContextClass GAppLaunchContextClass;
|
|
typedef struct _GAppLaunchContextPrivate GAppLaunchContextPrivate;
|
|
|
|
/**
|
|
* GAppInfoIface:
|
|
* @g_iface: The parent interface.
|
|
* @dup: Copies a [iface@Gio.AppInfo].
|
|
* @equal: Checks two [iface@Gio.AppInfo]s for equality.
|
|
* @get_id: Gets a string identifier for a [iface@Gio.AppInfo].
|
|
* @get_name: Gets the name of the application for a [iface@Gio.AppInfo].
|
|
* @get_description: Gets a short description for the application described by
|
|
* the [iface@Gio.AppInfo].
|
|
* @get_executable: Gets the executable name for the [iface@Gio.AppInfo].
|
|
* @get_icon: Gets the [iface@Gio.Icon] for the [iface@Gio.AppInfo].
|
|
* @launch: Launches an application specified by the [iface@Gio.AppInfo].
|
|
* @supports_uris: Indicates whether the application specified supports
|
|
* launching URIs.
|
|
* @supports_files: Indicates whether the application specified accepts
|
|
* filename arguments.
|
|
* @launch_uris: Launches an application with a list of URIs.
|
|
* @should_show: Returns whether an application should be shown (e.g. when
|
|
* getting a list of installed applications).
|
|
* [FreeDesktop.Org Startup Notification Specification](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt).
|
|
* @set_as_default_for_type: Sets an application as default for a given content
|
|
* type.
|
|
* @set_as_default_for_extension: Sets an application as default for a given
|
|
* file extension.
|
|
* @add_supports_type: Adds to the [iface@Gio.AppInfo] information about
|
|
* supported file types.
|
|
* @can_remove_supports_type: Checks for support for removing supported file
|
|
* types from a [iface@Gio.AppInfo].
|
|
* @remove_supports_type: Removes a supported application type from a
|
|
* [iface@Gio.AppInfo].
|
|
* @can_delete: Checks if a [iface@Gio.AppInfo] can be deleted. (Since 2.20)
|
|
* @do_delete: Deletes a [iface@Gio.AppInfo]. (Since 2.20)
|
|
* @get_commandline: Gets the commandline for the [iface@Gio.AppInfo].
|
|
* (Since 2.20)
|
|
* @get_display_name: Gets the display name for the [iface@Gio.AppInfo].
|
|
* (Since 2.24)
|
|
* @set_as_last_used_for_type: Sets the application as the last used. See
|
|
* [method@Gio.AppInfo.set_as_last_used_for_type].
|
|
* @get_supported_types: Retrieves the list of content types that @app_info
|
|
* claims to support.
|
|
* @launch_uris_async: Asynchronously launches an application with a list of
|
|
* URIs. (Since: 2.60)
|
|
* @launch_uris_finish: Finishes an operation started with @launch_uris_async.
|
|
* (Since: 2.60)
|
|
|
|
* Application Information interface, for operating system portability.
|
|
*/
|
|
typedef struct _GAppInfoIface GAppInfoIface;
|
|
|
|
struct _GAppInfoIface
|
|
{
|
|
GTypeInterface g_iface;
|
|
|
|
/* Virtual Table */
|
|
|
|
GAppInfo * (* dup) (GAppInfo *appinfo);
|
|
gboolean (* equal) (GAppInfo *appinfo1,
|
|
GAppInfo *appinfo2);
|
|
const char * (* get_id) (GAppInfo *appinfo);
|
|
const char * (* get_name) (GAppInfo *appinfo);
|
|
const char * (* get_description) (GAppInfo *appinfo);
|
|
const char * (* get_executable) (GAppInfo *appinfo);
|
|
GIcon * (* get_icon) (GAppInfo *appinfo);
|
|
gboolean (* launch) (GAppInfo *appinfo,
|
|
GList *files,
|
|
GAppLaunchContext *context,
|
|
GError **error);
|
|
gboolean (* supports_uris) (GAppInfo *appinfo);
|
|
gboolean (* supports_files) (GAppInfo *appinfo);
|
|
gboolean (* launch_uris) (GAppInfo *appinfo,
|
|
GList *uris,
|
|
GAppLaunchContext *context,
|
|
GError **error);
|
|
gboolean (* should_show) (GAppInfo *appinfo);
|
|
|
|
/* For changing associations */
|
|
gboolean (* set_as_default_for_type) (GAppInfo *appinfo,
|
|
const char *content_type,
|
|
GError **error);
|
|
gboolean (* set_as_default_for_extension) (GAppInfo *appinfo,
|
|
const char *extension,
|
|
GError **error);
|
|
gboolean (* add_supports_type) (GAppInfo *appinfo,
|
|
const char *content_type,
|
|
GError **error);
|
|
gboolean (* can_remove_supports_type) (GAppInfo *appinfo);
|
|
gboolean (* remove_supports_type) (GAppInfo *appinfo,
|
|
const char *content_type,
|
|
GError **error);
|
|
gboolean (* can_delete) (GAppInfo *appinfo);
|
|
gboolean (* do_delete) (GAppInfo *appinfo);
|
|
const char * (* get_commandline) (GAppInfo *appinfo);
|
|
const char * (* get_display_name) (GAppInfo *appinfo);
|
|
gboolean (* set_as_last_used_for_type) (GAppInfo *appinfo,
|
|
const char *content_type,
|
|
GError **error);
|
|
const char ** (* get_supported_types) (GAppInfo *appinfo);
|
|
void (* launch_uris_async) (GAppInfo *appinfo,
|
|
GList *uris,
|
|
GAppLaunchContext *context,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
gboolean (* launch_uris_finish) (GAppInfo *appinfo,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
};
|
|
|
|
GIO_AVAILABLE_IN_ALL
|
|
GType g_app_info_get_type (void) G_GNUC_CONST;
|
|
GIO_AVAILABLE_IN_ALL
|
|
GAppInfo * g_app_info_create_from_commandline (const char *commandline,
|
|
const char *application_name,
|
|
GAppInfoCreateFlags flags,
|
|
GError **error);
|
|
GIO_AVAILABLE_IN_ALL
|
|
GAppInfo * g_app_info_dup (GAppInfo *appinfo);
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_equal (GAppInfo *appinfo1,
|
|
GAppInfo *appinfo2);
|
|
GIO_AVAILABLE_IN_ALL
|
|
const char *g_app_info_get_id (GAppInfo *appinfo);
|
|
GIO_AVAILABLE_IN_ALL
|
|
const char *g_app_info_get_name (GAppInfo *appinfo);
|
|
GIO_AVAILABLE_IN_ALL
|
|
const char *g_app_info_get_display_name (GAppInfo *appinfo);
|
|
GIO_AVAILABLE_IN_ALL
|
|
const char *g_app_info_get_description (GAppInfo *appinfo);
|
|
GIO_AVAILABLE_IN_ALL
|
|
const char *g_app_info_get_executable (GAppInfo *appinfo);
|
|
GIO_AVAILABLE_IN_ALL
|
|
const char *g_app_info_get_commandline (GAppInfo *appinfo);
|
|
GIO_AVAILABLE_IN_ALL
|
|
GIcon * g_app_info_get_icon (GAppInfo *appinfo);
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_launch (GAppInfo *appinfo,
|
|
GList *files,
|
|
GAppLaunchContext *context,
|
|
GError **error);
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_supports_uris (GAppInfo *appinfo);
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_supports_files (GAppInfo *appinfo);
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_launch_uris (GAppInfo *appinfo,
|
|
GList *uris,
|
|
GAppLaunchContext *context,
|
|
GError **error);
|
|
GIO_AVAILABLE_IN_2_60
|
|
void g_app_info_launch_uris_async (GAppInfo *appinfo,
|
|
GList *uris,
|
|
GAppLaunchContext *context,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
GIO_AVAILABLE_IN_2_60
|
|
gboolean g_app_info_launch_uris_finish (GAppInfo *appinfo,
|
|
GAsyncResult *result,
|
|
GError **error);
|
|
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_should_show (GAppInfo *appinfo);
|
|
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_set_as_default_for_type (GAppInfo *appinfo,
|
|
const char *content_type,
|
|
GError **error);
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_set_as_default_for_extension (GAppInfo *appinfo,
|
|
const char *extension,
|
|
GError **error);
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_add_supports_type (GAppInfo *appinfo,
|
|
const char *content_type,
|
|
GError **error);
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_can_remove_supports_type (GAppInfo *appinfo);
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_remove_supports_type (GAppInfo *appinfo,
|
|
const char *content_type,
|
|
GError **error);
|
|
GIO_AVAILABLE_IN_2_34
|
|
const char **g_app_info_get_supported_types (GAppInfo *appinfo);
|
|
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_can_delete (GAppInfo *appinfo);
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_delete (GAppInfo *appinfo);
|
|
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_set_as_last_used_for_type (GAppInfo *appinfo,
|
|
const char *content_type,
|
|
GError **error);
|
|
|
|
GIO_AVAILABLE_IN_ALL
|
|
GList * g_app_info_get_all (void);
|
|
GIO_AVAILABLE_IN_ALL
|
|
GList * g_app_info_get_all_for_type (const char *content_type);
|
|
GIO_AVAILABLE_IN_ALL
|
|
GList * g_app_info_get_recommended_for_type (const gchar *content_type);
|
|
GIO_AVAILABLE_IN_ALL
|
|
GList * g_app_info_get_fallback_for_type (const gchar *content_type);
|
|
|
|
GIO_AVAILABLE_IN_ALL
|
|
void g_app_info_reset_type_associations (const char *content_type);
|
|
GIO_AVAILABLE_IN_ALL
|
|
GAppInfo *g_app_info_get_default_for_type (const char *content_type,
|
|
gboolean must_support_uris);
|
|
GIO_AVAILABLE_IN_2_74
|
|
void g_app_info_get_default_for_type_async (const char *content_type,
|
|
gboolean must_support_uris,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
GIO_AVAILABLE_IN_2_74
|
|
GAppInfo *g_app_info_get_default_for_type_finish (GAsyncResult *result,
|
|
GError **error);
|
|
GIO_AVAILABLE_IN_ALL
|
|
GAppInfo *g_app_info_get_default_for_uri_scheme (const char *uri_scheme);
|
|
|
|
GIO_AVAILABLE_IN_2_74
|
|
void g_app_info_get_default_for_uri_scheme_async (const char *uri_scheme,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
GIO_AVAILABLE_IN_2_74
|
|
GAppInfo *g_app_info_get_default_for_uri_scheme_finish (GAsyncResult *result,
|
|
GError **error);
|
|
|
|
GIO_AVAILABLE_IN_ALL
|
|
gboolean g_app_info_launch_default_for_uri (const char *uri,
|
|
GAppLaunchContext *context,
|
|
GError **error);
|
|
|
|
GIO_AVAILABLE_IN_2_50
|
|
void g_app_info_launch_default_for_uri_async (const char *uri,
|
|
GAppLaunchContext *context,
|
|
GCancellable *cancellable,
|
|
GAsyncReadyCallback callback,
|
|
gpointer user_data);
|
|
GIO_AVAILABLE_IN_2_50
|
|
gboolean g_app_info_launch_default_for_uri_finish (GAsyncResult *result,
|
|
GError **error);
|
|
|
|
|
|
/**
|
|
* GAppLaunchContext:
|
|
*
|
|
* Integrating the launch with the launching application. This is used to
|
|
* handle for instance startup notification and launching the new application
|
|
* on the same screen as the launching window.
|
|
*/
|
|
struct _GAppLaunchContext
|
|
{
|
|
GObject parent_instance;
|
|
|
|
/*< private >*/
|
|
GAppLaunchContextPrivate *priv;
|
|
};
|
|
|
|
struct _GAppLaunchContextClass
|
|
{
|
|
GObjectClass parent_class;
|
|
|
|
char * (* get_display) (GAppLaunchContext *context,
|
|
GAppInfo *info,
|
|
GList *files);
|
|
char * (* get_startup_notify_id) (GAppLaunchContext *context,
|
|
GAppInfo *info,
|
|
GList *files);
|
|
void (* launch_failed) (GAppLaunchContext *context,
|
|
const char *startup_notify_id);
|
|
void (* launched) (GAppLaunchContext *context,
|
|
GAppInfo *info,
|
|
GVariant *platform_data);
|
|
void (* launch_started) (GAppLaunchContext *context,
|
|
GAppInfo *info,
|
|
GVariant *platform_data);
|
|
|
|
/* Padding for future expansion */
|
|
void (*_g_reserved1) (void);
|
|
void (*_g_reserved2) (void);
|
|
void (*_g_reserved3) (void);
|
|
};
|
|
|
|
GIO_AVAILABLE_IN_ALL
|
|
GType g_app_launch_context_get_type (void) G_GNUC_CONST;
|
|
GIO_AVAILABLE_IN_ALL
|
|
GAppLaunchContext *g_app_launch_context_new (void);
|
|
|
|
GIO_AVAILABLE_IN_2_32
|
|
void g_app_launch_context_setenv (GAppLaunchContext *context,
|
|
const char *variable,
|
|
const char *value);
|
|
GIO_AVAILABLE_IN_2_32
|
|
void g_app_launch_context_unsetenv (GAppLaunchContext *context,
|
|
const char *variable);
|
|
GIO_AVAILABLE_IN_2_32
|
|
char ** g_app_launch_context_get_environment (GAppLaunchContext *context);
|
|
|
|
GIO_AVAILABLE_IN_ALL
|
|
char * g_app_launch_context_get_display (GAppLaunchContext *context,
|
|
GAppInfo *info,
|
|
GList *files);
|
|
GIO_AVAILABLE_IN_ALL
|
|
char * g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
|
|
GAppInfo *info,
|
|
GList *files);
|
|
GIO_AVAILABLE_IN_ALL
|
|
void g_app_launch_context_launch_failed (GAppLaunchContext *context,
|
|
const char * startup_notify_id);
|
|
|
|
#define G_TYPE_APP_INFO_MONITOR (g_app_info_monitor_get_type ())
|
|
#define G_APP_INFO_MONITOR(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
|
|
G_TYPE_APP_INFO_MONITOR, GAppInfoMonitor))
|
|
#define G_IS_APP_INFO_MONITOR(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
|
|
G_TYPE_APP_INFO_MONITOR))
|
|
|
|
typedef struct _GAppInfoMonitor GAppInfoMonitor;
|
|
|
|
GIO_AVAILABLE_IN_2_40
|
|
GType g_app_info_monitor_get_type (void);
|
|
|
|
GIO_AVAILABLE_IN_2_40
|
|
GAppInfoMonitor * g_app_info_monitor_get (void);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __G_APP_INFO_H__ */
|