Desktop entry: Steam Runtime Tools API Reference Manual

Desktop entry

Desktop entry — Information about the Steam desktop entries

Functions

const char *	srt_desktop_entry_get_id ()
const char *	srt_desktop_entry_get_commandline ()
const char *	srt_desktop_entry_get_filename ()
gboolean	srt_desktop_entry_is_default_handler ()
gboolean	srt_desktop_entry_is_steam_handler ()

Properties

char *	commandline	Read / Write / Construct Only
char *	filename	Read / Write / Construct Only
char *	id	Read / Write / Construct Only
gboolean	is-default-handler	Read / Write / Construct Only
gboolean	is-steam-handler	Read / Write / Construct Only

Object Hierarchy

    GObject
    ╰── SrtDesktopEntry

Includes

#include <steam-runtime-tools/steam-runtime-tools.h>

Description

Functions

srt_desktop_entry_get_id ()

const char *
srt_desktop_entry_get_id (SrtDesktopEntry *self);

Return the ID of self .

Parameters

self

The SrtDesktopEntry object

Returns

A string like steam.desktop, which is valid as long as self is not destroyed.

[nullable]

srt_desktop_entry_get_commandline ()

const char *
srt_desktop_entry_get_commandline (SrtDesktopEntry *self);

Return the commandline with which the application self will be started.

Parameters

self

The SrtDesktopEntry object

Returns

A string like /usr/bin/steam %U, which is valid as long as self is not destroyed.

[nullable]

srt_desktop_entry_get_filename ()

const char *
srt_desktop_entry_get_filename (SrtDesktopEntry *self);

Return the full path to the self file.

Parameters

self

The SrtDesktopEntry object

Returns

A string like /usr/share/applications/steam.desktop, which is valid as long as self is not destroyed.

[type filename][nullable]

srt_desktop_entry_is_default_handler ()

gboolean
srt_desktop_entry_is_default_handler (SrtDesktopEntry *self);

Parameters

self

The SrtDesktopEntry object

Returns

TRUE if self is the default handler for steam: URIs

srt_desktop_entry_is_steam_handler ()

gboolean
srt_desktop_entry_is_steam_handler (SrtDesktopEntry *self);

Parameters

self

The SrtDesktopEntry object

Returns

TRUE if self can handle steam: URIs

Property Details

The `“commandline”` property

  “commandline”              char *

Commandline with which the application will be started.

Owner: SrtDesktopEntry

Flags: Read / Write / Construct Only

Default value: NULL

The `“filename”` property

  “filename”                 char *

Full path to the desktop entry file.

Owner: SrtDesktopEntry

Flags: Read / Write / Construct Only

Default value: NULL

The `“id”` property

  “id”                       char *

Desktop entry ID.

Owner: SrtDesktopEntry

Flags: Read / Write / Construct Only

Default value: NULL

The `“is-default-handler”` property

  “is-default-handler”       gboolean

TRUE if the entry is the default that handles the URI scheme "steam".

Owner: SrtDesktopEntry

Flags: Read / Write / Construct Only

Default value: FALSE

The `“is-steam-handler”` property

  “is-steam-handler”         gboolean

TRUE if the entry is of the type "x-scheme-handler/steam".

Owner: SrtDesktopEntry

Flags: Read / Write / Construct Only

Default value: FALSE