@react-gnome/gjs-esm-types
Version:
TypeScript module declarations for GJS ESM modules.
1,347 lines (1,227 loc) • 62.4 kB
TypeScript
/*
* 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 itself or create a bug report on https://github.com/gjsify/ts-for-gjs
*/
import type xlib from "gi://xlib?version=2.0";
import type cairo from "gi://cairo?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";
import type GObject from "gi://GObject?version=2.0";
import type GLib from "gi://GLib?version=2.0";
import type Gio from "gi://Gio?version=2.0";
import type GdkPixbuf from "gi://GdkPixbuf?version=2.0";
import type GModule from "gi://GModule?version=2.0";
import type Gdk from "gi://Gdk?version=3.0";
declare module "gi://GdkX11?version=3.0" {
/**
* Converts from a #GdkAtom to the X atom for the default GDK display
* with the same string value.
* @param atom A #GdkAtom
* @returns the X atom corresponding to @atom.
*/
function x11_atom_to_xatom(atom: Gdk.Atom): xlib.Atom;
/**
* Converts from a #GdkAtom to the X atom for a #GdkDisplay
* with the same string value. The special value %GDK_NONE
* is converted to %None.
* @param display A #GdkDisplay
* @param atom A #GdkAtom, or %GDK_NONE
* @returns the X atom corresponding to @atom, or %None
*/
function x11_atom_to_xatom_for_display(
display: X11Display,
atom: Gdk.Atom
): xlib.Atom;
/**
* Returns the device ID as seen by XInput2.
*
* > If gdk_disable_multidevice() has been called, this function
* > will respectively return 2/3 for the core pointer and keyboard,
* > (matching the IDs for the Virtual Core Pointer and Keyboard in
* > XInput 2), but calling this function on any slave devices (i.e.
* > those managed via XInput 1.x), will return 0.
* @param device a #GdkDevice
* @returns the XInput2 device ID.
*/
function x11_device_get_id(device: X11DeviceCore): number;
/**
* Returns the #GdkDevice that wraps the given device ID.
* @param device_manager a #GdkDeviceManager
* @param device_id a device ID, as understood by the XInput2 protocol
* @returns The #GdkDevice wrapping the device ID, or %NULL if the given ID doesn’t currently represent a device.
*/
function x11_device_manager_lookup(
device_manager: X11DeviceManagerCore,
device_id: number
): X11DeviceCore | null;
/**
* Frees the data returned from gdk_x11_display_string_to_compound_text().
* @param ctext The pointer stored in `ctext` from a call to gdk_x11_display_string_to_compound_text().
*/
function x11_free_compound_text(ctext: number): void;
/**
* Frees the array of strings created by
* gdk_x11_display_text_property_to_text_list().
* @param list the value stored in the `list` parameter by a call to gdk_x11_display_text_property_to_text_list().
*/
function x11_free_text_list(list: string | null): void;
/**
* Gets the root window of the default screen
* (see gdk_x11_get_default_screen()).
* @returns an Xlib Window.
*/
function x11_get_default_root_xwindow(): xlib.Window;
/**
* Gets the default GTK+ screen number.
* @returns returns the screen number specified by the --display command line option or the DISPLAY environment variable when gdk_init() calls XOpenDisplay().
*/
function x11_get_default_screen(): number;
/**
* Gets the default GTK+ display.
* @returns the Xlib Display* for the display specified in the `--display` command line option or the `DISPLAY` environment variable.
*/
function x11_get_default_xdisplay(): xlib.Display;
/**
* Used with gdk_window_set_background_pattern() to inherit background from
* parent window. Useful for imitating transparency when compositing is not
* available. Otherwise behaves like a transparent pattern.
*/
function x11_get_parent_relative_pattern(): cairo.Pattern;
/**
* Routine to get the current X server time stamp.
* @param window a #GdkWindow, used for communication with the server. The window must have GDK_PROPERTY_CHANGE_MASK in its events mask or a hang will result.
* @returns the time stamp.
*/
function x11_get_server_time(window: X11Window): number;
/**
* Returns the X atom for GDK’s default display corresponding to `atom_name`.
* This function caches the result, so if called repeatedly it is much
* faster than XInternAtom(), which is a round trip to the server each time.
* @param atom_name a string
* @returns a X atom for GDK’s default display.
*/
function x11_get_xatom_by_name(atom_name: string | null): xlib.Atom;
/**
* Returns the X atom for a #GdkDisplay corresponding to `atom_name`.
* This function caches the result, so if called repeatedly it is much
* faster than XInternAtom(), which is a round trip to the server each time.
* @param display a #GdkDisplay
* @param atom_name a string
* @returns a X atom for a #GdkDisplay
*/
function x11_get_xatom_by_name_for_display(
display: X11Display,
atom_name: string | null
): xlib.Atom;
/**
* Returns the name of an X atom for GDK’s default display. This
* function is meant mainly for debugging, so for convenience, unlike
* XAtomName() and gdk_atom_name(), the result
* doesn’t need to be freed. Also, this function will never return %NULL,
* even if `xatom` is invalid.
* @param xatom an X atom for GDK’s default display
* @returns name of the X atom; this string is owned by GTK+, so it shouldn’t be modifed or freed.
*/
function x11_get_xatom_name(xatom: xlib.Atom): string | null;
/**
* Returns the name of an X atom for its display. This
* function is meant mainly for debugging, so for convenience, unlike
* XAtomName() and gdk_atom_name(), the result doesn’t need to
* be freed.
* @param display the #GdkDisplay where `xatom` is defined
* @param xatom an X atom
* @returns name of the X atom; this string is owned by GDK, so it shouldn’t be modifed or freed.
*/
function x11_get_xatom_name_for_display(
display: X11Display,
xatom: xlib.Atom
): string | null;
/**
* Call gdk_x11_display_grab() on the default display.
* To ungrab the server again, use gdk_x11_ungrab_server().
*
* gdk_x11_grab_server()/gdk_x11_ungrab_server() calls can be nested.
*/
function x11_grab_server(): void;
/**
* Find the #GdkDisplay corresponding to `xdisplay,` if any exists.
* @param xdisplay a pointer to an X Display
* @returns the #GdkDisplay, if found, otherwise %NULL.
*/
function x11_lookup_xdisplay(xdisplay: xlib.Display): X11Display;
/**
* Registers interest in receiving extension events with type codes
* between `event_base` and `event_base + n_events - 1`.
* The registered events must have the window field in the same place
* as core X events (this is not the case for e.g. XKB extension events).
*
* If an event type is registered, events of this type will go through
* global and window-specific filters (see gdk_window_add_filter()).
* Unregistered events will only go through global filters.
* GDK may register the events of some X extensions on its own.
*
* This function should only be needed in unusual circumstances, e.g.
* when filtering XInput extension events on the root window.
* @param display a #GdkDisplay
* @param event_base first event type code to register
* @param n_events number of event type codes to register
*/
function x11_register_standard_event_type(
display: X11Display,
event_base: number,
n_events: number
): void;
/**
* Sets the `SM_CLIENT_ID` property on the application’s leader window so that
* the window manager can save the application’s state using the X11R6 ICCCM
* session management protocol.
*
* See the X Session Management Library documentation for more information on
* session management and the Inter-Client Communication Conventions Manual
* @param sm_client_id the client id assigned by the session manager when the connection was opened, or %NULL to remove the property.
*/
function x11_set_sm_client_id(sm_client_id: string | null): void;
/**
* Ungrab the default display after it has been grabbed with
* gdk_x11_grab_server().
*/
function x11_ungrab_server(): void;
/**
* Convert from an X atom for the default display to the corresponding
* #GdkAtom.
* @param xatom an X atom for the default GDK display
* @returns the corresponding G#dkAtom.
*/
function x11_xatom_to_atom(xatom: xlib.Atom): Gdk.Atom;
/**
* Convert from an X atom for a #GdkDisplay to the corresponding
* #GdkAtom.
* @param display A #GdkDisplay
* @param xatom an X atom
* @returns the corresponding #GdkAtom.
*/
function x11_xatom_to_atom_for_display(
display: X11Display,
xatom: xlib.Atom
): Gdk.Atom;
module X11AppLaunchContext {
// Constructor properties interface
type ConstructorProperties = Gdk.AppLaunchContext.ConstructorProperties;
}
interface X11AppLaunchContext {
// Class property signals of GdkX11-3.0.GdkX11.X11AppLaunchContext
connect(
sigName: "notify::display",
callback: ($obj: X11AppLaunchContext, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::display",
callback: ($obj: X11AppLaunchContext, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::display", ...args: any[]): void;
connect(sigName: string, callback: (...args: any[]) => void): number;
connect_after(sigName: string, callback: (...args: any[]) => void): number;
emit(sigName: string, ...args: any[]): void;
disconnect(id: number): void;
}
class X11AppLaunchContext extends Gdk.AppLaunchContext {
// Own properties of GdkX11-3.0.GdkX11.X11AppLaunchContext
static name: string;
static $gtype: GObject.GType<X11AppLaunchContext>;
// Constructors of GdkX11-3.0.GdkX11.X11AppLaunchContext
constructor(config?: X11AppLaunchContext.ConstructorProperties);
_init(config?: X11AppLaunchContext.ConstructorProperties): void;
// Conflicting static methods
static new(...args: any[]): any;
}
module X11Cursor {
// Constructor properties interface
type ConstructorProperties = Gdk.Cursor.ConstructorProperties;
}
interface X11Cursor {
// Owm methods of GdkX11-3.0.GdkX11.X11Cursor
/**
* Returns the X cursor belonging to a #GdkCursor.
* @returns an Xlib Cursor.
*/
get_xcursor(): xlib.Cursor;
/**
* Returns the display of a #GdkCursor.
* @returns an Xlib Display*.
*/
get_xdisplay(): xlib.Display;
// Conflicting methods
/**
* Adds a reference to `cursor`.
* @returns Same @cursor that was passed in
*/
ref(): Gdk.Cursor;
// Overloads of ref
/**
* 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;
/**
* 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;
// Class property signals of GdkX11-3.0.GdkX11.X11Cursor
connect(
sigName: "notify::cursor-type",
callback: ($obj: X11Cursor, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::cursor-type",
callback: ($obj: X11Cursor, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::cursor-type", ...args: any[]): void;
connect(
sigName: "notify::display",
callback: ($obj: X11Cursor, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::display",
callback: ($obj: X11Cursor, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::display", ...args: any[]): void;
connect(sigName: string, callback: (...args: any[]) => void): number;
connect_after(sigName: string, callback: (...args: any[]) => void): number;
emit(sigName: string, ...args: any[]): void;
disconnect(id: number): void;
}
class X11Cursor extends Gdk.Cursor {
// Own properties of GdkX11-3.0.GdkX11.X11Cursor
static name: string;
static $gtype: GObject.GType<X11Cursor>;
// Constructors of GdkX11-3.0.GdkX11.X11Cursor
constructor(config?: X11Cursor.ConstructorProperties);
_init(config?: X11Cursor.ConstructorProperties): void;
}
module X11DeviceCore {
// Constructor properties interface
type ConstructorProperties = Gdk.Device.ConstructorProperties;
}
interface X11DeviceCore {
// Class property signals of GdkX11-3.0.GdkX11.X11DeviceCore
connect(
sigName: "notify::associated-device",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::associated-device",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::associated-device", ...args: any[]): void;
connect(
sigName: "notify::axes",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::axes",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::axes", ...args: any[]): void;
connect(
sigName: "notify::device-manager",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::device-manager",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::device-manager", ...args: any[]): void;
connect(
sigName: "notify::display",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::display",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::display", ...args: any[]): void;
connect(
sigName: "notify::has-cursor",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::has-cursor",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::has-cursor", ...args: any[]): void;
connect(
sigName: "notify::input-mode",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::input-mode",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::input-mode", ...args: any[]): void;
connect(
sigName: "notify::input-source",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::input-source",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::input-source", ...args: any[]): void;
connect(
sigName: "notify::n-axes",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::n-axes",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::n-axes", ...args: any[]): void;
connect(
sigName: "notify::name",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::name",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::name", ...args: any[]): void;
connect(
sigName: "notify::num-touches",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::num-touches",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::num-touches", ...args: any[]): void;
connect(
sigName: "notify::product-id",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::product-id",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::product-id", ...args: any[]): void;
connect(
sigName: "notify::seat",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::seat",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::seat", ...args: any[]): void;
connect(
sigName: "notify::tool",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::tool",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::tool", ...args: any[]): void;
connect(
sigName: "notify::type",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::type",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::type", ...args: any[]): void;
connect(
sigName: "notify::vendor-id",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::vendor-id",
callback: ($obj: X11DeviceCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::vendor-id", ...args: any[]): void;
connect(sigName: string, callback: (...args: any[]) => void): number;
connect_after(sigName: string, callback: (...args: any[]) => void): number;
emit(sigName: string, ...args: any[]): void;
disconnect(id: number): void;
}
class X11DeviceCore extends Gdk.Device {
// Own properties of GdkX11-3.0.GdkX11.X11DeviceCore
static name: string;
static $gtype: GObject.GType<X11DeviceCore>;
// Constructors of GdkX11-3.0.GdkX11.X11DeviceCore
constructor(config?: X11DeviceCore.ConstructorProperties);
_init(config?: X11DeviceCore.ConstructorProperties): void;
}
module X11DeviceManagerCore {
// Constructor properties interface
type ConstructorProperties = Gdk.DeviceManager.ConstructorProperties;
}
interface X11DeviceManagerCore {
// Class property signals of GdkX11-3.0.GdkX11.X11DeviceManagerCore
connect(
sigName: "notify::display",
callback: ($obj: X11DeviceManagerCore, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::display",
callback: ($obj: X11DeviceManagerCore, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::display", ...args: any[]): void;
connect(sigName: string, callback: (...args: any[]) => void): number;
connect_after(sigName: string, callback: (...args: any[]) => void): number;
emit(sigName: string, ...args: any[]): void;
disconnect(id: number): void;
}
class X11DeviceManagerCore extends Gdk.DeviceManager {
// Own properties of GdkX11-3.0.GdkX11.X11DeviceManagerCore
static name: string;
static $gtype: GObject.GType<X11DeviceManagerCore>;
// Constructors of GdkX11-3.0.GdkX11.X11DeviceManagerCore
constructor(config?: X11DeviceManagerCore.ConstructorProperties);
_init(config?: X11DeviceManagerCore.ConstructorProperties): void;
}
module X11DeviceManagerXI2 {
// Constructor properties interface
interface ConstructorProperties
extends X11DeviceManagerCore.ConstructorProperties {
// Own constructor properties of GdkX11-3.0.GdkX11.X11DeviceManagerXI2
major?: number | null;
minor?: number | null;
opcode?: number | null;
}
}
interface X11DeviceManagerXI2 {
// Own properties of GdkX11-3.0.GdkX11.X11DeviceManagerXI2
readonly major: number;
readonly minor: number;
readonly opcode: number;
// Class property signals of GdkX11-3.0.GdkX11.X11DeviceManagerXI2
connect(
sigName: "notify::major",
callback: ($obj: X11DeviceManagerXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::major",
callback: ($obj: X11DeviceManagerXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::major", ...args: any[]): void;
connect(
sigName: "notify::minor",
callback: ($obj: X11DeviceManagerXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::minor",
callback: ($obj: X11DeviceManagerXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::minor", ...args: any[]): void;
connect(
sigName: "notify::opcode",
callback: ($obj: X11DeviceManagerXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::opcode",
callback: ($obj: X11DeviceManagerXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::opcode", ...args: any[]): void;
connect(
sigName: "notify::display",
callback: ($obj: X11DeviceManagerXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::display",
callback: ($obj: X11DeviceManagerXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::display", ...args: any[]): void;
connect(sigName: string, callback: (...args: any[]) => void): number;
connect_after(sigName: string, callback: (...args: any[]) => void): number;
emit(sigName: string, ...args: any[]): void;
disconnect(id: number): void;
}
class X11DeviceManagerXI2 extends X11DeviceManagerCore {
// Own properties of GdkX11-3.0.GdkX11.X11DeviceManagerXI2
static name: string;
static $gtype: GObject.GType<X11DeviceManagerXI2>;
// Constructors of GdkX11-3.0.GdkX11.X11DeviceManagerXI2
constructor(config?: X11DeviceManagerXI2.ConstructorProperties);
_init(config?: X11DeviceManagerXI2.ConstructorProperties): void;
}
module X11DeviceXI2 {
// Constructor properties interface
interface ConstructorProperties extends Gdk.Device.ConstructorProperties {
// Own constructor properties of GdkX11-3.0.GdkX11.X11DeviceXI2
device_id?: number | null;
}
}
interface X11DeviceXI2 {
// Own properties of GdkX11-3.0.GdkX11.X11DeviceXI2
readonly device_id: number;
// Class property signals of GdkX11-3.0.GdkX11.X11DeviceXI2
connect(
sigName: "notify::device-id",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::device-id",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::device-id", ...args: any[]): void;
connect(
sigName: "notify::associated-device",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::associated-device",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::associated-device", ...args: any[]): void;
connect(
sigName: "notify::axes",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::axes",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::axes", ...args: any[]): void;
connect(
sigName: "notify::device-manager",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::device-manager",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::device-manager", ...args: any[]): void;
connect(
sigName: "notify::display",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::display",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::display", ...args: any[]): void;
connect(
sigName: "notify::has-cursor",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::has-cursor",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::has-cursor", ...args: any[]): void;
connect(
sigName: "notify::input-mode",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::input-mode",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::input-mode", ...args: any[]): void;
connect(
sigName: "notify::input-source",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::input-source",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::input-source", ...args: any[]): void;
connect(
sigName: "notify::n-axes",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::n-axes",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::n-axes", ...args: any[]): void;
connect(
sigName: "notify::name",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::name",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::name", ...args: any[]): void;
connect(
sigName: "notify::num-touches",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::num-touches",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::num-touches", ...args: any[]): void;
connect(
sigName: "notify::product-id",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::product-id",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::product-id", ...args: any[]): void;
connect(
sigName: "notify::seat",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::seat",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::seat", ...args: any[]): void;
connect(
sigName: "notify::tool",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::tool",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::tool", ...args: any[]): void;
connect(
sigName: "notify::type",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::type",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::type", ...args: any[]): void;
connect(
sigName: "notify::vendor-id",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::vendor-id",
callback: ($obj: X11DeviceXI2, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::vendor-id", ...args: any[]): void;
connect(sigName: string, callback: (...args: any[]) => void): number;
connect_after(sigName: string, callback: (...args: any[]) => void): number;
emit(sigName: string, ...args: any[]): void;
disconnect(id: number): void;
}
class X11DeviceXI2 extends Gdk.Device {
// Own properties of GdkX11-3.0.GdkX11.X11DeviceXI2
static name: string;
static $gtype: GObject.GType<X11DeviceXI2>;
// Constructors of GdkX11-3.0.GdkX11.X11DeviceXI2
constructor(config?: X11DeviceXI2.ConstructorProperties);
_init(config?: X11DeviceXI2.ConstructorProperties): void;
}
module X11Display {
// Constructor properties interface
type ConstructorProperties = Gdk.Display.ConstructorProperties;
}
interface X11Display {
// Owm methods of GdkX11-3.0.GdkX11.X11Display
/**
* Pops the error trap pushed by gdk_x11_display_error_trap_push().
* Will XSync() if necessary and will always block until
* the error is known to have occurred or not occurred,
* so the error code can be returned.
*
* If you don’t need to use the return value,
* gdk_x11_display_error_trap_pop_ignored() would be more efficient.
*
* See gdk_error_trap_pop() for the all-displays-at-once
* equivalent.
* @returns X error code or 0 on success
*/
error_trap_pop(): number;
/**
* Pops the error trap pushed by gdk_x11_display_error_trap_push().
* Does not block to see if an error occurred; merely records the
* range of requests to ignore errors for, and ignores those errors
* if they arrive asynchronously.
*
* See gdk_error_trap_pop_ignored() for the all-displays-at-once
* equivalent.
*/
error_trap_pop_ignored(): void;
/**
* Begins a range of X requests on `display` for which X error events
* will be ignored. Unignored errors (when no trap is pushed) will abort
* the application. Use gdk_x11_display_error_trap_pop() or
* gdk_x11_display_error_trap_pop_ignored()to lift a trap pushed
* with this function.
*
* See also gdk_error_trap_push() to push a trap on all displays.
*/
error_trap_push(): void;
/**
* Gets the startup notification ID for a display.
* @returns the startup notification ID for @display
*/
get_startup_notification_id(): string | null;
/**
* Returns the timestamp of the last user interaction on
* `display`. The timestamp is taken from events caused
* by user interaction such as key presses or pointer
* movements. See gdk_x11_window_set_user_time().
* @returns the timestamp of the last user interaction
*/
get_user_time(): number;
/**
* Returns the X display of a #GdkDisplay.
* @returns an X display
*/
get_xdisplay(): xlib.Display;
/**
* Call XGrabServer() on `display`.
* To ungrab the display again, use gdk_x11_display_ungrab().
*
* gdk_x11_display_grab()/gdk_x11_display_ungrab() calls can be nested.
*/
grab(): void;
/**
* Sets the cursor theme from which the images for cursor
* should be taken.
*
* If the windowing system supports it, existing cursors created
* with gdk_cursor_new(), gdk_cursor_new_for_display() and
* gdk_cursor_new_from_name() are updated to reflect the theme
* change. Custom cursors constructed with
* gdk_cursor_new_from_pixbuf() will have to be handled
* by the application (GTK+ applications can learn about
* cursor theme changes by listening for change notification
* for the corresponding #GtkSetting).
* @param theme the name of the cursor theme to use, or %NULL to unset a previously set value
* @param size the cursor size to use, or 0 to keep the previous size
*/
set_cursor_theme(theme: string | null, size: number): void;
/**
* Sets the startup notification ID for a display.
*
* This is usually taken from the value of the DESKTOP_STARTUP_ID
* environment variable, but in some cases (such as the application not
* being launched using exec()) it can come from other sources.
*
* If the ID contains the string "_TIME" then the portion following that
* string is taken to be the X11 timestamp of the event that triggered
* the application to be launched and the GDK current event time is set
* accordingly.
*
* The startup ID is also what is used to signal that the startup is
* complete (for example, when opening a window or when calling
* gdk_notify_startup_complete()).
* @param startup_id the startup notification ID (must be valid utf8)
*/
set_startup_notification_id(startup_id: string | null): void;
/**
* Forces a specific window scale for all windows on this display,
* instead of using the default or user configured scale. This
* is can be used to disable scaling support by setting `scale` to
* 1, or to programmatically set the window scale.
*
* Once the scale is set by this call it will not change in response
* to later user configuration changes.
* @param scale The new scale value
*/
set_window_scale(scale: number): void;
/**
* Convert a string from the encoding of the current
* locale into a form suitable for storing in a window property.
* @param str a nul-terminated string
* @returns 0 upon success, non-zero upon failure
*/
string_to_compound_text(
str: string | null
): [
/* returnType */ number,
/* encoding */ Gdk.Atom,
/* format */ number,
/* ctext */ Uint8Array
];
/**
* Convert a text string from the encoding as it is stored
* in a property into an array of strings in the encoding of
* the current locale. (The elements of the array represent the
* nul-separated elements of the original text string.)
* @param encoding an atom representing the encoding. The most common values for this are STRING, or COMPOUND_TEXT. This is value used as the type for the property
* @param format the format of the property
* @param text The text data
* @param length The number of items to transform
* @param list location to store an array of strings in the encoding of the current locale. This array should be freed using gdk_free_text_list().
* @returns the number of strings stored in list, or 0, if the conversion failed
*/
text_property_to_text_list(
encoding: Gdk.Atom,
format: number,
text: number,
length: number,
list: string | null
): number;
/**
* Ungrab `display` after it has been grabbed with
* gdk_x11_display_grab().
*/
ungrab(): void;
/**
* Converts from UTF-8 to compound text.
* @param str a UTF-8 string
* @returns %TRUE if the conversion succeeded, otherwise %FALSE
*/
utf8_to_compound_text(
str: string | null
): [
/* returnType */ boolean,
/* encoding */ Gdk.Atom,
/* format */ number,
/* ctext */ Uint8Array
];
// Class property signals of GdkX11-3.0.GdkX11.X11Display
connect(sigName: string, callback: (...args: any[]) => void): number;
connect_after(sigName: string, callback: (...args: any[]) => void): number;
emit(sigName: string, ...args: any[]): void;
disconnect(id: number): void;
}
class X11Display extends Gdk.Display {
// Own properties of GdkX11-3.0.GdkX11.X11Display
static name: string;
static $gtype: GObject.GType<X11Display>;
// Constructors of GdkX11-3.0.GdkX11.X11Display
constructor(config?: X11Display.ConstructorProperties);
_init(config?: X11Display.ConstructorProperties): void;
/**
* Retrieves the version of the GLX implementation.
* @param display a #GdkDisplay
* @returns %TRUE if GLX is available
*/
static get_glx_version(
display: Gdk.Display
): [/* returnType */ boolean, /* major */ number, /* minor */ number];
}
module X11DisplayManager {
// Constructor properties interface
type ConstructorProperties = Gdk.DisplayManager.ConstructorProperties;
}
interface X11DisplayManager {
// Class property signals of GdkX11-3.0.GdkX11.X11DisplayManager
connect(
sigName: "notify::default-display",
callback: ($obj: X11DisplayManager, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::default-display",
callback: ($obj: X11DisplayManager, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::default-display", ...args: any[]): void;
connect(sigName: string, callback: (...args: any[]) => void): number;
connect_after(sigName: string, callback: (...args: any[]) => void): number;
emit(sigName: string, ...args: any[]): void;
disconnect(id: number): void;
}
class X11DisplayManager extends Gdk.DisplayManager {
// Own properties of GdkX11-3.0.GdkX11.X11DisplayManager
static name: string;
static $gtype: GObject.GType<X11DisplayManager>;
// Constructors of GdkX11-3.0.GdkX11.X11DisplayManager
constructor(config?: X11DisplayManager.ConstructorProperties);
_init(config?: X11DisplayManager.ConstructorProperties): void;
}
module X11DragContext {
// Constructor properties interface
type ConstructorProperties = Gdk.DragContext.ConstructorProperties;
}
interface X11DragContext {
// Class property signals of GdkX11-3.0.GdkX11.X11DragContext
connect(sigName: string, callback: (...args: any[]) => void): number;
connect_after(sigName: string, callback: (...args: any[]) => void): number;
emit(sigName: string, ...args: any[]): void;
disconnect(id: number): void;
}
class X11DragContext extends Gdk.DragContext {
// Own properties of GdkX11-3.0.GdkX11.X11DragContext
static name: string;
static $gtype: GObject.GType<X11DragContext>;
// Constructors of GdkX11-3.0.GdkX11.X11DragContext
constructor(config?: X11DragContext.ConstructorProperties);
_init(config?: X11DragContext.ConstructorProperties): void;
}
module X11GLContext {
// Constructor properties interface
type ConstructorProperties = Gdk.GLContext.ConstructorProperties;
}
interface X11GLContext {
// Class property signals of GdkX11-3.0.GdkX11.X11GLContext
connect(
sigName: "notify::display",
callback: ($obj: X11GLContext, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::display",
callback: ($obj: X11GLContext, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::display", ...args: any[]): void;
connect(
sigName: "notify::shared-context",
callback: ($obj: X11GLContext, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::shared-context",
callback: ($obj: X11GLContext, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::shared-context", ...args: any[]): void;
connect(
sigName: "notify::window",
callback: ($obj: X11GLContext, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::window",
callback: ($obj: X11GLContext, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::window", ...args: any[]): void;
connect(sigName: string, callback: (...args: any[]) => void): number;
connect_after(sigName: string, callback: (...args: any[]) => void): number;
emit(sigName: string, ...args: any[]): void;
disconnect(id: number): void;
}
class X11GLContext extends Gdk.GLContext {
// Own properties of GdkX11-3.0.GdkX11.X11GLContext
static name: string;
static $gtype: GObject.GType<X11GLContext>;
// Constructors of GdkX11-3.0.GdkX11.X11GLContext
constructor(config?: X11GLContext.ConstructorProperties);
_init(config?: X11GLContext.ConstructorProperties): void;
}
module X11Keymap {
// Constructor properties interface
type ConstructorProperties = Gdk.Keymap.ConstructorProperties;
}
interface X11Keymap {
// Owm methods of GdkX11-3.0.GdkX11.X11Keymap
/**
* Extracts the group from the state field sent in an X Key event.
* This is only needed for code processing raw X events, since #GdkEventKey
* directly includes an is_modifier field.
* @param state raw state returned from X
* @returns the index of the active keyboard group for the event
*/
get_group_for_state(state: number): number;
/**
* Determines whether a particular key code represents a key that
* is a modifier. That is, it’s a key that normally just affects
* the keyboard state and the behavior of other keys rather than
* producing a direct effect itself. This is only needed for code
* processing raw X events, since #GdkEventKey directly includes
* an is_modifier field.
* @param keycode the hardware keycode from a key event
* @returns %TRUE if the hardware keycode is a modifier key
*/
key_is_modifier(keycode: number): boolean;
// Class property signals of GdkX11-3.0.GdkX11.X11Keymap
connect(sigName: string, callback: (...args: any[]) => void): number;
connect_after(sigName: string, callback: (...args: any[]) => void): number;
emit(sigName: string, ...args: any[]): void;
disconnect(id: number): void;
}
class X11Keymap extends Gdk.Keymap {
// Own properties of GdkX11-3.0.GdkX11.X11Keymap
static name: string;
static $gtype: GObject.GType<X11Keymap>;
// Constructors of GdkX11-3.0.GdkX11.X11Keymap
constructor(config?: X11Keymap.ConstructorProperties);
_init(config?: X11Keymap.ConstructorProperties): void;
}
module X11Monitor {
// Constructor properties interface
type ConstructorProperties = Gdk.Monitor.ConstructorProperties;
}
interface X11Monitor {
// Class property signals of GdkX11-3.0.GdkX11.X11Monitor
connect(
sigName: "notify::display",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::display",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::display", ...args: any[]): void;
connect(
sigName: "notify::geometry",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::geometry",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::geometry", ...args: any[]): void;
connect(
sigName: "notify::height-mm",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::height-mm",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::height-mm", ...args: any[]): void;
connect(
sigName: "notify::manufacturer",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::manufacturer",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::manufacturer", ...args: any[]): void;
connect(
sigName: "notify::model",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::model",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::model", ...args: any[]): void;
connect(
sigName: "notify::refresh-rate",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::refresh-rate",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::refresh-rate", ...args: any[]): void;
connect(
sigName: "notify::scale-factor",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::scale-factor",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::scale-factor", ...args: any[]): void;
connect(
sigName: "notify::subpixel-layout",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::subpixel-layout",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::subpixel-layout", ...args: any[]): void;
connect(
sigName: "notify::width-mm",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::width-mm",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::width-mm", ...args: any[]): void;
connect(
sigName: "notify::workarea",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
connect_after(
sigName: "notify::workarea",
callback: ($obj: X11Monitor, pspec: GObject.ParamSpec) => void
): number;
emit(sigName: "notify::workarea", ...args: any[]): void;
connect(sigName: string, callback: (...args: any[]) => void): number;
connect_after(sigName: string, callback: (...args: any[]) => void): number;
emit(sigName: string, ...args: any[]): void;
disconnect(id: number): void;
}
class X11Monitor extends Gdk.Monitor {
// Own properties of GdkX11-3.0.GdkX11.X11Monitor
static name: string;
static $gtype: GObject.GType<X11Monitor>;
// Constructors of GdkX11-3.0.GdkX11.X11Monitor
constructor(config?: X11Monitor.ConstructorProperties);
_init(config?: X11Monitor.ConstructorProperties): void;
static get_output(monitor: Gdk.Monitor): xlib.XID;
}
module X11Screen {
// Signal callback interfaces
/**
* Signal callback interface for `window-manager-changed`
*/
interface WindowManagerChangedSignalCallback {
($obj: X11Screen): void;
}
// Constructor properties interface
type ConstructorProperties = Gdk.Screen.ConstructorProperties;
}
interface X11Screen {
// Owm methods of GdkX11-3.0.GdkX11.X11Screen
/**
* Returns the current workspace for `screen` when running under a
* window manager that supports multiple workspaces, as described
* in the
* [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification.
* @returns the current workspace, or 0 if workspaces are not supported
*/
get_current_desktop(): number;
/**
* Gets the XID of the specified output/monitor.
* If the X server does not support version 1.2 of the RANDR
* extension, 0 is returned.
* @param monitor_num number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
* @returns the XID of the monitor
*/
get_monitor_output(monitor_num: number): xlib.XID;
/**
* Returns the number of workspaces for `screen` when running under a
* window manager that supports multiple workspaces, as described
* in the
* [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification.
* @returns the number of workspaces, or 0 if workspaces are not supported
*/
get_number_of_desktops(): number;
/**
* Returns the index of a #GdkScreen.
* @returns the position of @screen among the screens of its display
*/
get_screen_number(): number;
/**
* Returns the name of the window manager for `screen`.
* @returns the name of the window manager screen @screen, or "unknown" if the window manager is unknown. The string is owned by GDK and should not be freed.
*/
get_window_manager_name(): string | null;
/**
* Returns the screen of a #GdkScreen.
* @returns an Xlib Screen*
*/
get_xscreen(): xlib.Screen;
/**
* Looks up the #GdkVisual for a particular screen and X Visual ID.
* @param xvisualid an X Visual ID.
* @returns the #GdkVisual (owned by the screen object), or %NULL if the visual ID wasn’t found.
*/
lookup_visual(xvisualid: xlib.VisualID): X11Visual;
/**
* This function is specific to the X11 backend of GDK, and indicates
* whether the window manager supports a certain hint from the
* [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification.
*
* When using this function, keep in mind that the window manager
* can change over time; so you shouldn’t use this function in
* a way that impacts persistent application state. A common bug
* is that your application can start up before the window manager
* does when the user logs in, and before the window manager starts
* gdk_x11_screen_supports_net_wm_hint() will return %FALSE for every property.
* You can monitor the window_manager_changed signal on #GdkScreen to detect
* a window manager change.
* @param property a property atom.
* @returns %