Class (GI Class)

GioUnix-2.0GioUnixDesktopAppInfo

GioUnix.DesktopAppInfo is an implementation of Gio.AppInfo based on desktop files.

Note that <gio/gdesktopappinfo.h> belongs to the UNIX-specific GIO interfaces, thus you have to use the gio-unix-2.0.pc pkg-config file or the GioUnix-2.0 GIR namespace when using it.

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Methods - Inherited from GObject

Constructors

Properties

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.

Accessors

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 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.

  • Looks up a boolean value in the keyfile backing info.

    The key is looked up in the Desktop Entry group.

    Parameters

    • key: string

      the key to look up

    Returns boolean

    the boolean value, or FALSE if the key is not found

  • Gets the categories from the desktop file.

    Returns string | null

    The unparsed Categories key from the desktop file; i.e. no attempt is made to split it by ; or validate it.

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

    Returns string | null

    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 | null

    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 | null

    a string containing the application’s ID.

  • Looks up a localized string value in the keyfile backing info translated to the current locale.

    The key is looked up in the Desktop Entry group.

    Parameters

    • key: string

      the key to look up

    Returns string | null

    a newly allocated string, or NULL if the key is not found

  • Checks if the application info should be shown in menus that list available applications for a specific name of the desktop, based on the OnlyShowIn and NotShowIn keys.

    desktop_env should typically be given as NULL, in which case the XDG_CURRENT_DESKTOP environment variable is consulted. If you want to override the default mechanism then you may specify desktop_env, but this is not recommended.

    Note that Gio.AppInfo.should_show for info will include this check (with NULL for desktop_env) as well as additional checks.

    Parameters

    • desktop_env: string | null

      a string specifying a desktop name

    Returns boolean

    TRUE if the info should be shown in desktop_env according to the OnlyShowIn and NotShowIn keys, FALSE otherwise.

  • Retrieves the StartupWMClass field from info. This represents the WM_CLASS property of the main window of the application, if launched through info.

    Returns string | null

    the startup WM class, or NULL if none is set in the desktop file.

  • Looks up a string value in the keyfile backing info.

    The key is looked up in the Desktop Entry group.

    Parameters

    • key: string

      the key to look up

    Returns string | null

    a newly allocated string, or NULL if the key is not found

  • Looks up a string list value in the keyfile backing info.

    The key is looked up in the Desktop Entry group.

    Parameters

    • key: string

      the key to look up

    Returns string[]

    a NULL-terminated string array or NULL if the specified key cannot be found. The array should be freed with GLib.strfreev.

  • 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.

  • Returns whether key exists in the Desktop Entry group of the keyfile backing info.

    Parameters

    • key: string

      the key to look up

    Returns boolean

    TRUE if the key exists

  • 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

    • uris: string[] | null

      a list of URIs to launch.

    • context: Gio.AppLaunchContext | null

      the launch context

    Returns boolean

    TRUE on successful launch, FALSE otherwise.

  • Returns the list of ‘additional application actions’ supported on the desktop file, as per the desktop file specification.

    As per the specification, this is the list of actions that are explicitly listed in the Actions key of the Desktop Entry group.

    Returns string[]

    a list of strings, always non-NULL

  • 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.

  • 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.

  • 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 | null

  • 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

    • uris: string[] | null

      a list of URIs to launch.

    • context: Gio.AppLaunchContext | null

      the launch context

    Returns boolean

  • Gets all applications that implement interface.

    An application implements an interface if that interface is listed in the Implements line of the desktop file of the application.

    Parameters

    • _interface: string

      the name of the interface

    Returns GioUnix.DesktopAppInfo[]

  • Searches desktop files for ones that match search_string.

    The return value is an array of strvs. Each strv contains a list of applications that matched search_string with an equal score. The outer list is sorted by score so that the first strv contains the best-matching applications, and so on. The algorithm for determining matches is undefined and may change at any time.

    None of the search results are subjected to the normal validation checks performed by GioUnix.DesktopAppInfo.new (for example, checking that the executable referenced by a result exists), and so it is possible for GioUnix.DesktopAppInfo.new to return NULL when passed an app ID returned by this function. It is expected that calling code will do this when subsequently creating a GioUnix.DesktopAppInfo for each result.

    Parameters

    • search_string: string

      the search string to use

    Returns string[][]

Methods - Inherited from GObject

  • 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.

  • 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

  • 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

  • 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

  • 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

    • data: any

      data to associate with that key

    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

  • 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

  • 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

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created GObject.ParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of GObject.TypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures