Namespace GnomeDesktop

Index

Variables

Const DESKTOP_PLATFORM_VERSION

DESKTOP_PLATFORM_VERSION: number

Functions

desktop_thumbnail_is_valid

desktop_thumbnail_is_valid(pixbuf: Pixbuf, uri: string, mtime: number): boolean

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:37
Returns whether the thumbnail has the correct uri and mtime embedded in the png options. This function is threadsafe and does no blocking I/O.

Parameters
- pixbuf: Pixbuf
  
  an loaded thumbnail #GdkPixbuf
- uri: string
  
  a uri
- mtime: number
  
  the mtime
Returns boolean

desktop_thumbnail_path_for_uri

desktop_thumbnail_path_for_uri(uri: string, size: GnomeDesktop.DesktopThumbnailSize): string

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:44
Returns the filename that a thumbnail of size size for uri would have. This function is threadsafe and does no blocking I/O.

Parameters
- uri: string
  
  an uri
- size: GnomeDesktop.DesktopThumbnailSize
  
  a thumbnail size
Returns string

get_all_locales

get_all_locales(): string[]

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:48
Gets all locales.

Returns string[]

get_country_from_code

get_country_from_code(code: string, translation: string): string

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:55
Gets the country name for code. If translation is provided the returned string is translated accordingly.

Parameters
- code: string
  
  an ISO 3166 code string
- translation: string
  
  a locale string
Returns string

get_country_from_locale

get_country_from_locale(locale: string, translation: string): string

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:62
Gets the country description for locale. If translation is provided the returned string is translated accordingly.

Parameters
- locale: string
  
  a locale string
- translation: string
  
  a locale string
Returns string

get_input_source_from_locale

get_input_source_from_locale(locale: string): [boolean, string, string]

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:68
Gets the default input source's type and identifier for a given locale.

Parameters
- locale: string
  
  a locale string
Returns [boolean, string, string]

get_language_from_code

get_language_from_code(code: string, translation: string): string

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:75
Gets the language name for code. If translation is provided the returned string is translated accordingly.

Parameters
- code: string
  
  an ISO 639 code string
- translation: string
  
  a locale string
Returns string

get_language_from_locale

get_language_from_locale(locale: string, translation: string): string

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:82
Gets the language description for locale. If translation is provided the returned string is translated accordingly.

Parameters
- locale: string
  
  a locale string
- translation: string
  
  a locale string
Returns string

get_platform_version

get_platform_version(): number

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:90
Returns an integer with the major version of GNOME. Useful for dynamic languages like Javascript or Python (static languages like C should use %GNOME_DESKTOP_PLATFORM_VERSION). If this function doesn't exist, it can be presumed that the GNOME platform version is 42 or previous.

Returns number

get_translated_modifier

get_translated_modifier(modifier: string, translation: string): string

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:97
Gets a translation of the raw modifier string. If translation is provided the returned string is translated accordingly.

Parameters
- modifier: string
  
  the modifier part of a locale name
- translation: string
  
  a locale string
Returns string

language_has_translations

language_has_translations(code: string): boolean

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:102
Returns %TRUE if there are translations for language code.

Parameters
- code: string
  
  an ISO 639 code string
Returns boolean

normalize_locale

normalize_locale(locale: string): string

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:108
Gets the normalized locale string in the form [language[_country][.codeset][modifier]] for name.

Parameters
- locale: string
  
  a locale string
Returns string

parse_locale

parse_locale(locale: string): [boolean, string, string | null, string | null, string | null]

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:115
Extracts the various components of a locale string of the form [language[_country][.codeset][modifier]]. See http://en.wikipedia.org/wiki/Locale.

Parameters
- locale: string
  
  a locale string
Returns [boolean, string, string | null, string | null, string | null]

start_systemd_scope

start_systemd_scope(name: string, pid: number, description: string, connection: DBusConnection, cancellable: Gio.Cancellable, callback: AsyncReadyCallback): void

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:143
If the current process is running inside a user systemd instance, then move the launched PID into a transient scope. The given name will be used to create a unit name. It should be the application ID or the executable in all other cases. If a desktop-id is passed then the .desktop suffix will be stripped.

It is advisable to use this function every time where the started application can be considered reasonably independent of the launching application. Placing it in a scope creates proper separation between the programs rather than being considered a single entity by systemd.

It is always safe to call this function. Note that a successful return code does not imply that a unit has been created. It solely means that no error condition was hit sending the request.

If connection is %NULL then g_dbus_get() will be called internally.

Note that most callers will not need to handle errors. As such, it is normal to pass a %NULL callback.

Parameters
- name: string
  
  Name for the application
- pid: number
  
  The PID of the application
- description: string
  
  A description to use for the unit, or %NULL
- connection: DBusConnection
  
  An #GDBusConnection to the session bus, or %NULL
- cancellable: Gio.Cancellable
  
  #GCancellable to use
- callback: AsyncReadyCallback
  
  Callback to call when the operation is done
Returns void

start_systemd_scope_finish

start_systemd_scope_finish(res: AsyncResult): boolean

- Defined in @types/Gjs/GnomeDesktop-4.0.d.ts:152
Finish an asynchronous operation to create a transient scope that was started with gnome_start_systemd_scope().

Note that a successful return code does not imply that a unit has been created. It solely means that no error condition was hit sending the request.

Parameters
- res: AsyncResult
  
  A #GAsyncResult
Returns boolean

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

Const DESKTOP_PLATFORM_VERSION

Functions

desktop_thumbnail_is_valid

Parameters

pixbuf: Pixbuf

uri: string

mtime: number

Returns boolean

desktop_thumbnail_path_for_uri

Parameters

uri: string

size: GnomeDesktop.DesktopThumbnailSize

Returns string

get_all_locales

Returns string[]

get_country_from_code

Parameters

code: string

translation: string

Returns string

get_country_from_locale

Parameters

locale: string

translation: string

Returns string

get_input_source_from_locale

Parameters

locale: string

Returns [boolean, string, string]

get_language_from_code

Parameters

code: string

translation: string

Returns string

get_language_from_locale

Parameters

locale: string

translation: string

Returns string

get_platform_version

Returns number

get_translated_modifier

Parameters

modifier: string

translation: string

Returns string

language_has_translations

Parameters

code: string

Returns boolean

normalize_locale

Parameters

locale: string

Returns string

parse_locale

Parameters

locale: string

Returns [boolean, string, string | null, string | null, string | null]

start_systemd_scope

Parameters

name: string

pid: number

description: string

connection: DBusConnection

cancellable: Gio.Cancellable

callback: AsyncReadyCallback

Returns void

start_systemd_scope_finish

Parameters

res: AsyncResult

Returns boolean