gio/org.gtkkn.bindings.gio/DesktopAppInfo

DesktopAppInfo

open class DesktopAppInfo(pointer: <Error class: unknown class><<Error class: unknown class>>) : AppInfo

GDesktopAppInfo is an implementation of iface@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.

Skipped during bindings generation

parameter length: length: Out parameter is not supported
function search: Nested array types are not supported

Constructors

DesktopAppInfo

constructor(desktopId: String)

Creates a new class@Gio.DesktopAppInfo based on a desktop file ID.

constructor(keyFile: <Error class: unknown class>)

Creates a new class@Gio.DesktopAppInfo.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

filename

open val filename: String?

The origin filename of this class@Gio.DesktopAppInfo

gioAppInfoPointer

open override val gioAppInfoPointer: <Error class: unknown class><<Error class: unknown class>>

gioDesktopAppInfoPointer

val gioDesktopAppInfoPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

addSupportsType

open fun addSupportsType(contentType: String): <Error class: unknown class><Boolean>

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

canDelete

open fun canDelete(): Boolean

Obtains the information whether the iface@Gio.AppInfo can be deleted. See method@Gio.AppInfo.delete.

canRemoveSupportsType

open fun canRemoveSupportsType(): Boolean

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

delete

open fun delete(): Boolean

Tries to delete a iface@Gio.AppInfo.

dup

open fun dup(): AppInfo

Creates a duplicate of a iface@Gio.AppInfo.

equal

open fun equal(appinfo2: AppInfo): Boolean

Checks if two iface@Gio.AppInfos are equal.

getActionName

open fun getActionName(actionName: String): String

Gets the user-visible display name of the ‘additional application actions’ specified by @action_name.

getBoolean

open fun getBoolean(key: String): Boolean

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

getCategories

open fun getCategories(): String?

Gets the categories from the desktop file.

getCommandline

open fun getCommandline(): String?

Gets the commandline with which the application will be started.

getDescription

open fun getDescription(): String?

Gets a human-readable description of an installed application.

getDisplayName

open fun getDisplayName(): String

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

getExecutable

open fun getExecutable(): String

Gets the executable’s name for the installed application.

getGenericName

open fun getGenericName(): String?

Gets the generic name from the desktop file.

getIcon

open fun getIcon(): Icon?

Gets the icon for the application.

getId

open fun getId(): 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.

getIsHidden

open fun getIsHidden(): Boolean

A desktop file is hidden if the Hidden key in it is set to True.

getKeywords

open fun getKeywords(): List<String>

Gets the keywords from the desktop file.

getLocaleString

open fun getLocaleString(key: String): String?

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

getName

open fun getName(): String

Gets the installed name of the application.

getNodisplay

open fun getNodisplay(): Boolean

Gets the value of the NoDisplay key which helps determine if the application info should be shown in menus. See G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY and method@Gio.AppInfo.should_show.

getShowIn

open fun getShowIn(desktopEnv: String? = null): Boolean

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.

getStartupWmClass

open fun getStartupWmClass(): String?

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

getString

open fun getString(key: String): String?

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

getSupportedTypes

open fun getSupportedTypes(): List<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.

hasKey

open fun hasKey(key: String): Boolean

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

launch

open fun launch(files: <Error class: unknown class>? = null, context: AppLaunchContext? = null): <Error class: unknown class><Boolean>

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.

launchAction

open fun launchAction(actionName: String, launchContext: AppLaunchContext? = null)

Activates the named application action.

launchUris

open fun launchUris(uris: <Error class: unknown class>? = null, context: AppLaunchContext? = null): <Error class: unknown class><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.

launchUrisAsManager

open fun launchUrisAsManager(uris: <Error class: unknown class>, launchContext: AppLaunchContext? = null, spawnFlags: <Error class: unknown class>, userSetup: <Error class: unknown class>?, pidCallback: DesktopAppLaunchCallback?): <Error class: unknown class><Boolean>

This function performs the equivalent of method@Gio.AppInfo.launch_uris, but is intended primarily for operating system components that launch applications. Ordinary applications should use method@Gio.AppInfo.launch_uris.

launchUrisAsManagerWithFds

open fun launchUrisAsManagerWithFds(uris: <Error class: unknown class>, launchContext: AppLaunchContext? = null, spawnFlags: <Error class: unknown class>, userSetup: <Error class: unknown class>?, pidCallback: DesktopAppLaunchCallback?, stdinFd: <Error class: unknown class>, stdoutFd: <Error class: unknown class>, stderrFd: <Error class: unknown class>): <Error class: unknown class><Boolean>

Equivalent to method@Gio.DesktopAppInfo.launch_uris_as_manager but allows you to pass in file descriptors for the stdin, stdout and stderr streams of the launched process.

launchUrisAsync

open fun launchUrisAsync(uris: <Error class: unknown class>? = null, context: AppLaunchContext? = null, cancellable: Cancellable? = null, callback: AsyncReadyCallback?)

Async version of method@Gio.AppInfo.launch_uris.

launchUrisFinish

open fun launchUrisFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Finishes a method@Gio.AppInfo.launch_uris_async operation.

listActions

open fun listActions(): List<String>

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

removeSupportsType

open fun removeSupportsType(contentType: String): <Error class: unknown class><Boolean>

Removes a supported type from an application, if possible.

setAsDefaultForExtension

open fun setAsDefaultForExtension(extension: String): <Error class: unknown class><Boolean>

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

setAsDefaultForType

open fun setAsDefaultForType(contentType: String): <Error class: unknown class><Boolean>

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

setAsLastUsedForType

open fun setAsLastUsedForType(contentType: String): <Error class: unknown class><Boolean>

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 func@Gio.AppInfo.get_recommended_for_type, regardless of the default application for that content type.

shouldShow

open fun shouldShow(): Boolean

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

supportsFiles

open fun supportsFiles(): Boolean

Checks if the application accepts files as arguments.

supportsUris

open fun supportsUris(): Boolean

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