DesktopAppInfo

gio.DesktopAppInfo is an implementation of GAppInfo 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 when using it.

class DesktopAppInfo : ObjectG , AppInfoIF {

protected

GDesktopAppInfo* gDesktopAppInfo;

GDesktopAppInfo* getDesktopAppInfoStruct(bool transferOwnership);

void* getStruct();

this(GDesktopAppInfo* gDesktopAppInfo, bool ownedRef);

static DesktopAppInfo createFromFilename(string filename);

static GType getType();

this(string desktopId);

this(KeyFile keyFile);

static ListG getImplementations(string interface_);

static string[][] search(string searchString);

static void setDesktopEnv(string desktopEnv);

string getActionName(string actionName);

bool getBoolean(string key);

string getCategories();

string getFilename();

string getGenericName();

bool getIsHidden();

string[] getKeywords();

string getLocaleString(string key);

bool getNodisplay();

bool getShowIn(string desktopEnv);

string getStartupWmClass();

string getString(string key);

string[] getStringList(string key);

bool hasKey(string key);

void launchAction(string actionName, AppLaunchContext launchContext);

bool launchUrisAsManager(ListG uris, AppLaunchContext launchContext, GSpawnFlags spawnFlags, GSpawnChildSetupFunc userSetup, void* userSetupData, GDesktopAppLaunchCallback pidCallback, void* pidCallbackData);

bool launchUrisAsManagerWithFds(ListG uris, AppLaunchContext launchContext, GSpawnFlags spawnFlags, GSpawnChildSetupFunc userSetup, void* userSetupData, GDesktopAppLaunchCallback pidCallback, void* pidCallbackData, int stdinFd, int stdoutFd, int stderrFd);

string[] listActions();

}

Constructors

this this(GDesktopAppInfo* gDesktopAppInfo, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(string desktopId): Creates a new gio.DesktopAppInfo based on a desktop file id.
this this(KeyFile keyFile): Creates a new gio.DesktopAppInfo

Members

Functions

getActionName string getActionName(string actionName): Gets the user-visible display name of the "additional application action" specified by action_name.
getBoolean bool getBoolean(string key): Looks up a boolean value in the keyfile backing info.
getCategories string getCategories(): Gets the categories from the desktop file.
getDesktopAppInfoStruct GDesktopAppInfo* getDesktopAppInfoStruct(bool transferOwnership): Get the main Gtk struct
getFilename string getFilename(): When info was created from a known filename, return it. In some situations such as the gio.DesktopAppInfo returned from DesktopAppInfo.newFromKeyfile, this function will return NULL.
getGenericName string getGenericName(): Gets the generic name from the destkop file.
getIsHidden bool getIsHidden(): A desktop file is hidden if the Hidden key in it is set to True.
getKeywords string[] getKeywords(): Gets the keywords from the desktop file.
getLocaleString string getLocaleString(string key): Looks up a localized string value in the keyfile backing info translated to the current locale.
getNodisplay bool getNodisplay(): 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 g_app_info_should_show().
getShowIn bool getShowIn(string desktopEnv): 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 string getStartupWmClass(): Retrieves the StartupWMClass field from info. This represents the WM_CLASS property of the main window of the application, if launched through info.
getString string getString(string key): Looks up a string value in the keyfile backing info.
getStringList string[] getStringList(string key): Looks up a string list value in the keyfile backing info.
getStruct void* getStruct(): the main Gtk struct as a void*
hasKey bool hasKey(string key): Returns whether key exists in the "Desktop Entry" group of the keyfile backing info.
launchAction void launchAction(string actionName, AppLaunchContext launchContext): Activates the named application action.
launchUrisAsManager bool launchUrisAsManager(ListG uris, AppLaunchContext launchContext, GSpawnFlags spawnFlags, GSpawnChildSetupFunc userSetup, void* userSetupData, GDesktopAppLaunchCallback pidCallback, void* pidCallbackData): This function performs the equivalent of g_app_info_launch_uris(), but is intended primarily for operating system components that launch applications. Ordinary applications should use g_app_info_launch_uris().
launchUrisAsManagerWithFds bool launchUrisAsManagerWithFds(ListG uris, AppLaunchContext launchContext, GSpawnFlags spawnFlags, GSpawnChildSetupFunc userSetup, void* userSetupData, GDesktopAppLaunchCallback pidCallback, void* pidCallbackData, int stdinFd, int stdoutFd, int stderrFd): Equivalent to DesktopAppInfo.launchUrisAsManager but allows you to pass in file descriptors for the stdin, stdout and stderr streams of the launched process.
listActions string[] listActions(): Returns the list of "additional application actions" supported on the desktop file, as per the desktop file specification.

Static functions

createFromFilename DesktopAppInfo createFromFilename(string filename): Creates a new gio.DesktopAppInfo
getImplementations ListG getImplementations(string interface_): Gets all applications that implement interface.
getType GType getType()
search string[][] search(string searchString): Searches desktop files for ones that match search_string.
setDesktopEnv void setDesktopEnv(string desktopEnv): Sets the name of the desktop that the application is running in. This is used by g_app_info_should_show() and DesktopAppInfo.getShowIn to evaluate the OnlyShowIn and NotShowIn desktop entry fields.

Variables

gDesktopAppInfo GDesktopAppInfo* gDesktopAppInfo;: the main Gtk struct

Inherited Members

From ObjectG

gObject GObject* gObject;: the main Gtk struct
getObjectGStruct GObject* getObjectGStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
opCast T opCast()
getDObject RT getDObject(U obj, bool ownedRef): Gets a D Object from the objects table of associations.
setProperty void setProperty(string propertyName, T value)
addOnNotify gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property, ConnectFlags connectFlags): The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.
getType GType getType()
compatControl size_t compatControl(size_t what, void* data)
interfaceFindProperty ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName): Find the gobject.ParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
interfaceInstallProperty void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec): 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 ObjectClass.overrideProperty 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.
interfaceListProperties ParamSpec[] interfaceListProperties(TypeInterface gIface): Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
addToggleRef void addToggleRef(GToggleNotify notify, void* data): Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.
addWeakPointer void addWeakPointer(void* weakPointerLocation): Adds a weak reference from weak_pointer to object to indicate that the pointer located at weak_pointer_location is only valid during the lifetime of object. When the object is finalized, weak_pointer will be set to NULL.
bindProperty Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags): 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:
bindPropertyFull Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify): Complete version of g_object_bind_property().
bindPropertyWithClosures Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, Closure transformFrom): 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.
dupData void* dupData(string key, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_data() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
dupQdata void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
forceFloating void forceFloating(): This function is intended for GObject 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().
freezeNotify void freezeNotify(): 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 notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see g_object_set_data()).
getProperty void getProperty(string propertyName, Value value): Gets a property of an object.
getQdata void* getQdata(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata().
getValist void getValist(string firstPropertyName, void* varArgs): Gets properties of an object.
getv void getv(string[] names, Value[] values): 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.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
ref_ ObjectG ref_(): Increases the reference count of object.
refSink ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
removeToggleRef void removeToggleRef(GToggleNotify notify, void* data): Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.
removeWeakPointer void removeWeakPointer(void* weakPointerLocation): Removes a weak reference from object that was previously added using g_object_add_weak_pointer(). The weak_pointer_location has to match the one used with g_object_add_weak_pointer().
replaceData bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key key on object with oldval, and if they are the same, replaces oldval with newval.
replaceQdata bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key quark on object with oldval, and if they are the same, replaces oldval with newval.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setDataFull void setDataFull(string key, void* data, GDestroyNotify destroy): Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.
setProperty void setProperty(string propertyName, Value value): Sets a property on an object.
setQdata void setQdata(GQuark quark, void* data): This sets an opaque, named pointer on an object. The name is specified through a GQuark (retrived e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the object with g_object_get_qdata() until the object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using NULL as pointer essentially removes the data stored.
setQdataFull void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy): This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with data as argument when the object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same quark.
setValist void setValist(string firstPropertyName, void* varArgs): Sets properties on an object.
setv void setv(string[] names, Value[] values): Sets n_properties properties for an object. Properties to be set will be taken from values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(GQuark quark): 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:
thawNotify void thawNotify(): 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.
unref void unref(): Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).
watchClosure void watchClosure(Closure closure): 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 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.
weakRef void weakRef(GWeakNotify notify, void* data): Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).
weakUnref void weakUnref(GWeakNotify notify, void* data): Removes a weak reference callback to an object.
clearObject void clearObject(ObjectG objectPtr): Clears a reference to a GObject

From AppInfoIF

getAppInfoStruct GAppInfo* getAppInfoStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
createFromCommandline AppInfoIF createFromCommandline(string commandline, string applicationName, GAppInfoCreateFlags flags): Creates a new GAppInfo from the given information.
getAll ListG getAll(): Gets a list of all of the applications currently registered on this system.
getAllForType ListG getAllForType(string contentType): Gets a list of all GAppInfos for a given content type, including the recommended and fallback GAppInfos See g_app_info_get_recommended_for_type() and g_app_info_get_fallback_for_type().
getDefaultForType AppInfoIF getDefaultForType(string contentType, bool mustSupportUris): Gets the default GAppInfo for a given content type.
getDefaultForUriScheme AppInfoIF getDefaultForUriScheme(string uriScheme): Gets the default application for handling URIs with the given URI scheme. A URI scheme is the initial part of the URI, up to but not including the ':', e.g. "http", "ftp" or "sip".
getFallbackForType ListG getFallbackForType(string contentType): Gets a list of fallback GAppInfos for a given content type, i.e. those applications which claim to support the given content type by MIME type subclassing and not directly.
getRecommendedForType ListG getRecommendedForType(string contentType): Gets a list of recommended GAppInfos for a given content type, i.e. those applications which claim to support the given content type exactly, and not by MIME type subclassing. Note that the first application of the list is the last used one, i.e. the last one for which g_app_info_set_as_last_used_for_type() has been called.
launchDefaultForUri bool launchDefaultForUri(string uri, AppLaunchContext context): Utility function that launches the default application registered to handle the specified uri. Synchronous I/O is done on the uri to detect the type of the file if required.
launchDefaultForUriAsync void launchDefaultForUriAsync(string uri, AppLaunchContext context, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Async version of g_app_info_launch_default_for_uri().
launchDefaultForUriFinish bool launchDefaultForUriFinish(AsyncResultIF result): Finishes an asynchronous launch-default-for-uri operation.
resetTypeAssociations void resetTypeAssociations(string contentType): Removes all changes to the type associations done by g_app_info_set_as_default_for_type(), g_app_info_set_as_default_for_extension(), g_app_info_add_supports_type() or g_app_info_remove_supports_type().
addSupportsType bool addSupportsType(string contentType): Adds a content type to the application information to indicate the application is capable of opening files with the given content type.
canDelete bool canDelete(): Obtains the information whether the GAppInfo can be deleted. See g_app_info_delete().
canRemoveSupportsType bool canRemoveSupportsType(): Checks if a supported content type can be removed from an application.
delete_ bool delete_(): Tries to delete a GAppInfo
dup AppInfoIF dup(): Creates a duplicate of a GAppInfo
equal bool equal(AppInfoIF appinfo2): Checks if two GAppInfos are equal.
getCommandline string getCommandline(): Gets the commandline with which the application will be started.
getDescription string getDescription(): Gets a human-readable description of an installed application.
getDisplayName string getDisplayName(): Gets the display name of the application. The display name is often more descriptive to the user than the name itself.
getExecutable string getExecutable(): Gets the executable's name for the installed application.
getIcon IconIF getIcon(): Gets the icon for the application.
getId string getId(): 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.
getName string getName(): Gets the installed name of the application.
getSupportedTypes string[] getSupportedTypes(): 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 g_app_info_add_supports_type(), but only those exported directly by the application.
launch bool launch(ListG files, AppLaunchContext context): 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.
launchUris bool launchUris(ListG uris, AppLaunchContext context): 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.
launchUrisAsync void launchUrisAsync(ListG uris, AppLaunchContext context, Cancellable cancellable, GAsyncReadyCallback callback, void* userData): Async version of g_app_info_launch_uris().
launchUrisFinish bool launchUrisFinish(AsyncResultIF result): Finishes a g_app_info_launch_uris_async() operation.
removeSupportsType bool removeSupportsType(string contentType): Removes a supported type from an application, if possible.
setAsDefaultForExtension bool setAsDefaultForExtension(string extension): Sets the application as the default handler for the given file extension.
setAsDefaultForType bool setAsDefaultForType(string contentType): Sets the application as the default handler for a given type.
setAsLastUsedForType bool setAsLastUsedForType(string contentType): 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 g_app_info_get_recommended_for_type(), regardless of the default application for that content type.
shouldShow bool shouldShow(): Checks if the application info should be shown in menus that list available applications.
supportsFiles bool supportsFiles(): Checks if the application accepts files as arguments.
supportsUris bool supportsUris(): Checks if the application supports reading files and directories from URIs.

gio DesktopAppInfo classes

DesktopAppInfo