778 lines
38 KiB
TypeScript
778 lines
38 KiB
TypeScript
/// <reference path="./freetype2-2.0.d.ts" />
|
|
/// <reference path="./pangofc-1.0.d.ts" />
|
|
/// <reference path="./fontconfig-2.0.d.ts" />
|
|
/// <reference path="./pango-1.0.d.ts" />
|
|
/// <reference path="./cairo-1.0.d.ts" />
|
|
/// <reference path="./cairo.d.ts" />
|
|
/// <reference path="./gobject-2.0.d.ts" />
|
|
/// <reference path="./glib-2.0.d.ts" />
|
|
/// <reference path="./harfbuzz-0.0.d.ts" />
|
|
/// <reference path="./gio-2.0.d.ts" />
|
|
/// <reference path="./gmodule-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://PangoFT2?version=1.0' {
|
|
// Module dependencies
|
|
import type freetype2 from 'gi://freetype2?version=2.0';
|
|
import type PangoFc from 'gi://PangoFc?version=1.0';
|
|
import type fontconfig from 'gi://fontconfig?version=2.0';
|
|
import type Pango from 'gi://Pango?version=1.0';
|
|
import type cairo from 'cairo';
|
|
import type GObject from 'gi://GObject?version=2.0';
|
|
import type GLib from 'gi://GLib?version=2.0';
|
|
import type HarfBuzz from 'gi://HarfBuzz?version=0.0';
|
|
import type Gio from 'gi://Gio?version=2.0';
|
|
import type GModule from 'gi://GModule?version=2.0';
|
|
|
|
export namespace PangoFT2 {
|
|
/**
|
|
* PangoFT2-1.0
|
|
*/
|
|
|
|
/**
|
|
* Gets the `PangoCoverage` for a `PangoFT2Font`.
|
|
*
|
|
* Use [method`Pango`.Font.get_coverage] instead.
|
|
* @param font a Pango FT2 font
|
|
* @param language a language tag.
|
|
* @returns a `PangoCoverage`
|
|
*/
|
|
function font_get_coverage(font: Pango.Font, language: Pango.Language): Pango.Coverage;
|
|
/**
|
|
* Retrieves kerning information for a combination of two glyphs.
|
|
*
|
|
* Use pango_fc_font_kern_glyphs() instead.
|
|
* @param font a `PangoFont`
|
|
* @param left the left `PangoGlyph`
|
|
* @param right the right `PangoGlyph`
|
|
* @returns The amount of kerning (in Pango units) to apply for the given combination of glyphs.
|
|
*/
|
|
function font_get_kerning(font: Pango.Font, left: Pango.Glyph, right: Pango.Glyph): number;
|
|
/**
|
|
* Return the index of a glyph suitable for drawing unknown
|
|
* characters with `font,` or %PANGO_GLYPH_EMPTY if no suitable
|
|
* glyph found.
|
|
*
|
|
* If you want to draw an unknown-box for a character that
|
|
* is not covered by the font, use PANGO_GET_UNKNOWN_GLYPH()
|
|
* instead.
|
|
* @param font a `PangoFont`
|
|
* @returns a glyph index into @font, or %PANGO_GLYPH_EMPTY
|
|
*/
|
|
function get_unknown_glyph(font: Pango.Font): Pango.Glyph;
|
|
/**
|
|
* Renders a `PangoGlyphString` onto a FreeType2 bitmap.
|
|
* @param bitmap the FreeType2 bitmap onto which to draw the string
|
|
* @param font the font in which to draw the string
|
|
* @param glyphs the glyph string to draw
|
|
* @param x the x position of the start of the string (in pixels)
|
|
* @param y the y position of the baseline (in pixels)
|
|
*/
|
|
function render(
|
|
bitmap: freetype2.Bitmap,
|
|
font: Pango.Font,
|
|
glyphs: Pango.GlyphString,
|
|
x: number,
|
|
y: number,
|
|
): void;
|
|
/**
|
|
* Render a `PangoLayout` onto a FreeType2 bitmap
|
|
* @param bitmap a FT_Bitmap to render the layout onto
|
|
* @param layout a `PangoLayout`
|
|
* @param x the X position of the left of the layout (in pixels)
|
|
* @param y the Y position of the top of the layout (in pixels)
|
|
*/
|
|
function render_layout(bitmap: freetype2.Bitmap, layout: Pango.Layout, x: number, y: number): void;
|
|
/**
|
|
* Render a `PangoLayoutLine` onto a FreeType2 bitmap
|
|
* @param bitmap a FT_Bitmap to render the line onto
|
|
* @param line a `PangoLayoutLine`
|
|
* @param x the x position of start of string (in pixels)
|
|
* @param y the y position of baseline (in pixels)
|
|
*/
|
|
function render_layout_line(bitmap: freetype2.Bitmap, line: Pango.LayoutLine, x: number, y: number): void;
|
|
/**
|
|
* Render a `PangoLayoutLine` onto a FreeType2 bitmap, with he
|
|
* location specified in fixed-point Pango units rather than
|
|
* pixels.
|
|
*
|
|
* (Using this will avoid extra inaccuracies from rounding
|
|
* to integer pixels multiple times, even if the final glyph
|
|
* positions are integers.)
|
|
* @param bitmap a FT_Bitmap to render the line onto
|
|
* @param line a `PangoLayoutLine`
|
|
* @param x the x position of start of string (in Pango units)
|
|
* @param y the y position of baseline (in Pango units)
|
|
*/
|
|
function render_layout_line_subpixel(
|
|
bitmap: freetype2.Bitmap,
|
|
line: Pango.LayoutLine,
|
|
x: number,
|
|
y: number,
|
|
): void;
|
|
/**
|
|
* Render a `PangoLayout` onto a FreeType2 bitmap, with he
|
|
* location specified in fixed-point Pango units rather than
|
|
* pixels.
|
|
*
|
|
* (Using this will avoid extra inaccuracies from rounding
|
|
* to integer pixels multiple times, even if the final glyph
|
|
* positions are integers.)
|
|
* @param bitmap a FT_Bitmap to render the layout onto
|
|
* @param layout a `PangoLayout`
|
|
* @param x the X position of the left of the layout (in Pango units)
|
|
* @param y the Y position of the top of the layout (in Pango units)
|
|
*/
|
|
function render_layout_subpixel(bitmap: freetype2.Bitmap, layout: Pango.Layout, x: number, y: number): void;
|
|
/**
|
|
* Renders a `PangoGlyphString` onto a FreeType2 bitmap, possibly
|
|
* transforming the layed-out coordinates through a transformation
|
|
* matrix.
|
|
*
|
|
* Note that the transformation matrix for `font` is not
|
|
* changed, so to produce correct rendering results, the `font`
|
|
* must have been loaded using a `PangoContext` with an identical
|
|
* transformation matrix to that passed in to this function.
|
|
* @param bitmap the FreeType2 bitmap onto which to draw the string
|
|
* @param matrix a `PangoMatrix`
|
|
* @param font the font in which to draw the string
|
|
* @param glyphs the glyph string to draw
|
|
* @param x the x position of the start of the string (in Pango units in user space coordinates)
|
|
* @param y the y position of the baseline (in Pango units in user space coordinates)
|
|
*/
|
|
function render_transformed(
|
|
bitmap: freetype2.Bitmap,
|
|
matrix: Pango.Matrix | null,
|
|
font: Pango.Font,
|
|
glyphs: Pango.GlyphString,
|
|
x: number,
|
|
y: number,
|
|
): void;
|
|
/**
|
|
* Free the global fontmap. (See pango_ft2_font_map_for_display())
|
|
* Use of the global PangoFT2 fontmap is deprecated.
|
|
*/
|
|
function shutdown_display(): void;
|
|
interface SubstituteFunc {
|
|
(pattern: fontconfig.Pattern, data?: any | null): void;
|
|
}
|
|
namespace FontMap {
|
|
// Constructor properties interface
|
|
|
|
interface ConstructorProps<A extends GObject.Object = GObject.Object>
|
|
extends PangoFc.FontMap.ConstructorProps<A>,
|
|
Gio.ListModel.ConstructorProps {}
|
|
}
|
|
|
|
/**
|
|
* The `PangoFT2FontMap` is the `PangoFontMap` implementation for FreeType fonts.
|
|
*/
|
|
class FontMap<A extends GObject.Object = GObject.Object>
|
|
extends PangoFc.FontMap<A>
|
|
implements Gio.ListModel<A>
|
|
{
|
|
static $gtype: GObject.GType<FontMap>;
|
|
|
|
// Constructors
|
|
|
|
constructor(properties?: Partial<FontMap.ConstructorProps>, ...args: any[]);
|
|
|
|
_init(...args: any[]): void;
|
|
|
|
static ['new'](): FontMap;
|
|
|
|
// Methods
|
|
|
|
/**
|
|
* Sets a function that will be called to do final configuration
|
|
* substitution on a `FcPattern` before it is used to load
|
|
* the font.
|
|
*
|
|
* This function can be used to do things like set
|
|
* hinting and antialiasing options.
|
|
* @param func function to call to to do final config tweaking on #FcPattern objects.
|
|
*/
|
|
set_default_substitute(func: SubstituteFunc): void;
|
|
// Conflicted with PangoFc.FontMap.set_default_substitute
|
|
set_default_substitute(...args: never[]): any;
|
|
/**
|
|
* Sets the horizontal and vertical resolutions for the fontmap.
|
|
* @param dpi_x dots per inch in the X direction
|
|
* @param dpi_y dots per inch in the Y direction
|
|
*/
|
|
set_resolution(dpi_x: number, dpi_y: number): void;
|
|
/**
|
|
* Call this function any time the results of the
|
|
* default substitution function set with
|
|
* pango_ft2_font_map_set_default_substitute() change.
|
|
*
|
|
* That is, if your substitution function will return different
|
|
* results for the same input pattern, you must call this function.
|
|
*/
|
|
substitute_changed(): void;
|
|
|
|
// Inherited methods
|
|
/**
|
|
* Gets the type of the items in `list`.
|
|
*
|
|
* All items returned from g_list_model_get_item() are of the type
|
|
* returned by this function, or a subtype, or if the type is an
|
|
* interface, they are an implementation of that interface.
|
|
*
|
|
* The item type of a #GListModel can not change during the life of the
|
|
* model.
|
|
* @returns the #GType of the items contained in @list.
|
|
*/
|
|
get_item_type(): GObject.GType;
|
|
/**
|
|
* Gets the number of items in `list`.
|
|
*
|
|
* Depending on the model implementation, calling this function may be
|
|
* less efficient than iterating the list with increasing values for
|
|
* `position` until g_list_model_get_item() returns %NULL.
|
|
* @returns the number of items in @list.
|
|
*/
|
|
get_n_items(): number;
|
|
/**
|
|
* Get the item at `position`.
|
|
*
|
|
* If `position` is greater than the number of items in `list,` %NULL is
|
|
* returned.
|
|
*
|
|
* %NULL is never returned for an index that is smaller than the length
|
|
* of the list.
|
|
*
|
|
* This function is meant to be used by language bindings in place
|
|
* of g_list_model_get_item().
|
|
*
|
|
* See also: g_list_model_get_n_items()
|
|
* @param position the position of the item to fetch
|
|
* @returns the object at @position.
|
|
*/
|
|
get_item(position: number): A | null;
|
|
/**
|
|
* Emits the #GListModel::items-changed signal on `list`.
|
|
*
|
|
* This function should only be called by classes implementing
|
|
* #GListModel. It has to be called after the internal representation
|
|
* of `list` has been updated, because handlers connected to this signal
|
|
* might query the new state of the list.
|
|
*
|
|
* Implementations must only make changes to the model (as visible to
|
|
* its consumer) in places that will not cause problems for that
|
|
* consumer. For models that are driven directly by a write API (such
|
|
* as #GListStore), changes can be reported in response to uses of that
|
|
* API. For models that represent remote data, changes should only be
|
|
* made from a fresh mainloop dispatch. It is particularly not
|
|
* permitted to make changes in response to a call to the #GListModel
|
|
* consumer API.
|
|
*
|
|
* Stated another way: in general, it is assumed that code making a
|
|
* series of accesses to the model via the API, without returning to the
|
|
* mainloop, and without calling other code, will continue to view the
|
|
* same contents of the model.
|
|
* @param position the position at which @list changed
|
|
* @param removed the number of items removed
|
|
* @param added the number of items added
|
|
*/
|
|
items_changed(position: number, removed: number, added: number): void;
|
|
/**
|
|
* Get the item at `position`. If `position` is greater than the number of
|
|
* items in `list,` %NULL is returned.
|
|
*
|
|
* %NULL is never returned for an index that is smaller than the length
|
|
* of the list. See g_list_model_get_n_items().
|
|
*
|
|
* The same #GObject instance may not appear more than once in a #GListModel.
|
|
* @param position the position of the item to fetch
|
|
*/
|
|
vfunc_get_item(position: number): A | null;
|
|
/**
|
|
* Gets the type of the items in `list`.
|
|
*
|
|
* All items returned from g_list_model_get_item() are of the type
|
|
* returned by this function, or a subtype, or if the type is an
|
|
* interface, they are an implementation of that interface.
|
|
*
|
|
* The item type of a #GListModel can not change during the life of the
|
|
* model.
|
|
*/
|
|
vfunc_get_item_type(): GObject.GType;
|
|
/**
|
|
* Gets the number of items in `list`.
|
|
*
|
|
* Depending on the model implementation, calling this function may be
|
|
* less efficient than iterating the list with increasing values for
|
|
* `position` until g_list_model_get_item() returns %NULL.
|
|
*/
|
|
vfunc_get_n_items(): number;
|
|
/**
|
|
* 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;
|
|
}
|
|
|
|
/**
|
|
* 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 PangoFT2;
|
|
}
|
|
|
|
declare module 'gi://PangoFT2' {
|
|
import PangoFT210 from 'gi://PangoFT2?version=1.0';
|
|
export default PangoFT210;
|
|
}
|
|
// END
|