Class App

The main AGS application singleton.

Manages windows, CSS styling, icon themes, and the DBus interface. Access the running instance via the global App object or import app from this module.

Example

App.config({
    style: './style.css',
    windows: [MyWindow()],
});

Hierarchy

Application
- App

Accessors

activeTheme

get activeTheme(): string | null
The name of the currently active theme, or null if none has been set.

Returns string | null
- Defined in src/app.ts:265

closeWindowDelay

get closeWindowDelay(): { [key: string]: number }
Map of window names to close delays in milliseconds.

Returns { [key: string]: number }
- Defined in src/app.ts:117
set closeWindowDelay(v: { [key: string]: number }): void
Parameters
- v: { [key: string]: number }
Returns void
- Defined in src/app.ts:121

configDir

get configDir(): string
Directory containing the user's config file.

Returns string
- Defined in src/app.ts:136

configPath

get configPath(): string
Absolute path to the user's config file.

Returns string
- Defined in src/app.ts:131

cursorTheme

get cursorTheme(): string
Returns string
- Defined in src/app.ts:154
set cursorTheme(name: string): void
The current cursor theme name.
Parameters
- name: string
Returns void
- Defined in src/app.ts:150

gtkTheme

get gtkTheme(): string
Returns string
- Defined in src/app.ts:163
set gtkTheme(name: string): void
The current GTK theme name.
Parameters
- name: string
Returns void
- Defined in src/app.ts:159

iconTheme

get iconTheme(): string
Returns string
- Defined in src/app.ts:145
set iconTheme(name: string): void
The current GTK icon theme name.
Parameters
- name: string
Returns void
- Defined in src/app.ts:141

windows

get windows(): Window[]
All registered windows.

Returns Window[]
- Defined in src/app.ts:126

Constructors

constructor

new App(properties?: Partial<ConstructorProps>, ...args: any[]): App
Parameters
- Optionalproperties: Partial<ConstructorProps>
- ...args: any[]
Returns App
Inherited from Gtk.Application.constructor
- Defined in node_modules/.pnpm/@girs+gtk-3.0@3.24.53-4.0.0-rc.15/node_modules/@girs/gtk-3.0/gtk-3.0.d.ts:15418

Methods

`Readonly`addIcons

addIcons(path: string): void
Prepends a directory to the icon search path.
Parameters
- path: string
  Directory containing icon files
Returns void
- Defined in src/app.ts:232

`Readonly`addWindow

addWindow(w: Window): void
Registers a window with the application.

The window must have a name property set. Emits 'window-toggled' when the window's visibility changes.
Parameters
- w: Window
  The GTK window to register
Returns void
- Defined in src/app.ts:392

`Readonly`applyCss

applyCss(pathOrStyle: string, reset?: boolean): void
Applies CSS styling from a file path or inline CSS string.
Parameters
- pathOrStyle: string
  A file path to a CSS file or an inline CSS string
- reset: boolean = false
  If true, removes all previously applied CSS first
Returns void
- Defined in src/app.ts:188

`Readonly`closeWindow

closeWindow(name: string): void
Hides a window by name, respecting any configured close delay.
Parameters
- name: string
  The window name
Returns void
- Defined in src/app.ts:339

`Readonly`config

config(config: Config): void
Applies configuration settings to the application.
Parameters
- config: Config
  The configuration object
Returns void
- Defined in src/app.ts:420

`Readonly`connect

connect(signal?: string, callback: (_: this, ...args: any[]) => void): number
Connects a callback to a signal.
Parameters
- signal: string = 'window-toggled'
  The signal name (defaults to 'window-toggled')
- callback: (_: this, ...args: any[]) => void
  The callback to invoke
Returns number
The connection ID
Overrides Gtk.Application.connect
- Defined in src/app.ts:301

`Readonly`getWindow

getWindow(name: string): Window | undefined
Retrieves a registered window by name.
Parameters
- name: string
  The window name
Returns Window | undefined
The window, or undefined if not found
- Defined in src/app.ts:358

Inspector

Inspector(): void
Opens the GTK interactive debugger.

Returns void
- Defined in src/app.ts:633

`Readonly`openWindow

openWindow(name: string): void
Shows a window by name.
Parameters
- name: string
  The window name
Returns void
- Defined in src/app.ts:325

`Readonly`quit

quit(): void
Quits the application.

Returns void
Overrides Gtk.Application.quit
- Defined in src/app.ts:413

Quit

Quit(): void
DBus method to quit the application.

Returns void
- Defined in src/app.ts:638

`Readonly`registerTheme

registerTheme(name: string, pathOrCss: string): void
Registers a named theme (CSS file path or inline CSS string).
Parameters
- name: string
  A unique theme name
- pathOrCss: string
  Path to a CSS file or inline CSS string
Returns void
- Defined in src/app.ts:242

`Readonly`removeWindow

removeWindow(w: string | Window): void
Removes and destroys a registered window.
Parameters
- w: string | Window
  The window instance or its name
Returns void
- Defined in src/app.ts:371

`Readonly`resetCss

resetCss(): void
Removes all CSS providers that were applied via applyCss.

Returns void
- Defined in src/app.ts:168

RunFile

RunFile(file: string, bus?: string, path?: string): void
Reads and evaluates a JavaScript file in the application context.
Parameters
- file: string
  Path to the JavaScript file
- Optionalbus: string
  The client's DBus bus name
- Optionalpath: string
  The client's DBus object path
Returns void
- Defined in src/app.ts:585

RunJs

RunJs(js: string, clientBusName?: string, clientObjPath?: string): void
Evaluates a JavaScript string in the application context. Called via DBus from the client.
Parameters
- js: string
  JavaScript code to evaluate
- OptionalclientBusName: string
  The client's DBus bus name for returning results
- OptionalclientObjPath: string
  The client's DBus object path
Returns void
- Defined in src/app.ts:539

RunPromise

RunPromise(js: string, busName?: string, objPath?: string): void
Parameters
- js: string
- OptionalbusName: string
- OptionalobjPath: string
Returns void
Deprecated
Use RunJs instead, which now supports await syntax.
- Defined in src/app.ts:596

`Readonly`setTheme

setTheme(name: string): void
Switches to a registered theme by name.

Resets all current CSS and applies the theme CSS. Use @define-color in theme CSS files for GTK3-compatible theming.
Parameters
- name: string
  The theme name previously registered via registerTheme
Returns void
- Defined in src/app.ts:254

`Readonly`toggleWindow

toggleWindow(name: string): string | undefined
Toggles a window's visibility by name.
Parameters
- name: string
  The window name
Returns string | undefined
- Defined in src/app.ts:310

ToggleWindow

ToggleWindow(name: string): string
DBus method to toggle a window. Returns the window's visibility as a string.
Parameters
- name: string
Returns string
- Defined in src/app.ts:627

toJSON

toJSON(): {
    bus: string
    | null;
    configDir: string;
    windows: { [k: string]: Window };
}
Returns a JSON-serializable representation of the application state.

Returns { bus: string | null; configDir: string; windows: { [k: string]: Window } }
- Defined in src/app.ts:523

vfunc_activate

vfunc_activate(): void
Activates the application.

In essence, this results in the Gio.Application::activate signal being emitted in the primary instance.

The application must be registered before calling this function.

Returns void
Overrides Gtk.Application.vfunc_activate
- Defined in src/app.ts:279

Class App

Example

Hierarchy

Index

Accessors

Constructors

Methods

Accessors

activeTheme

Returns string | null

closeWindowDelay

Returns { [key: string]: number }

Parameters

Returns void

configDir

Returns string

configPath

Returns string

cursorTheme

Returns string

Parameters

Returns void

gtkTheme

Returns string

Parameters

Returns void

iconTheme

Returns string

Parameters

Returns void

windows

Returns Window[]

Constructors

constructor

Parameters

Returns App

Methods

ReadonlyaddIcons

Parameters

Returns void

ReadonlyaddWindow

Parameters

Returns void

ReadonlyapplyCss

Parameters

Returns void

ReadonlycloseWindow

Parameters

Returns void

Readonlyconfig

Parameters

Returns void

Readonlyconnect

Parameters

Returns number

ReadonlygetWindow

Parameters

Returns Window | undefined

Inspector

Returns void

ReadonlyopenWindow

Parameters

Returns void

Readonlyquit

Returns void

Quit

Returns void

ReadonlyregisterTheme

Parameters

Returns void

ReadonlyremoveWindow

Parameters

Returns void

ReadonlyresetCss

Returns void

RunFile

Parameters

Returns void

RunJs

Parameters

`Readonly`addIcons

`Readonly`addWindow

`Readonly`applyCss

`Readonly`closeWindow

`Readonly`config

`Readonly`connect

`Readonly`getWindow

`Readonly`openWindow

`Readonly`quit

`Readonly`registerTheme

`Readonly`removeWindow

`Readonly`resetCss

`Readonly`setTheme

`Readonly`toggleWindow