1261 lines
60 KiB
TypeScript
1261 lines
60 KiB
TypeScript
/// <reference path="./gnomedesktop-4.0.d.ts" />
|
||
/// <reference path="./gio-2.0.d.ts" />
|
||
/// <reference path="./gobject-2.0.d.ts" />
|
||
/// <reference path="./glib-2.0.d.ts" />
|
||
/// <reference path="./gmodule-2.0.d.ts" />
|
||
/// <reference path="./gdkpixbuf-2.0.d.ts" />
|
||
/// <reference path="./gdesktopenums-3.0.d.ts" />
|
||
/// <reference path="./gdk-4.0.d.ts" />
|
||
/// <reference path="./cairo-1.0.d.ts" />
|
||
/// <reference path="./cairo.d.ts" />
|
||
/// <reference path="./pangocairo-1.0.d.ts" />
|
||
/// <reference path="./pango-1.0.d.ts" />
|
||
/// <reference path="./harfbuzz-0.0.d.ts" />
|
||
/// <reference path="./freetype2-2.0.d.ts" />
|
||
|
||
/**
|
||
* Type Definitions for Gjs (https://gjs.guide/)
|
||
*
|
||
* These type definitions are automatically generated, do not edit them by hand.
|
||
* If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
|
||
*
|
||
* The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
|
||
*/
|
||
|
||
declare module 'gi://GnomeRR?version=4.0' {
|
||
// Module dependencies
|
||
import type GnomeDesktop from 'gi://GnomeDesktop?version=4.0';
|
||
import type Gio from 'gi://Gio?version=2.0';
|
||
import type GObject from 'gi://GObject?version=2.0';
|
||
import type GLib from 'gi://GLib?version=2.0';
|
||
import type GModule from 'gi://GModule?version=2.0';
|
||
import type GdkPixbuf from 'gi://GdkPixbuf?version=2.0';
|
||
import type GDesktopEnums from 'gi://GDesktopEnums?version=3.0';
|
||
import type Gdk from 'gi://Gdk?version=4.0';
|
||
import type cairo from 'cairo';
|
||
import type PangoCairo from 'gi://PangoCairo?version=1.0';
|
||
import type Pango from 'gi://Pango?version=1.0';
|
||
import type HarfBuzz from 'gi://HarfBuzz?version=0.0';
|
||
import type freetype2 from 'gi://freetype2?version=2.0';
|
||
|
||
export namespace GnomeRR {
|
||
/**
|
||
* GnomeRR-4.0
|
||
*/
|
||
|
||
export namespace DpmsMode {
|
||
export const $gtype: GObject.GType<DpmsMode>;
|
||
}
|
||
|
||
enum DpmsMode {
|
||
ON,
|
||
STANDBY,
|
||
SUSPEND,
|
||
OFF,
|
||
UNKNOWN,
|
||
}
|
||
|
||
export namespace DpmsModeType {
|
||
export const $gtype: GObject.GType<DpmsModeType>;
|
||
}
|
||
|
||
enum DpmsModeType {
|
||
ON,
|
||
STANDBY,
|
||
SUSPEND,
|
||
OFF,
|
||
UNKNOWN,
|
||
}
|
||
class Error extends GLib.Error {
|
||
static $gtype: GObject.GType<Error>;
|
||
|
||
// Static fields
|
||
|
||
static UNKNOWN: number;
|
||
static NO_RANDR_EXTENSION: number;
|
||
static RANDR_ERROR: number;
|
||
static BOUNDS_ERROR: number;
|
||
static CRTC_ASSIGNMENT: number;
|
||
static NO_MATCHING_CONFIG: number;
|
||
static NO_DPMS_EXTENSION: number;
|
||
|
||
// Constructors
|
||
|
||
constructor(options: { message: string; code: number });
|
||
_init(...args: any[]): void;
|
||
}
|
||
|
||
const CONNECTOR_TYPE_PANEL: string;
|
||
/**
|
||
* Returns the error domain used by the GnomeRR API.
|
||
* @returns the GnomeRR error domain
|
||
*/
|
||
function error_quark(): GLib.Quark;
|
||
|
||
export namespace Rotation {
|
||
export const $gtype: GObject.GType<Rotation>;
|
||
}
|
||
|
||
enum Rotation {
|
||
ROTATION_NEXT,
|
||
ROTATION_0,
|
||
ROTATION_90,
|
||
ROTATION_180,
|
||
ROTATION_270,
|
||
REFLECT_X,
|
||
REFLECT_Y,
|
||
}
|
||
namespace Config {
|
||
// Constructor properties interface
|
||
|
||
interface ConstructorProps extends GObject.Object.ConstructorProps {
|
||
screen: Screen;
|
||
}
|
||
}
|
||
|
||
class Config extends GObject.Object {
|
||
static $gtype: GObject.GType<Config>;
|
||
|
||
// Properties
|
||
|
||
set screen(val: Screen);
|
||
|
||
// Constructors
|
||
|
||
constructor(properties?: Partial<Config.ConstructorProps>, ...args: any[]);
|
||
|
||
_init(...args: any[]): void;
|
||
|
||
static new_current(screen: Screen): Config;
|
||
|
||
// Methods
|
||
|
||
applicable(screen: Screen): boolean;
|
||
apply(screen: Screen): boolean;
|
||
apply_persistent(screen: Screen): boolean;
|
||
ensure_primary(): boolean;
|
||
equal(config2: Config): boolean;
|
||
get_clone(): boolean;
|
||
get_outputs(): OutputInfo[];
|
||
load_current(): boolean;
|
||
match(config2: Config): boolean;
|
||
sanitize(): void;
|
||
set_clone(clone: boolean): void;
|
||
}
|
||
|
||
namespace OutputInfo {
|
||
// Constructor properties interface
|
||
|
||
interface ConstructorProps extends GObject.Object.ConstructorProps {}
|
||
}
|
||
|
||
/**
|
||
* The representation of an output, which can be used for
|
||
* querying and setting display state.
|
||
*/
|
||
class OutputInfo extends GObject.Object {
|
||
static $gtype: GObject.GType<OutputInfo>;
|
||
|
||
// Constructors
|
||
|
||
constructor(properties?: Partial<OutputInfo.ConstructorProps>, ...args: any[]);
|
||
|
||
_init(...args: any[]): void;
|
||
|
||
// Methods
|
||
|
||
get_aspect_ratio(): number;
|
||
get_display_name(): string;
|
||
/**
|
||
* Get the geometry for the monitor connected to the specified output.
|
||
*
|
||
* If the monitor is a tiled monitor, it returns the geometry for the complete monitor.
|
||
*/
|
||
get_geometry(): [number, number, number, number];
|
||
/**
|
||
* Retrieves the output name.
|
||
* @returns the output name
|
||
*/
|
||
get_name(): string;
|
||
get_preferred_height(): number;
|
||
get_preferred_width(): number;
|
||
get_primary(): boolean;
|
||
get_product(): string;
|
||
get_refresh_rate(): number;
|
||
get_rotation(): Rotation;
|
||
get_serial(): string;
|
||
get_underscanning(): boolean;
|
||
get_vendor(): string;
|
||
is_active(): boolean;
|
||
is_connected(): boolean;
|
||
is_primary_tile(): boolean;
|
||
set_active(active: boolean): void;
|
||
/**
|
||
* Set the geometry for the monitor connected to the specified output.
|
||
*
|
||
* If the monitor is a tiled monitor, it sets the geometry for the complete monitor.
|
||
* @param x x offset for monitor
|
||
* @param y y offset for monitor
|
||
* @param width monitor width
|
||
* @param height monitor height
|
||
*/
|
||
set_geometry(x: number, y: number, width: number, height: number): void;
|
||
set_primary(primary: boolean): void;
|
||
set_refresh_rate(rate: number): void;
|
||
set_rotation(rotation: Rotation | null): void;
|
||
set_underscanning(underscanning: boolean): void;
|
||
supports_rotation(rotation: Rotation | null): boolean;
|
||
}
|
||
|
||
namespace Screen {
|
||
// Signal callback interfaces
|
||
|
||
interface Changed {
|
||
(): void;
|
||
}
|
||
|
||
interface OutputConnected {
|
||
(output: Output): void;
|
||
}
|
||
|
||
interface OutputDisconnected {
|
||
(output: Output): void;
|
||
}
|
||
|
||
// Constructor properties interface
|
||
|
||
interface ConstructorProps
|
||
extends GObject.Object.ConstructorProps,
|
||
Gio.AsyncInitable.ConstructorProps,
|
||
Gio.Initable.ConstructorProps {
|
||
dpms_mode: DpmsModeType;
|
||
dpmsMode: DpmsModeType;
|
||
gdk_display: Gdk.Display;
|
||
gdkDisplay: Gdk.Display;
|
||
}
|
||
}
|
||
|
||
class Screen extends GObject.Object implements Gio.AsyncInitable<Screen>, Gio.Initable {
|
||
static $gtype: GObject.GType<Screen>;
|
||
|
||
// Properties
|
||
|
||
get dpms_mode(): DpmsModeType;
|
||
set dpms_mode(val: DpmsModeType);
|
||
get dpmsMode(): DpmsModeType;
|
||
set dpmsMode(val: DpmsModeType);
|
||
get gdk_display(): Gdk.Display;
|
||
get gdkDisplay(): Gdk.Display;
|
||
|
||
// Constructors
|
||
|
||
constructor(properties?: Partial<Screen.ConstructorProps>, ...args: any[]);
|
||
|
||
_init(...args: any[]): void;
|
||
|
||
static ['new'](display: Gdk.Display): Screen;
|
||
|
||
static new_finish(result: Gio.AsyncResult): Screen;
|
||
// Conflicted with Gio.AsyncInitable.new_finish
|
||
|
||
static new_finish(...args: never[]): any;
|
||
|
||
// Signals
|
||
|
||
connect(id: string, callback: (...args: any[]) => any): number;
|
||
connect_after(id: string, callback: (...args: any[]) => any): number;
|
||
emit(id: string, ...args: any[]): void;
|
||
connect(signal: 'changed', callback: (_source: this) => void): number;
|
||
connect_after(signal: 'changed', callback: (_source: this) => void): number;
|
||
emit(signal: 'changed'): void;
|
||
connect(signal: 'output-connected', callback: (_source: this, output: Output) => void): number;
|
||
connect_after(signal: 'output-connected', callback: (_source: this, output: Output) => void): number;
|
||
emit(signal: 'output-connected', output: Output): void;
|
||
connect(signal: 'output-disconnected', callback: (_source: this, output: Output) => void): number;
|
||
connect_after(signal: 'output-disconnected', callback: (_source: this, output: Output) => void): number;
|
||
emit(signal: 'output-disconnected', output: Output): void;
|
||
|
||
// Static methods
|
||
|
||
/**
|
||
* Asynchronously creates a new #GnomeRRScreen instance.
|
||
*
|
||
* On both success and error, `callback` will be invoked. You should use
|
||
* gnome_rr_screen_new_finish() to retrieve the newly created #GnomeRRScreen
|
||
* instance.
|
||
* @param display the windowing system connection used to query the display
|
||
* @param callback the function to call when the #GnomeRRScreen is ready, or on error
|
||
*/
|
||
static new_async(display: Gdk.Display, callback?: Gio.AsyncReadyCallback<Screen> | null): void;
|
||
|
||
// Virtual methods
|
||
|
||
vfunc_changed(): void;
|
||
vfunc_output_connected(output: Output): void;
|
||
vfunc_output_disconnected(output: Output): void;
|
||
|
||
// Methods
|
||
|
||
/**
|
||
* Retrieves the CRTC of the screen using the given identifier.
|
||
* @param id the identifier of a CRTC
|
||
* @returns the CRTC identified by @id
|
||
*/
|
||
get_crtc_by_id(id: number): Crtc;
|
||
get_dpms_mode(): [boolean, DpmsMode];
|
||
/**
|
||
* Retrieves the output of a screen using the given identifier.
|
||
* @param id the identifier of an output
|
||
* @returns the output identified by @id
|
||
*/
|
||
get_output_by_id(id: number): Output;
|
||
/**
|
||
* Retrieves the output for the given name.
|
||
* @param name
|
||
* @returns the output identified by @name
|
||
*/
|
||
get_output_by_name(name: string): Output;
|
||
/**
|
||
* Get the ranges of the screen
|
||
*/
|
||
get_ranges(): [number, number, number, number];
|
||
/**
|
||
* Lists all available XRandR clone modes.
|
||
* @returns the available XRandR clone modes
|
||
*/
|
||
list_clone_modes(): Mode[];
|
||
/**
|
||
* List all CRTCs of the given screen.
|
||
* @returns the available CRTCs
|
||
*/
|
||
list_crtcs(): Crtc[];
|
||
/**
|
||
* Lists all available XRandR modes.
|
||
* @returns the available XRandR modes
|
||
*/
|
||
list_modes(): Mode[];
|
||
/**
|
||
* List all outputs of the given screen.
|
||
* @returns the available outputs
|
||
*/
|
||
list_outputs(): Output[];
|
||
/**
|
||
* Refreshes the screen configuration, and calls the screen's callback if it
|
||
* exists and if the screen's configuration changed.
|
||
* @returns TRUE if the screen's configuration changed; otherwise, the function returns FALSE and a NULL error if the configuration didn't change, or FALSE and a non-NULL error if there was an error while refreshing the configuration.
|
||
*/
|
||
refresh(): boolean;
|
||
/**
|
||
* This method also disables the DPMS timeouts.
|
||
* @param mode
|
||
*/
|
||
set_dpms_mode(mode: DpmsMode | null): boolean;
|
||
|
||
// Inherited methods
|
||
/**
|
||
* Starts asynchronous initialization of the object implementing the
|
||
* interface. This must be done before any real use of the object after
|
||
* initial construction. If the object also implements #GInitable you can
|
||
* optionally call g_initable_init() instead.
|
||
*
|
||
* This method is intended for language bindings. If writing in C,
|
||
* g_async_initable_new_async() should typically be used instead.
|
||
*
|
||
* When the initialization is finished, `callback` will be called. You can
|
||
* then call g_async_initable_init_finish() to get the result of the
|
||
* initialization.
|
||
*
|
||
* Implementations may also support cancellation. If `cancellable` is not
|
||
* %NULL, then initialization can be cancelled by triggering the cancellable
|
||
* object from another thread. If the operation was cancelled, the error
|
||
* %G_IO_ERROR_CANCELLED will be returned. If `cancellable` is not %NULL, and
|
||
* the object doesn't support cancellable initialization, the error
|
||
* %G_IO_ERROR_NOT_SUPPORTED will be returned.
|
||
*
|
||
* As with #GInitable, if the object is not initialized, or initialization
|
||
* returns with an error, then all operations on the object except
|
||
* g_object_ref() and g_object_unref() are considered to be invalid, and
|
||
* have undefined behaviour. They will often fail with g_critical() or
|
||
* g_warning(), but this must not be relied on.
|
||
*
|
||
* Callers should not assume that a class which implements #GAsyncInitable can
|
||
* be initialized multiple times; for more information, see g_initable_init().
|
||
* If a class explicitly supports being initialized multiple times,
|
||
* implementation requires yielding all subsequent calls to init_async() on the
|
||
* results of the first call.
|
||
*
|
||
* For classes that also support the #GInitable interface, the default
|
||
* implementation of this method will run the g_initable_init() function
|
||
* in a thread, so if you want to support asynchronous initialization via
|
||
* threads, just implement the #GAsyncInitable interface without overriding
|
||
* any interface methods.
|
||
* @param io_priority the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
|
||
* @param cancellable optional #GCancellable object, %NULL to ignore.
|
||
*/
|
||
init_async(io_priority: number, cancellable?: Gio.Cancellable | null): Promise<boolean>;
|
||
/**
|
||
* Starts asynchronous initialization of the object implementing the
|
||
* interface. This must be done before any real use of the object after
|
||
* initial construction. If the object also implements #GInitable you can
|
||
* optionally call g_initable_init() instead.
|
||
*
|
||
* This method is intended for language bindings. If writing in C,
|
||
* g_async_initable_new_async() should typically be used instead.
|
||
*
|
||
* When the initialization is finished, `callback` will be called. You can
|
||
* then call g_async_initable_init_finish() to get the result of the
|
||
* initialization.
|
||
*
|
||
* Implementations may also support cancellation. If `cancellable` is not
|
||
* %NULL, then initialization can be cancelled by triggering the cancellable
|
||
* object from another thread. If the operation was cancelled, the error
|
||
* %G_IO_ERROR_CANCELLED will be returned. If `cancellable` is not %NULL, and
|
||
* the object doesn't support cancellable initialization, the error
|
||
* %G_IO_ERROR_NOT_SUPPORTED will be returned.
|
||
*
|
||
* As with #GInitable, if the object is not initialized, or initialization
|
||
* returns with an error, then all operations on the object except
|
||
* g_object_ref() and g_object_unref() are considered to be invalid, and
|
||
* have undefined behaviour. They will often fail with g_critical() or
|
||
* g_warning(), but this must not be relied on.
|
||
*
|
||
* Callers should not assume that a class which implements #GAsyncInitable can
|
||
* be initialized multiple times; for more information, see g_initable_init().
|
||
* If a class explicitly supports being initialized multiple times,
|
||
* implementation requires yielding all subsequent calls to init_async() on the
|
||
* results of the first call.
|
||
*
|
||
* For classes that also support the #GInitable interface, the default
|
||
* implementation of this method will run the g_initable_init() function
|
||
* in a thread, so if you want to support asynchronous initialization via
|
||
* threads, just implement the #GAsyncInitable interface without overriding
|
||
* any interface methods.
|
||
* @param io_priority the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
|
||
* @param cancellable optional #GCancellable object, %NULL to ignore.
|
||
* @param callback a #GAsyncReadyCallback to call when the request is satisfied
|
||
*/
|
||
init_async(
|
||
io_priority: number,
|
||
cancellable: Gio.Cancellable | null,
|
||
callback: Gio.AsyncReadyCallback<this> | null,
|
||
): void;
|
||
/**
|
||
* Starts asynchronous initialization of the object implementing the
|
||
* interface. This must be done before any real use of the object after
|
||
* initial construction. If the object also implements #GInitable you can
|
||
* optionally call g_initable_init() instead.
|
||
*
|
||
* This method is intended for language bindings. If writing in C,
|
||
* g_async_initable_new_async() should typically be used instead.
|
||
*
|
||
* When the initialization is finished, `callback` will be called. You can
|
||
* then call g_async_initable_init_finish() to get the result of the
|
||
* initialization.
|
||
*
|
||
* Implementations may also support cancellation. If `cancellable` is not
|
||
* %NULL, then initialization can be cancelled by triggering the cancellable
|
||
* object from another thread. If the operation was cancelled, the error
|
||
* %G_IO_ERROR_CANCELLED will be returned. If `cancellable` is not %NULL, and
|
||
* the object doesn't support cancellable initialization, the error
|
||
* %G_IO_ERROR_NOT_SUPPORTED will be returned.
|
||
*
|
||
* As with #GInitable, if the object is not initialized, or initialization
|
||
* returns with an error, then all operations on the object except
|
||
* g_object_ref() and g_object_unref() are considered to be invalid, and
|
||
* have undefined behaviour. They will often fail with g_critical() or
|
||
* g_warning(), but this must not be relied on.
|
||
*
|
||
* Callers should not assume that a class which implements #GAsyncInitable can
|
||
* be initialized multiple times; for more information, see g_initable_init().
|
||
* If a class explicitly supports being initialized multiple times,
|
||
* implementation requires yielding all subsequent calls to init_async() on the
|
||
* results of the first call.
|
||
*
|
||
* For classes that also support the #GInitable interface, the default
|
||
* implementation of this method will run the g_initable_init() function
|
||
* in a thread, so if you want to support asynchronous initialization via
|
||
* threads, just implement the #GAsyncInitable interface without overriding
|
||
* any interface methods.
|
||
* @param io_priority the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
|
||
* @param cancellable optional #GCancellable object, %NULL to ignore.
|
||
* @param callback a #GAsyncReadyCallback to call when the request is satisfied
|
||
*/
|
||
init_async(
|
||
io_priority: number,
|
||
cancellable?: Gio.Cancellable | null,
|
||
callback?: Gio.AsyncReadyCallback<this> | null,
|
||
): Promise<boolean> | void;
|
||
/**
|
||
* Finishes asynchronous initialization and returns the result.
|
||
* See g_async_initable_init_async().
|
||
* @param res a #GAsyncResult.
|
||
* @returns %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present.
|
||
*/
|
||
init_finish(res: Gio.AsyncResult): boolean;
|
||
/**
|
||
* Finishes the async construction for the various g_async_initable_new
|
||
* calls, returning the created object or %NULL on error.
|
||
* @param res the #GAsyncResult from the callback
|
||
* @returns a newly created #GObject, or %NULL on error. Free with g_object_unref().
|
||
*/
|
||
new_finish(res: Gio.AsyncResult): Screen;
|
||
/**
|
||
* Starts asynchronous initialization of the object implementing the
|
||
* interface. This must be done before any real use of the object after
|
||
* initial construction. If the object also implements #GInitable you can
|
||
* optionally call g_initable_init() instead.
|
||
*
|
||
* This method is intended for language bindings. If writing in C,
|
||
* g_async_initable_new_async() should typically be used instead.
|
||
*
|
||
* When the initialization is finished, `callback` will be called. You can
|
||
* then call g_async_initable_init_finish() to get the result of the
|
||
* initialization.
|
||
*
|
||
* Implementations may also support cancellation. If `cancellable` is not
|
||
* %NULL, then initialization can be cancelled by triggering the cancellable
|
||
* object from another thread. If the operation was cancelled, the error
|
||
* %G_IO_ERROR_CANCELLED will be returned. If `cancellable` is not %NULL, and
|
||
* the object doesn't support cancellable initialization, the error
|
||
* %G_IO_ERROR_NOT_SUPPORTED will be returned.
|
||
*
|
||
* As with #GInitable, if the object is not initialized, or initialization
|
||
* returns with an error, then all operations on the object except
|
||
* g_object_ref() and g_object_unref() are considered to be invalid, and
|
||
* have undefined behaviour. They will often fail with g_critical() or
|
||
* g_warning(), but this must not be relied on.
|
||
*
|
||
* Callers should not assume that a class which implements #GAsyncInitable can
|
||
* be initialized multiple times; for more information, see g_initable_init().
|
||
* If a class explicitly supports being initialized multiple times,
|
||
* implementation requires yielding all subsequent calls to init_async() on the
|
||
* results of the first call.
|
||
*
|
||
* For classes that also support the #GInitable interface, the default
|
||
* implementation of this method will run the g_initable_init() function
|
||
* in a thread, so if you want to support asynchronous initialization via
|
||
* threads, just implement the #GAsyncInitable interface without overriding
|
||
* any interface methods.
|
||
* @param io_priority the [I/O priority](iface.AsyncResult.html#io-priority) of the operation
|
||
* @param cancellable optional #GCancellable object, %NULL to ignore.
|
||
* @param callback a #GAsyncReadyCallback to call when the request is satisfied
|
||
*/
|
||
vfunc_init_async(
|
||
io_priority: number,
|
||
cancellable?: Gio.Cancellable | null,
|
||
callback?: Gio.AsyncReadyCallback<this> | null,
|
||
): void;
|
||
/**
|
||
* Finishes asynchronous initialization and returns the result.
|
||
* See g_async_initable_init_async().
|
||
* @param res a #GAsyncResult.
|
||
*/
|
||
vfunc_init_finish(res: Gio.AsyncResult): boolean;
|
||
/**
|
||
* Initializes the object implementing the interface.
|
||
*
|
||
* This method is intended for language bindings. If writing in C,
|
||
* g_initable_new() should typically be used instead.
|
||
*
|
||
* The object must be initialized before any real use after initial
|
||
* construction, either with this function or g_async_initable_init_async().
|
||
*
|
||
* Implementations may also support cancellation. If `cancellable` is not %NULL,
|
||
* then initialization can be cancelled by triggering the cancellable object
|
||
* from another thread. If the operation was cancelled, the error
|
||
* %G_IO_ERROR_CANCELLED will be returned. If `cancellable` is not %NULL and
|
||
* the object doesn't support cancellable initialization the error
|
||
* %G_IO_ERROR_NOT_SUPPORTED will be returned.
|
||
*
|
||
* If the object is not initialized, or initialization returns with an
|
||
* error, then all operations on the object except g_object_ref() and
|
||
* g_object_unref() are considered to be invalid, and have undefined
|
||
* behaviour. See the [description][iface`Gio`.Initable#description] for more details.
|
||
*
|
||
* Callers should not assume that a class which implements #GInitable can be
|
||
* initialized multiple times, unless the class explicitly documents itself as
|
||
* supporting this. Generally, a class’ implementation of init() can assume
|
||
* (and assert) that it will only be called once. Previously, this documentation
|
||
* recommended all #GInitable implementations should be idempotent; that
|
||
* recommendation was relaxed in GLib 2.54.
|
||
*
|
||
* If a class explicitly supports being initialized multiple times, it is
|
||
* recommended that the method is idempotent: multiple calls with the same
|
||
* arguments should return the same results. Only the first call initializes
|
||
* the object; further calls return the result of the first call.
|
||
*
|
||
* One reason why a class might need to support idempotent initialization is if
|
||
* it is designed to be used via the singleton pattern, with a
|
||
* #GObjectClass.constructor that sometimes returns an existing instance.
|
||
* In this pattern, a caller would expect to be able to call g_initable_init()
|
||
* on the result of g_object_new(), regardless of whether it is in fact a new
|
||
* instance.
|
||
* @param cancellable optional #GCancellable object, %NULL to ignore.
|
||
* @returns %TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present.
|
||
*/
|
||
init(cancellable?: Gio.Cancellable | null): boolean;
|
||
/**
|
||
* Initializes the object implementing the interface.
|
||
*
|
||
* This method is intended for language bindings. If writing in C,
|
||
* g_initable_new() should typically be used instead.
|
||
*
|
||
* The object must be initialized before any real use after initial
|
||
* construction, either with this function or g_async_initable_init_async().
|
||
*
|
||
* Implementations may also support cancellation. If `cancellable` is not %NULL,
|
||
* then initialization can be cancelled by triggering the cancellable object
|
||
* from another thread. If the operation was cancelled, the error
|
||
* %G_IO_ERROR_CANCELLED will be returned. If `cancellable` is not %NULL and
|
||
* the object doesn't support cancellable initialization the error
|
||
* %G_IO_ERROR_NOT_SUPPORTED will be returned.
|
||
*
|
||
* If the object is not initialized, or initialization returns with an
|
||
* error, then all operations on the object except g_object_ref() and
|
||
* g_object_unref() are considered to be invalid, and have undefined
|
||
* behaviour. See the [description][iface`Gio`.Initable#description] for more details.
|
||
*
|
||
* Callers should not assume that a class which implements #GInitable can be
|
||
* initialized multiple times, unless the class explicitly documents itself as
|
||
* supporting this. Generally, a class’ implementation of init() can assume
|
||
* (and assert) that it will only be called once. Previously, this documentation
|
||
* recommended all #GInitable implementations should be idempotent; that
|
||
* recommendation was relaxed in GLib 2.54.
|
||
*
|
||
* If a class explicitly supports being initialized multiple times, it is
|
||
* recommended that the method is idempotent: multiple calls with the same
|
||
* arguments should return the same results. Only the first call initializes
|
||
* the object; further calls return the result of the first call.
|
||
*
|
||
* One reason why a class might need to support idempotent initialization is if
|
||
* it is designed to be used via the singleton pattern, with a
|
||
* #GObjectClass.constructor that sometimes returns an existing instance.
|
||
* In this pattern, a caller would expect to be able to call g_initable_init()
|
||
* on the result of g_object_new(), regardless of whether it is in fact a new
|
||
* instance.
|
||
* @param cancellable optional #GCancellable object, %NULL to ignore.
|
||
*/
|
||
vfunc_init(cancellable?: Gio.Cancellable | null): boolean;
|
||
/**
|
||
* 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:
|
||
*
|
||
*
|
||
* ```c
|
||
* g_object_bind_property (action, "active", widget, "sensitive", 0);
|
||
* ```
|
||
*
|
||
*
|
||
* Will result in the "sensitive" property of the widget #GObject instance to be
|
||
* updated with the same value of the "active" property of the action #GObject
|
||
* instance.
|
||
*
|
||
* If `flags` contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
|
||
* if `target_property` on `target` changes then the `source_property` on `source`
|
||
* will be updated as well.
|
||
*
|
||
* The binding will automatically be removed when either the `source` or the
|
||
* `target` instances are finalized. To remove the binding without affecting the
|
||
* `source` and the `target` you can just call g_object_unref() on the returned
|
||
* #GBinding instance.
|
||
*
|
||
* Removing the binding by calling g_object_unref() on it must only be done if
|
||
* the binding, `source` and `target` are only used from a single thread and it
|
||
* is clear that both `source` and `target` outlive the binding. Especially it
|
||
* is not safe to rely on this if the binding, `source` or `target` can be
|
||
* finalized from different threads. Keep another reference to the binding and
|
||
* use g_binding_unbind() instead to be on the safe side.
|
||
*
|
||
* A #GObject can have multiple bindings.
|
||
* @param source_property the property on @source to bind
|
||
* @param target the target #GObject
|
||
* @param target_property the property on @target to bind
|
||
* @param flags flags to pass to #GBinding
|
||
* @returns the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero.
|
||
*/
|
||
bind_property(
|
||
source_property: string,
|
||
target: GObject.Object,
|
||
target_property: string,
|
||
flags: GObject.BindingFlags | null,
|
||
): GObject.Binding;
|
||
/**
|
||
* Complete version of g_object_bind_property().
|
||
*
|
||
* 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.
|
||
*
|
||
* If `flags` contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
|
||
* if `target_property` on `target` changes then the `source_property` on `source`
|
||
* will be updated as well. The `transform_from` function is only used in case
|
||
* of bidirectional bindings, otherwise it will be ignored
|
||
*
|
||
* The binding will automatically be removed when either the `source` or the
|
||
* `target` instances are finalized. This will release the reference that is
|
||
* being held on the #GBinding instance; if you want to hold on to the
|
||
* #GBinding instance, you will need to hold a reference to it.
|
||
*
|
||
* To remove the binding, call g_binding_unbind().
|
||
*
|
||
* A #GObject can have multiple bindings.
|
||
*
|
||
* The same `user_data` parameter will be used for both `transform_to`
|
||
* and `transform_from` transformation functions; the `notify` function will
|
||
* be called once, when the binding is removed. If you need different data
|
||
* for each transformation function, please use
|
||
* g_object_bind_property_with_closures() instead.
|
||
* @param source_property the property on @source to bind
|
||
* @param target the target #GObject
|
||
* @param target_property the property on @target to bind
|
||
* @param flags flags to pass to #GBinding
|
||
* @param transform_to the transformation function from the @source to the @target, or %NULL to use the default
|
||
* @param transform_from the transformation function from the @target to the @source, or %NULL to use the default
|
||
* @param notify a function to call when disposing the binding, to free resources used by the transformation functions, or %NULL if not required
|
||
* @returns the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero.
|
||
*/
|
||
bind_property_full(
|
||
source_property: string,
|
||
target: GObject.Object,
|
||
target_property: string,
|
||
flags: GObject.BindingFlags | null,
|
||
transform_to?: GObject.BindingTransformFunc | null,
|
||
transform_from?: GObject.BindingTransformFunc | null,
|
||
notify?: GLib.DestroyNotify | null,
|
||
): GObject.Binding;
|
||
// Conflicted with GObject.Object.bind_property_full
|
||
bind_property_full(...args: never[]): any;
|
||
/**
|
||
* 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().
|
||
*/
|
||
force_floating(): void;
|
||
/**
|
||
* 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
|
||
* #GObject::notify signal is emitted for each property modified while the
|
||
* object is frozen.
|
||
*
|
||
* This is necessary for accessors that modify multiple properties to prevent
|
||
* premature notification while the object is still being modified.
|
||
*/
|
||
freeze_notify(): void;
|
||
/**
|
||
* Gets a named field from the objects table of associations (see g_object_set_data()).
|
||
* @param key name of the key for that association
|
||
* @returns the data if found, or %NULL if no such data exists.
|
||
*/
|
||
get_data(key: string): any | null;
|
||
/**
|
||
* Gets a property of an object.
|
||
*
|
||
* The value can be:
|
||
* - an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
|
||
* - a GObject.Value initialized with the expected type of the property
|
||
* - a GObject.Value initialized with a type to which the expected type of the property can be transformed
|
||
*
|
||
* In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
|
||
*
|
||
* Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
|
||
* @param property_name The name of the property to get
|
||
* @param value Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
|
||
*/
|
||
get_property(property_name: string, value: GObject.Value | any): any;
|
||
/**
|
||
* This function gets back user data pointers stored via
|
||
* g_object_set_qdata().
|
||
* @param quark A #GQuark, naming the user data pointer
|
||
* @returns The user data pointer set, or %NULL
|
||
*/
|
||
get_qdata(quark: GLib.Quark): any | null;
|
||
/**
|
||
* 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.
|
||
* @param names the names of each property to get
|
||
* @param values the values of each property to get
|
||
*/
|
||
getv(names: string[], values: (GObject.Value | any)[]): void;
|
||
/**
|
||
* Checks whether `object` has a [floating][floating-ref] reference.
|
||
* @returns %TRUE if @object has a floating reference
|
||
*/
|
||
is_floating(): boolean;
|
||
/**
|
||
* Emits a "notify" signal for the property `property_name` on `object`.
|
||
*
|
||
* When possible, eg. when signaling a property change from within the class
|
||
* that registered the property, you should use g_object_notify_by_pspec()
|
||
* instead.
|
||
*
|
||
* Note that emission of the notify signal may be blocked with
|
||
* g_object_freeze_notify(). In this case, the signal emissions are queued
|
||
* and will be emitted (in reverse order) when g_object_thaw_notify() is
|
||
* called.
|
||
* @param property_name the name of a property installed on the class of @object.
|
||
*/
|
||
notify(property_name: string): void;
|
||
/**
|
||
* Emits a "notify" signal for the property specified by `pspec` on `object`.
|
||
*
|
||
* This function omits the property name lookup, hence it is faster than
|
||
* g_object_notify().
|
||
*
|
||
* One way to avoid using g_object_notify() from within the
|
||
* class that registered the properties, and using g_object_notify_by_pspec()
|
||
* instead, is to store the GParamSpec used with
|
||
* g_object_class_install_property() inside a static array, e.g.:
|
||
*
|
||
*
|
||
* ```c
|
||
* typedef enum
|
||
* {
|
||
* PROP_FOO = 1,
|
||
* PROP_LAST
|
||
* } MyObjectProperty;
|
||
*
|
||
* static GParamSpec *properties[PROP_LAST];
|
||
*
|
||
* static void
|
||
* my_object_class_init (MyObjectClass *klass)
|
||
* {
|
||
* properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
|
||
* 0, 100,
|
||
* 50,
|
||
* G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
|
||
* g_object_class_install_property (gobject_class,
|
||
* PROP_FOO,
|
||
* properties[PROP_FOO]);
|
||
* }
|
||
* ```
|
||
*
|
||
*
|
||
* and then notify a change on the "foo" property with:
|
||
*
|
||
*
|
||
* ```c
|
||
* g_object_notify_by_pspec (self, properties[PROP_FOO]);
|
||
* ```
|
||
*
|
||
* @param pspec the #GParamSpec of a property installed on the class of @object.
|
||
*/
|
||
notify_by_pspec(pspec: GObject.ParamSpec): void;
|
||
/**
|
||
* Increases the reference count of `object`.
|
||
*
|
||
* Since GLib 2.56, if `GLIB_VERSION_MAX_ALLOWED` is 2.56 or greater, the type
|
||
* of `object` will be propagated to the return type (using the GCC typeof()
|
||
* extension), so any casting the caller needs to do on the return type must be
|
||
* explicit.
|
||
* @returns the same @object
|
||
*/
|
||
ref(): GObject.Object;
|
||
/**
|
||
* Increase the reference count of `object,` and possibly remove the
|
||
* [floating][floating-ref] reference, if `object` has a floating reference.
|
||
*
|
||
* In other words, if the object is floating, then this call "assumes
|
||
* ownership" of the floating reference, converting it to a normal
|
||
* reference by clearing the floating flag while leaving the reference
|
||
* count unchanged. If the object is not floating, then this call
|
||
* adds a new normal reference increasing the reference count by one.
|
||
*
|
||
* Since GLib 2.56, the type of `object` will be propagated to the return type
|
||
* under the same conditions as for g_object_ref().
|
||
* @returns @object
|
||
*/
|
||
ref_sink(): GObject.Object;
|
||
/**
|
||
* Releases all references to other objects. This can be used to break
|
||
* reference cycles.
|
||
*
|
||
* This function should only be called from object system implementations.
|
||
*/
|
||
run_dispose(): void;
|
||
/**
|
||
* Each object carries around a table of associations from
|
||
* strings to pointers. This function lets you set an association.
|
||
*
|
||
* If the object already had an association with that name,
|
||
* the old association will be destroyed.
|
||
*
|
||
* Internally, the `key` is converted to a #GQuark using g_quark_from_string().
|
||
* This means a copy of `key` is kept permanently (even after `object` has been
|
||
* finalized) — so it is recommended to only use a small, bounded set of values
|
||
* for `key` in your program, to avoid the #GQuark storage growing unbounded.
|
||
* @param key name of the key
|
||
* @param data data to associate with that key
|
||
*/
|
||
set_data(key: string, data?: any | null): void;
|
||
/**
|
||
* Sets a property on an object.
|
||
* @param property_name The name of the property to set
|
||
* @param value The value to set the property to
|
||
*/
|
||
set_property(property_name: string, value: GObject.Value | any): void;
|
||
/**
|
||
* Remove a specified datum from the object's data associations,
|
||
* without invoking the association's destroy handler.
|
||
* @param key name of the key
|
||
* @returns the data if found, or %NULL if no such data exists.
|
||
*/
|
||
steal_data(key: string): any | null;
|
||
/**
|
||
* 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:
|
||
*
|
||
* ```c
|
||
* void
|
||
* object_add_to_user_list (GObject *object,
|
||
* const gchar *new_string)
|
||
* {
|
||
* // the quark, naming the object data
|
||
* GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
|
||
* // retrieve the old string list
|
||
* GList *list = g_object_steal_qdata (object, quark_string_list);
|
||
*
|
||
* // prepend new string
|
||
* list = g_list_prepend (list, g_strdup (new_string));
|
||
* // this changed 'list', so we need to set it again
|
||
* g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
|
||
* }
|
||
* static void
|
||
* free_string_list (gpointer data)
|
||
* {
|
||
* GList *node, *list = data;
|
||
*
|
||
* for (node = list; node; node = node->next)
|
||
* g_free (node->data);
|
||
* g_list_free (list);
|
||
* }
|
||
* ```
|
||
*
|
||
* Using g_object_get_qdata() in the above example, instead of
|
||
* g_object_steal_qdata() would have left the destroy function set,
|
||
* and thus the partial string list would have been freed upon
|
||
* g_object_set_qdata_full().
|
||
* @param quark A #GQuark, naming the user data pointer
|
||
* @returns The user data pointer set, or %NULL
|
||
*/
|
||
steal_qdata(quark: GLib.Quark): any | null;
|
||
/**
|
||
* 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.
|
||
*
|
||
* Duplicate notifications for each property are squashed so that at most one
|
||
* #GObject::notify signal is emitted for each property, in the reverse order
|
||
* in which they have been queued.
|
||
*
|
||
* It is an error to call this function when the freeze count is zero.
|
||
*/
|
||
thaw_notify(): void;
|
||
/**
|
||
* Decreases the reference count of `object`. When its reference count
|
||
* drops to 0, the object is finalized (i.e. its memory is freed).
|
||
*
|
||
* If the pointer to the #GObject may be reused in future (for example, if it is
|
||
* an instance variable of another object), it is recommended to clear the
|
||
* pointer to %NULL rather than retain a dangling pointer to a potentially
|
||
* invalid #GObject instance. Use g_clear_object() for this.
|
||
*/
|
||
unref(): void;
|
||
/**
|
||
* 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 g_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.
|
||
* @param closure #GClosure to watch
|
||
*/
|
||
watch_closure(closure: GObject.Closure): void;
|
||
/**
|
||
* the `constructed` function is called by g_object_new() as the
|
||
* final step of the object creation process. At the point of the call, all
|
||
* construction properties have been set on the object. The purpose of this
|
||
* call is to allow for object initialisation steps that can only be performed
|
||
* after construction properties have been set. `constructed` implementors
|
||
* should chain up to the `constructed` call of their parent class to allow it
|
||
* to complete its initialisation.
|
||
*/
|
||
vfunc_constructed(): void;
|
||
/**
|
||
* emits property change notification for a bunch
|
||
* of properties. Overriding `dispatch_properties_changed` should be rarely
|
||
* needed.
|
||
* @param n_pspecs
|
||
* @param pspecs
|
||
*/
|
||
vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: GObject.ParamSpec): void;
|
||
/**
|
||
* the `dispose` function is supposed to drop all references to other
|
||
* objects, but keep the instance otherwise intact, so that client method
|
||
* invocations still work. It may be run multiple times (due to reference
|
||
* loops). Before returning, `dispose` should chain up to the `dispose` method
|
||
* of the parent class.
|
||
*/
|
||
vfunc_dispose(): void;
|
||
/**
|
||
* instance finalization function, should finish the finalization of
|
||
* the instance begun in `dispose` and chain up to the `finalize` method of the
|
||
* parent class.
|
||
*/
|
||
vfunc_finalize(): void;
|
||
/**
|
||
* the generic getter for all properties of this type. Should be
|
||
* overridden for every type with properties.
|
||
* @param property_id
|
||
* @param value
|
||
* @param pspec
|
||
*/
|
||
vfunc_get_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
|
||
/**
|
||
* Emits a "notify" signal for the property `property_name` on `object`.
|
||
*
|
||
* When possible, eg. when signaling a property change from within the class
|
||
* that registered the property, you should use g_object_notify_by_pspec()
|
||
* instead.
|
||
*
|
||
* Note that emission of the notify signal may be blocked with
|
||
* g_object_freeze_notify(). In this case, the signal emissions are queued
|
||
* and will be emitted (in reverse order) when g_object_thaw_notify() is
|
||
* called.
|
||
* @param pspec
|
||
*/
|
||
vfunc_notify(pspec: GObject.ParamSpec): void;
|
||
/**
|
||
* the generic setter for all properties of this type. Should be
|
||
* overridden for every type with properties. If implementations of
|
||
* `set_property` don't emit property change notification explicitly, this will
|
||
* be done implicitly by the type system. However, if the notify signal is
|
||
* emitted explicitly, the type system will not emit it a second time.
|
||
* @param property_id
|
||
* @param value
|
||
* @param pspec
|
||
*/
|
||
vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
|
||
/**
|
||
* Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
|
||
* @param id Handler ID of the handler to be disconnected
|
||
*/
|
||
disconnect(id: number): void;
|
||
/**
|
||
* Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
|
||
* @param properties Object containing the properties to set
|
||
*/
|
||
set(properties: { [key: string]: any }): void;
|
||
/**
|
||
* Blocks a handler of an instance so it will not be called during any signal emissions
|
||
* @param id Handler ID of the handler to be blocked
|
||
*/
|
||
block_signal_handler(id: number): void;
|
||
/**
|
||
* Unblocks a handler so it will be called again during any signal emissions
|
||
* @param id Handler ID of the handler to be unblocked
|
||
*/
|
||
unblock_signal_handler(id: number): void;
|
||
/**
|
||
* Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
|
||
* @param detailedName Name of the signal to stop emission of
|
||
*/
|
||
stop_emission_by_name(detailedName: string): void;
|
||
}
|
||
|
||
class CTM {
|
||
static $gtype: GObject.GType<CTM>;
|
||
|
||
// Constructors
|
||
|
||
constructor(properties?: Partial<{}>);
|
||
_init(...args: any[]): void;
|
||
}
|
||
|
||
type ConfigClass = typeof Config;
|
||
abstract class Crtc {
|
||
static $gtype: GObject.GType<Crtc>;
|
||
|
||
// Constructors
|
||
|
||
_init(...args: any[]): void;
|
||
|
||
// Methods
|
||
|
||
can_drive_output(output: Output): boolean;
|
||
get_current_mode(): Mode;
|
||
get_current_rotation(): Rotation;
|
||
get_gamma(size: number): [boolean, number, number, number];
|
||
get_id(): number;
|
||
get_position(): [number, number];
|
||
get_rotations(): Rotation;
|
||
set_gamma(size: number, red: number, green: number, blue: number): boolean;
|
||
supports_rotation(rotation: Rotation | null): boolean;
|
||
}
|
||
|
||
abstract class Mode {
|
||
static $gtype: GObject.GType<Mode>;
|
||
|
||
// Constructors
|
||
|
||
_init(...args: any[]): void;
|
||
|
||
// Methods
|
||
|
||
get_freq(): number;
|
||
get_freq_f(): number;
|
||
get_height(): number;
|
||
get_id(): number;
|
||
get_is_interlaced(): boolean;
|
||
/**
|
||
* Returns TRUE if this mode is a tiled
|
||
* mode created for span a tiled monitor.
|
||
*/
|
||
get_is_tiled(): boolean;
|
||
get_width(): number;
|
||
}
|
||
|
||
abstract class Output {
|
||
static $gtype: GObject.GType<Output>;
|
||
|
||
// Constructors
|
||
|
||
_init(...args: any[]): void;
|
||
|
||
// Methods
|
||
|
||
/**
|
||
* Checks whether the given output can clone another output.
|
||
* @param clone the output to compare
|
||
* @returns `TRUE` if the output can clone another output
|
||
*/
|
||
can_clone(clone: Output): boolean;
|
||
/**
|
||
* Retrieves the backlight brightness of the given output.
|
||
* @returns The currently set backlight brightness
|
||
*/
|
||
get_backlight(): number;
|
||
/**
|
||
* Retrieves the CRTC of the given output.
|
||
* @returns the CRTC of the output
|
||
*/
|
||
get_crtc(): Crtc;
|
||
/**
|
||
* Retrieves the current mode of the given output.
|
||
* @returns the current mode of this output
|
||
*/
|
||
get_current_mode(): Mode;
|
||
/**
|
||
* Retrieves the display name of the given output.
|
||
* @returns the display name
|
||
*/
|
||
get_display_name(): string;
|
||
get_edid_data(size: number): number;
|
||
get_id(): number;
|
||
/**
|
||
* Retrieves the model identifiers from the EDID of the given output.
|
||
*/
|
||
get_ids_from_edid(): [string, string, string];
|
||
/**
|
||
* Checks whether the given output is the primary output.
|
||
* @returns `TRUE` if the output is the primary one
|
||
*/
|
||
get_is_primary(): boolean;
|
||
get_is_underscanning(): boolean;
|
||
/**
|
||
* Retrieves the value of the minimum backlight step for the given output,
|
||
* as a percentage.
|
||
* @returns The minimum backlight step available in percent
|
||
*/
|
||
get_min_backlight_step(): number;
|
||
/**
|
||
* Retrieves the name of the given output.
|
||
* @returns the name of the output
|
||
*/
|
||
get_name(): string;
|
||
/**
|
||
* Retrieves the physical size of the given output.
|
||
*/
|
||
get_physical_size(): [number, number];
|
||
get_position(): [number, number];
|
||
/**
|
||
* Retrieves all the possible CRTC for the given output.
|
||
* @returns the list of possible CRTC
|
||
*/
|
||
get_possible_crtcs(): Crtc[];
|
||
/**
|
||
* Retrieves the preferred mode of the given output.
|
||
* @returns the preferred mode of the output
|
||
*/
|
||
get_preferred_mode(): Mode;
|
||
/**
|
||
* Checks whether the given output is a built-in display.
|
||
* @returns `TRUE` if the output is a built-in display
|
||
*/
|
||
is_builtin_display(): boolean;
|
||
/**
|
||
* Retrieves all available modes of the given output.
|
||
* @returns a list of modes
|
||
*/
|
||
list_modes(): Mode[];
|
||
/**
|
||
* Sets the backlight level for the given output.
|
||
*
|
||
* The value is a percentage, with a range of [0, 100].
|
||
* @param value the absolute value of the backlight
|
||
* @returns `TRUE` for success
|
||
*/
|
||
set_backlight(value: number): boolean;
|
||
/**
|
||
* Sets the color transformation matrix for the given output.
|
||
* @param ctm the color transformation matrix
|
||
* @returns `TRUE` on success
|
||
*/
|
||
set_color_transform(ctm: CTM): boolean;
|
||
supports_color_transform(): boolean;
|
||
/**
|
||
* Checks whether the given output supports a mode.
|
||
* @param mode the mode to compare
|
||
* @returns `TRUE` if the mode is supported
|
||
*/
|
||
supports_mode(mode: Mode): boolean;
|
||
supports_underscanning(): boolean;
|
||
}
|
||
|
||
type OutputInfoClass = typeof OutputInfo;
|
||
type ScreenClass = typeof Screen;
|
||
/**
|
||
* Name of the imported GIR library
|
||
* `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
|
||
*/
|
||
const __name__: string;
|
||
/**
|
||
* Version of the imported GIR library
|
||
* `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
|
||
*/
|
||
const __version__: string;
|
||
}
|
||
|
||
export default GnomeRR;
|
||
}
|
||
|
||
declare module 'gi://GnomeRR' {
|
||
import GnomeRR40 from 'gi://GnomeRR?version=4.0';
|
||
export default GnomeRR40;
|
||
}
|
||
// END
|