Interface (GI Interface)

Gio-2.0 ▶ Gio ▶ AppInfo

Information about an installed application and methods to launch it (with file arguments).

Gio.AppInfo and Gio.AppLaunchContext are used for describing and launching applications installed on the system.

As of GLib 2.20, URIs will always be converted to POSIX paths (using Gio.File.get_path) when using Gio.AppInfo.launch even if the application requested an URI and not a POSIX path. For example for a desktop-file based application with the following Exec key:

Exec=totem `U`

and a single URI, sftp://foo/file.avi, then /home/user/.gvfs/sftp on foo/file.avi will be passed. This will only work if a set of suitable GIO extensions (such as GVfs 2.26 compiled with FUSE support), is available and operational; if this is not the case, the URI will be passed unmodified to the application. Some URIs, such as mailto:, of course cannot be mapped to a POSIX path (in GVfs there’s no FUSE mount for it); such URIs will be passed unmodified to the application.

Specifically for GVfs 2.26 and later, the POSIX URI will be mapped back to the GIO URI in the Gio.File constructors (since GVfs implements the GVfs extension point). As such, if the application needs to examine the URI, it needs to use Gio.File.get_uri or similar on Gio.File. In other words, an application cannot assume that the URI passed to e.g. Gio.File.new_for_commandline_arg is equal to the result of Gio.File.get_uri. The following snippet illustrates this:

GFile *f;
char *uri;

file = g_file_new_for_commandline_arg (uri_from_commandline);

uri = g_file_get_uri (file);
strcmp (uri, uri_from_commandline) == 0;
g_free (uri);

if (g_file_has_uri_scheme (file, "cdda"))
  {
    // do something special with uri
  }
g_object_unref (file);

This code will work when both cdda://sr0/Track 1.wav and /home/user/.gvfs/cdda on sr0/Track 1.wav is passed to the application. It should be noted that it’s generally not safe for applications to rely on the format of a particular URIs. Different launcher applications (e.g. file managers) may have different ideas of what a given URI means.

interface AppInfo {
    $signals: GObject.Object.SignalSignatures;
    _init(...args: any[]): void;
    add_supports_type(content_type: string): boolean;
    bind_property(
        source_property: string,
        target: GObject.Object,
        target_property: string,
        flags: GObject.BindingFlags,
    ): GObject.Binding;
    bind_property_full(
        source_property: string,
        target: GObject.Object,
        target_property: string,
        flags: GObject.BindingFlags,
        transform_to?: BindingTransformFunc,
        transform_from?: BindingTransformFunc,
        notify?: DestroyNotify,
    ): GObject.Binding;
    bind_property_full(
        source_property: string,
        target: GObject.Object,
        target_property: string,
        flags: GObject.BindingFlags,
        transform_to: Closure<any, any>,
        transform_from: Closure<any, any>,
    ): GObject.Binding;
    block_signal_handler(id: number): void;
    can_delete(): boolean;
    can_remove_supports_type(): boolean;
    connect<K extends "notify">(
        signal: K,
        callback: SignalCallback<Gio.AppInfo, GObject.Object.SignalSignatures[K]>,
    ): number;
    connect(signal: string, callback: (...args: any[]) => any): number;
    connect_after<K extends "notify">(
        signal: K,
        callback: SignalCallback<Gio.AppInfo, GObject.Object.SignalSignatures[K]>,
    ): number;
    connect_after(signal: string, callback: (...args: any[]) => any): number;
    delete(): boolean;
    disconnect(id: number): void;
    dup(): Gio.AppInfo;
    emit<K extends "notify">(
        signal: K,
        ...args: GjsParameters<GObject.Object.SignalSignatures[K]> extends [
            any,
            ...Q[],
        ]
            ? Q
            : never,
    ): void;
    emit(signal: string, ...args: any[]): void;
    equal(appinfo2: Gio.AppInfo): boolean;
    force_floating(): void;
    freeze_notify(): void;
    get_commandline(): string;
    get_data(key: string): any;
    get_description(): string;
    get_display_name(): string;
    get_executable(): string;
    get_icon(): Gio.Icon;
    get_id(): string;
    get_name(): string;
    get_property(property_name: string, value: any): any;
    get_qdata(quark: number): any;
    get_supported_types(): string[];
    getv(names: string[], values: any[]): void;
    is_floating(): boolean;
    launch(files?: Gio.File[], context?: Gio.AppLaunchContext): boolean;
    launch_uris(uris?: string[], context?: Gio.AppLaunchContext): boolean;
    launch_uris_async(
        uris?: string[],
        context?: Gio.AppLaunchContext,
        cancellable?: Gio.Cancellable,
    ): Promise<boolean>;
    launch_uris_async(
        uris: string[],
        context: Gio.AppLaunchContext,
        cancellable: Gio.Cancellable,
        callback: AsyncReadyCallback<Gio.AppInfo>,
    ): void;
    launch_uris_async(
        uris?: string[],
        context?: Gio.AppLaunchContext,
        cancellable?: Gio.Cancellable,
        callback?: AsyncReadyCallback<Gio.AppInfo>,
    ): void | Promise<boolean>;
    launch_uris_finish(result: Gio.AsyncResult): boolean;
    notify(property_name: string): void;
    notify_by_pspec(pspec: GObject.ParamSpec): void;
    ref(): GObject.Object;
    ref_sink(): GObject.Object;
    remove_supports_type(content_type: string): boolean;
    run_dispose(): void;
    set(properties: { [key: string]: any }): void;
    set_as_default_for_extension(extension: string): boolean;
    set_as_default_for_type(content_type: string): boolean;
    set_as_last_used_for_type(content_type: string): boolean;
    set_data(key: string, data?: any): void;
    set_property(property_name: string, value: any): void;
    should_show(): boolean;
    steal_data(key: string): any;
    steal_qdata(quark: number): any;
    stop_emission_by_name(detailedName: string): void;
    supports_files(): boolean;
    supports_uris(): boolean;
    thaw_notify(): void;
    unblock_signal_handler(id: number): void;
    unref(): void;
    vfunc_add_supports_type(content_type: string): boolean;
    vfunc_can_delete(): boolean;
    vfunc_can_remove_supports_type(): boolean;
    vfunc_constructed(): void;
    vfunc_dispatch_properties_changed(
        n_pspecs: number,
        pspecs: GObject.ParamSpec,
    ): void;
    vfunc_dispose(): void;
    vfunc_do_delete(): boolean;
    vfunc_dup(): Gio.AppInfo;
    vfunc_equal(appinfo2: Gio.AppInfo): boolean;
    vfunc_finalize(): void;
    vfunc_get_commandline(): string;
    vfunc_get_description(): string;
    vfunc_get_display_name(): string;
    vfunc_get_executable(): string;
    vfunc_get_icon(): Gio.Icon;
    vfunc_get_id(): string;
    vfunc_get_name(): string;
    vfunc_get_property(
        property_id: number,
        value: any,
        pspec: GObject.ParamSpec,
    ): void;
    vfunc_get_supported_types(): string[];
    vfunc_launch(files?: Gio.File[], context?: Gio.AppLaunchContext): boolean;
    vfunc_launch_uris(uris?: string[], context?: Gio.AppLaunchContext): boolean;
    vfunc_launch_uris_async(
        uris?: string[],
        context?: Gio.AppLaunchContext,
        cancellable?: Gio.Cancellable,
        callback?: AsyncReadyCallback<Gio.AppInfo>,
    ): void;
    vfunc_launch_uris_finish(result: Gio.AsyncResult): boolean;
    vfunc_notify(pspec: GObject.ParamSpec): void;
    vfunc_remove_supports_type(content_type: string): boolean;
    vfunc_set_as_default_for_extension(extension: string): boolean;
    vfunc_set_as_default_for_type(content_type: string): boolean;
    vfunc_set_as_last_used_for_type(content_type: string): boolean;
    vfunc_set_property(
        property_id: number,
        value: any,
        pspec: GObject.ParamSpec,
    ): void;
    vfunc_should_show(): boolean;
    vfunc_supports_files(): boolean;
    vfunc_supports_uris(): boolean;
    watch_closure(closure: Closure): void;
}

Hierarchy (View Summary)

Index

Properties - Inherited from GObject

$signals

Methods

add_supports_type can_delete can_remove_supports_type delete dup equal get_commandline get_description get_display_name get_executable get_icon get_id get_name get_supported_types launch launch_uris launch_uris_async launch_uris_finish remove_supports_type set_as_default_for_extension set_as_default_for_type set_as_last_used_for_type should_show supports_files supports_uris

Methods - Inherited from GObject

_init bind_property bind_property_full block_signal_handler connect connect_after disconnect emit force_floating freeze_notify get_data get_property get_qdata getv is_floating notify notify_by_pspec ref ref_sink run_dispose set set_data set_property steal_data steal_qdata stop_emission_by_name thaw_notify unblock_signal_handler unref vfunc_constructed vfunc_dispatch_properties_changed vfunc_dispose vfunc_finalize vfunc_get_property vfunc_notify vfunc_set_property watch_closure

Methods - Inherited from Gio.AppInfo.Interface

vfunc_add_supports_type vfunc_can_delete vfunc_can_remove_supports_type vfunc_do_delete vfunc_dup vfunc_equal vfunc_get_commandline vfunc_get_description vfunc_get_display_name vfunc_get_executable vfunc_get_icon vfunc_get_id vfunc_get_name vfunc_get_supported_types vfunc_launch vfunc_launch_uris vfunc_launch_uris_async vfunc_launch_uris_finish vfunc_remove_supports_type vfunc_set_as_default_for_extension vfunc_set_as_default_for_type vfunc_set_as_last_used_for_type vfunc_should_show vfunc_supports_files vfunc_supports_uris

Properties - Inherited from GObject

$signals: GObject.Object.SignalSignatures

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

Methods

  • Adds a content type to the application information to indicate the application is capable of opening files with the given content type.

    Parameters

    • content_type: string

      a string.

    Returns boolean

    TRUE on success, FALSE on error.

  • Checks if a supported content type can be removed from an application.

    Returns boolean

    TRUE if it is possible to remove supported content types from a given appinfo, FALSE if not.

  • Checks if two Gio.AppInfos are equal.

    Note that the check may not compare each individual field, and only does an identity check. In case detecting changes in the contents is needed, program code must additionally compare relevant fields.

    Parameters

    Returns boolean

    TRUE if appinfo1 is equal to appinfo2. FALSE otherwise.

  • Gets the commandline with which the application will be started.

    Returns string

    a string containing the appinfo’s commandline, or NULL if this information is not available

  • Gets a human-readable description of an installed application.

    Returns string

    a string containing a description of the application appinfo, or NULL if none.

  • Gets the display name of the application. The display name is often more descriptive to the user than the name itself.

    Returns string

    the display name of the application for appinfo, or the name if no display name is available.

  • Gets the executable’s name for the installed application.

    This is intended to be used for debugging or labelling what program is going to be run. To launch the executable, use Gio.AppInfo.launch and related functions, rather than spawning the return value from this function.

    Returns string

    a string containing the appinfo’s application binaries name

  • Gets the ID of an application. An id is a string that identifies the application. The exact format of the id is platform dependent. For instance, on Unix this is the desktop file id from the xdg menu specification.

    Note that the returned ID may be NULL, depending on how the appinfo has been constructed.

    Returns string

    a string containing the application’s ID.

  • Gets the installed name of the application.

    Returns string

    the name of the application for appinfo.

  • Retrieves the list of content types that app_info claims to support. If this information is not provided by the environment, this function will return NULL.

    This function does not take in consideration associations added with Gio.AppInfo.add_supports_type, but only those exported directly by the application.

    Returns string[]

    a list of content types.

  • Launches the application. Passes files to the launched application as arguments, using the optional context to get information about the details of the launcher (like what screen it is on). On error, error will be set accordingly.

    To launch the application without arguments pass a NULL files list.

    Note that even if the launch is successful the application launched can fail to start if it runs into problems during startup. There is no way to detect this.

    Some URIs can be changed when passed through a GFile (for instance unsupported URIs with strange formats like mailto:), so if you have a textual URI you want to pass in as argument, consider using Gio.AppInfo.launch_uris instead.

    The launched application inherits the environment of the launching process, but it can be modified with Gio.AppLaunchContext.setenv and Gio.AppLaunchContext.unsetenv.

    On UNIX, this function sets the GIO_LAUNCHED_DESKTOP_FILE environment variable with the path of the launched desktop file and GIO_LAUNCHED_DESKTOP_FILE_PID to the process id of the launched process. This can be used to ignore GIO_LAUNCHED_DESKTOP_FILE, should it be inherited by further processes. The DISPLAY, XDG_ACTIVATION_TOKEN and DESKTOP_STARTUP_ID environment variables are also set, based on information provided in context.

    Parameters

    Returns boolean

    TRUE on successful launch, FALSE otherwise.

  • Launches the application. This passes the uris to the launched application as arguments, using the optional context to get information about the details of the launcher (like what screen it is on). On error, error will be set accordingly. If the application only supports one URI per invocation as part of their command-line, multiple instances of the application will be spawned.

    To launch the application without arguments pass a NULL uris list.

    Note that even if the launch is successful the application launched can fail to start if it runs into problems during startup. There is no way to detect this.

    Parameters

    • Optionaluris: string[]

      a list of URIs to launch.

    • Optionalcontext: Gio.AppLaunchContext

      the launch context

    Returns boolean

    TRUE on successful launch, FALSE otherwise.

  • Removes a supported type from an application, if possible.

    Parameters

    • content_type: string

      a string.

    Returns boolean

    TRUE on success, FALSE on error.

  • Sets the application as the default handler for the given file extension.

    Parameters

    • extension: string

      a string containing the file extension (without the dot).

    Returns boolean

    TRUE on success, FALSE on error.

  • Sets the application as the default handler for a given type.

    Parameters

    • content_type: string

      the content type.

    Returns boolean

    TRUE on success, FALSE on error.

  • Sets the application as the last used application for a given type. This will make the application appear as first in the list returned by Gio.AppInfo.get_recommended_for_type, regardless of the default application for that content type.

    Parameters

    • content_type: string

      the content type.

    Returns boolean

    TRUE on success, FALSE on error.

  • Checks if the application info should be shown in menus that list available applications.

    Returns boolean

    TRUE if the appinfo should be shown, FALSE otherwise.

  • Checks if the application accepts files as arguments.

    Returns boolean

    TRUE if the appinfo supports files.

  • Checks if the application supports reading files and directories from URIs.

    Returns boolean

    TRUE if the appinfo supports URIs.

Methods - Inherited from GObject

_init

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);

    Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned GObject.Binding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A GObject.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well. The transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using GClosures instead of function pointers.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • This function is intended for GObject.Object implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one GObject.Object::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      typedef enum
      {
        PROP_FOO = 1,
        PROP_LAST
      } MyObjectProperty;

      static GParamSpec *properties[PROP_LAST];

      static void
      my_object_class_init (MyObjectClass *klass)
      {
        properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
                                                 0, 100,
                                                 50,
                                                 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
        g_object_class_install_property (gobject_class,
                                         PROP_FOO,
                                         properties[PROP_FOO]);
      }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);

    Parameters

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

    the same object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

    object

  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a GLib.Quark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Sets a property on an object.

    Parameters

    • property_name: string

      The name of the property to set

    • value: any

      The value to set the property to

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject     *object,
                             const gchar *new_string)
    {
      // the quark, naming the object data
      GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
      // retrieve the old string list
      GList *list = g_object_steal_qdata (object, quark_string_list);

      // prepend new string
      list = g_list_prepend (list, g_strdup (new_string));
      // this changed 'list', so we need to set it again
      g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
      GList *node, *list = data;

      for (node = list; node; node = node->next)
        g_free (node->data);
      g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.

    Parameters

    • detailedName: string

      Name of the signal to stop emission of

    Returns void

  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the GObject.Object may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to null rather than retain a dangling pointer to a potentially invalid GObject.Object instance. Use g_clear_object() for this.

    Returns void

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns void

  • instance finalization function, should finish the finalization of the instance begun in dispose and chain up to the finalize method of the parent class.

    Returns void

  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns void

  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    Returns void

Methods - Inherited from Gio.AppInfo.Interface

  • Adds a content type to the application information to indicate the application is capable of opening files with the given content type.

    Parameters

    • content_type: string

      a string.

    Returns boolean

  • Gets the executable’s name for the installed application.

    This is intended to be used for debugging or labelling what program is going to be run. To launch the executable, use Gio.AppInfo.launch and related functions, rather than spawning the return value from this function.

    Returns string

  • Gets the ID of an application. An id is a string that identifies the application. The exact format of the id is platform dependent. For instance, on Unix this is the desktop file id from the xdg menu specification.

    Note that the returned ID may be NULL, depending on how the appinfo has been constructed.

    Returns string

  • Retrieves the list of content types that app_info claims to support. If this information is not provided by the environment, this function will return NULL.

    This function does not take in consideration associations added with Gio.AppInfo.add_supports_type, but only those exported directly by the application.

    Returns string[]

  • Launches the application. Passes files to the launched application as arguments, using the optional context to get information about the details of the launcher (like what screen it is on). On error, error will be set accordingly.

    To launch the application without arguments pass a NULL files list.

    Note that even if the launch is successful the application launched can fail to start if it runs into problems during startup. There is no way to detect this.

    Some URIs can be changed when passed through a GFile (for instance unsupported URIs with strange formats like mailto:), so if you have a textual URI you want to pass in as argument, consider using Gio.AppInfo.launch_uris instead.

    The launched application inherits the environment of the launching process, but it can be modified with Gio.AppLaunchContext.setenv and Gio.AppLaunchContext.unsetenv.

    On UNIX, this function sets the GIO_LAUNCHED_DESKTOP_FILE environment variable with the path of the launched desktop file and GIO_LAUNCHED_DESKTOP_FILE_PID to the process id of the launched process. This can be used to ignore GIO_LAUNCHED_DESKTOP_FILE, should it be inherited by further processes. The DISPLAY, XDG_ACTIVATION_TOKEN and DESKTOP_STARTUP_ID environment variables are also set, based on information provided in context.

    Parameters

    Returns boolean

  • Launches the application. This passes the uris to the launched application as arguments, using the optional context to get information about the details of the launcher (like what screen it is on). On error, error will be set accordingly. If the application only supports one URI per invocation as part of their command-line, multiple instances of the application will be spawned.

    To launch the application without arguments pass a NULL uris list.

    Note that even if the launch is successful the application launched can fail to start if it runs into problems during startup. There is no way to detect this.

    Parameters

    • Optionaluris: string[]

      a list of URIs to launch.

    • Optionalcontext: Gio.AppLaunchContext

      the launch context

    Returns boolean

Interfaces

ConstructorProps
Interface