@gtkx/ffi 0.16.0 → 0.17.1

package/dist/generated/gtk/settings.d.ts

@@ -30,7 +30,7 @@ import * as Gdk from "../gdk/index.js";
  * {@link Gtk.Settings.get_for_display}, but in many cases, it is more
  * convenient to use {@link Gtk.Widget.get_settings}.
  */
-export declare class Settings extends GObject.GObject {
+export declare class Settings extends GObject.Object {
     static readonly glibTypeName: string;
     static readonly objectType: "gobject";
     constructor();
@@ -53,6 +53,396 @@ export declare class Settings extends GObject.GObject {
     resetProperty(name: string): void;
     connect(signal: "gtk-private-changed", handler: (self: Settings) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;
+    /** Gets Whether buttons in dialogs should use the alternative button order. */
+    getGtkAlternativeButtonOrder(): boolean;
+    /**
+     * Gets Controls the direction of the sort indicators in sorted list and tree
+     * views.
+     *
+     * By default an arrow pointing down means the column is sorted
+     * in ascending order. When set to %TRUE, this order will be inverted.
+     */
+    getGtkAlternativeSortArrows(): boolean;
+    /**
+     * Gets Whether the application prefers to use a dark theme.
+     *
+     * If a GTK theme includes a dark variant, it will be used
+     * instead of the configured theme.
+     *
+     * Some applications benefit from minimizing the amount of light
+     * pollution that interferes with the content. Good candidates for
+     * dark themes are photo and video editors that make the actual
+     * content get all the attention and minimize the distraction of
+     * the chrome.
+     *
+     * Dark themes should not be used for documents, where large spaces
+     * are white/light and the dark chrome creates too much contrast
+     * (web browser, text editor...).
+     */
+    getGtkApplicationPreferDarkTheme(): boolean;
+    /** Gets The aspect ratio of the text caret. */
+    getGtkCursorAspectRatio(): number;
+    /**
+     * Gets Whether the cursor should blink.
+     *
+     * Also see the {@link Gtk.Settings.gtk-cursor-blink-timeout} setting,
+     * which allows more flexible control over cursor blinking.
+     */
+    getGtkCursorBlink(): boolean;
+    /** Gets Length of the cursor blink cycle, in milliseconds. */
+    getGtkCursorBlinkTime(): number;
+    /**
+     * Gets Time after which the cursor stops blinking, in seconds.
+     *
+     * The timer is reset after each user interaction.
+     *
+     * Setting this to zero has the same effect as setting
+     * {@link Gtk.Settings.gtk-cursor-blink} to %FALSE.
+     */
+    getGtkCursorBlinkTimeout(): number;
+    /**
+     * Gets Name of the cursor theme to use.
+     *
+     * Use %NULL to use the default theme.
+     */
+    getGtkCursorThemeName(): string;
+    /**
+     * Gets The size to use for cursors.
+     *
+     * 0 means to use the default size.
+     */
+    getGtkCursorThemeSize(): number;
+    /**
+     * Gets Determines which buttons should be put in the
+     * titlebar of client-side decorated windows, and whether they
+     * should be placed on the left or right.
+     *
+     * The format of the string is button names, separated by commas.
+     * A colon separates the buttons that should appear on the left
+     * from those on the right. Recognized button names are minimize,
+     * maximize, close, icon (the window icon) and menu (a menu button
+     * for the fallback app menu).
+     *
+     * For example, "menu:minimize,maximize,close" specifies a menu
+     * on the left, and minimize, maximize and close buttons on the right.
+     *
+     * Note that buttons will only be shown when they are meaningful.
+     * E.g. a menu button only appears when the desktop shell does not
+     * show the app menu, and a close button only appears on a window
+     * that can be closed.
+     *
+     * Also note that the setting can be overridden with the
+     * {@link Gtk.HeaderBar.decoration-layout} property.
+     */
+    getGtkDecorationLayout(): string;
+    /**
+     * Gets Whether builtin GTK dialogs such as the file chooser, the
+     * color chooser or the font chooser will use a header bar at
+     * the top to show action widgets, or an action area at the bottom.
+     *
+     * This setting does not affect custom dialogs using `GtkDialog`
+     * directly, or message dialogs.
+     */
+    getGtkDialogsUseHeader(): boolean;
+    /** Gets The number of pixels the cursor can move before dragging. */
+    getGtkDndDragThreshold(): number;
+    /**
+     * Gets The maximum distance allowed between two clicks for them to be considered
+     * a double click, in pixels.
+     */
+    getGtkDoubleClickDistance(): number;
+    /**
+     * Gets The maximum time to allow between two clicks for them to be considered
+     * a double click, in milliseconds.
+     */
+    getGtkDoubleClickTime(): number;
+    /**
+     * Gets Whether menu items should have visible accelerators which can be
+     * activated.
+     */
+    getGtkEnableAccels(): boolean;
+    /** Gets Whether to enable toolkit-wide animations. */
+    getGtkEnableAnimations(): boolean;
+    /**
+     * Gets Whether to play any event sounds at all.
+     *
+     * See the [Sound Theme Specifications](http://www.freedesktop.org/wiki/Specifications/sound-theme-spec)
+     * for more information on event sounds and sound themes.
+     *
+     * GTK itself does not support event sounds, you have to use a loadable
+     * module like the one that comes with libcanberra.
+     */
+    getGtkEnableEventSounds(): boolean;
+    /**
+     * Gets Whether to play event sounds as feedback to user input.
+     *
+     * See the [Sound Theme Specifications](http://www.freedesktop.org/wiki/Specifications/sound-theme-spec)
+     * for more information on event sounds and sound themes.
+     *
+     * GTK itself does not support event sounds, you have to use a loadable
+     * module like the one that comes with libcanberra.
+     */
+    getGtkEnableInputFeedbackSounds(): boolean;
+    /**
+     * Gets Whether a middle click on a mouse should paste the
+     * 'PRIMARY' clipboard content at the cursor location.
+     */
+    getGtkEnablePrimaryPaste(): boolean;
+    /**
+     * Gets How long to show the last input character in hidden
+     * entries.
+     *
+     * This value is in milliseconds. 0 disables showing the
+     * last char. 600 is a good value for enabling it.
+     */
+    getGtkEntryPasswordHintTimeout(): number;
+    /** Gets Whether to select the contents of an entry when it is focused. */
+    getGtkEntrySelectOnFocus(): boolean;
+    /**
+     * Gets When %TRUE, keyboard navigation and other input-related errors
+     * will cause a beep.
+     *
+     * Since the error bell is implemented using gdk_surface_beep(), the
+     * windowing system may offer ways to configure the error bell in many
+     * ways, such as flashing the window or similar visual effects.
+     */
+    getGtkErrorBell(): boolean;
+    /**
+     * Gets The default font to use.
+     *
+     * GTK uses the family name and size from this string.
+     */
+    getGtkFontName(): string;
+    /**
+     * Gets How GTK font rendering is set up.
+     *
+     * When set to {@link Gtk.FontRendering.MANUAL}, GTK respects the low-level
+     * font-related settings ({@link Gtk.Settings.gtk-hint-font-metrics},
+     * {@link Gtk.Settings.gtk-xft-antialias}, {@link Gtk.Settings.gtk-xft-hinting},
+     * {@link Gtk.Settings.gtk-xft-hintstyle} and {@link Gtk.Settings.gtk-xft-rgba})
+     * as much as practical.
+     *
+     * When set to {@link Gtk.FontRendering.AUTOMATIC}, GTK will consider factors such
+     * as screen resolution and scale in deciding how to render fonts.
+     */
+    getGtkFontRendering(): FontRendering;
+    /** Gets Timestamp of the current fontconfig configuration. */
+    getGtkFontconfigTimestamp(): number;
+    /**
+     * Gets Whether hinting should be applied to font metrics.
+     *
+     * Note that this also turns off subpixel positioning of glyphs,
+     * since it conflicts with metrics hinting.
+     */
+    getGtkHintFontMetrics(): boolean;
+    /**
+     * Gets Name of the icon theme to use.
+     *
+     * See {@link Gtk.IconTheme} for details about how
+     * GTK handles icon themes.
+     */
+    getGtkIconThemeName(): string;
+    /**
+     * Gets Which IM (input method) module should be used by default.
+     *
+     * This is the input method that will be used if the user has not
+     * explicitly chosen another input method from the IM context menu.
+     * This also can be a colon-separated list of input methods, which GTK
+     * will try in turn until it finds one available on the system.
+     *
+     * See {@link Gtk.IMContext}.
+     */
+    getGtkImModule(): string;
+    /**
+     * Gets The color scheme used for rendering the user interface.
+     *
+     * This setting communicates the system-wide preference.
+     * The color scheme that is actually used when applying CSS
+     * styles can be set with the {@link Gtk.CssProvider.prefers-color-scheme}
+     * property.
+     */
+    getGtkInterfaceColorScheme(): InterfaceColorScheme;
+    /**
+     * Gets The level of contrast to use for the user interface.
+     *
+     * This setting communicates the system-wide preference.
+     * The contrast level that is actually used when applying CSS
+     * styles can be set with the {@link Gtk.CssProvider.prefers-contrast}
+     * property.
+     */
+    getGtkInterfaceContrast(): InterfaceContrast;
+    /**
+     * Gets Whether GTK should make sure that text can be navigated with
+     * a caret, even if it is not editable.
+     *
+     * This is useful when using a screen reader.
+     */
+    getGtkKeynavUseCaret(): boolean;
+    /**
+     * Gets Whether to select the contents of a selectable
+     * label when it is focused.
+     */
+    getGtkLabelSelectOnFocus(): boolean;
+    /**
+     * Gets The time for a button or touch press to be considered a “long press”.
+     *
+     * See {@link Gtk.GestureLongPress}.
+     */
+    getGtkLongPressTime(): number;
+    /**
+     * Gets Whether scrolled windows may use overlaid scrolling indicators.
+     *
+     * If this is set to %FALSE, scrolled windows will have permanent
+     * scrollbars.
+     */
+    getGtkOverlayScrolling(): boolean;
+    /**
+     * Gets If the value of this setting is %TRUE, clicking the primary button in a
+     * `GtkRange` trough will move the slider, and hence set the range’s value, to
+     * the point that you clicked.
+     *
+     * If it is %FALSE, a primary click will cause the slider/value to move
+     * by the range’s page-size towards the point clicked.
+     *
+     * Whichever action you choose for the primary button, the other action will
+     * be available by holding Shift and primary-clicking, or clicking the middle
+     * mouse button.
+     */
+    getGtkPrimaryButtonWarpsSlider(): boolean;
+    /**
+     * Gets A comma-separated list of print backends to use in the print
+     * dialog.
+     *
+     * Available print backends depend on the GTK installation,
+     * and may include "file", "cups", "lpr" or "papi".
+     */
+    getGtkPrintBackends(): string;
+    /**
+     * Gets A command to run for displaying the print preview.
+     *
+     * The command should contain a `%f` placeholder, which will get
+     * replaced by the path to the pdf file. The command may also
+     * contain a `%s` placeholder, which will get replaced by the
+     * path to a file containing the print settings in the format
+     * produced by {@link Gtk.PrintSettings.to_file}.
+     *
+     * The preview application is responsible for removing the pdf
+     * file and the print settings file when it is done.
+     */
+    getGtkPrintPreviewCommand(): string;
+    /**
+     * Gets Whether GTK should keep track of items inside the recently used
+     * resources list.
+     *
+     * If set to %FALSE, the list will always be empty.
+     */
+    getGtkRecentFilesEnabled(): boolean;
+    /**
+     * Gets The maximum age, in days, of the items inside the recently used
+     * resources list.
+     *
+     * Items older than this setting will be excised from the list.
+     * If set to 0, the list will always be empty; if set to -1, no
+     * item will be removed.
+     */
+    getGtkRecentFilesMaxAge(): number;
+    /**
+     * Gets Set to %TRUE if the desktop environment is displaying
+     * the app menu, %FALSE if the app should display it itself.
+     */
+    getGtkShellShowsAppMenu(): boolean;
+    /**
+     * Gets Set to %TRUE if the desktop environment is displaying
+     * the desktop folder, %FALSE if not.
+     */
+    getGtkShellShowsDesktop(): boolean;
+    /**
+     * Gets Set to %TRUE if the desktop environment is displaying
+     * the menubar, %FALSE if the app should display it itself.
+     */
+    getGtkShellShowsMenubar(): boolean;
+    /** Gets When %TRUE, widgets like switches include shapes to indicate their on/off state. */
+    getGtkShowStatusShapes(): boolean;
+    /**
+     * Gets The XDG sound theme to use for event sounds.
+     *
+     * See the [Sound Theme Specifications](http://www.freedesktop.org/wiki/Specifications/sound-theme-spec)
+     * for more information on event sounds and sound themes.
+     *
+     * GTK itself does not support event sounds, you have to use
+     * a loadable module like the one that comes with libcanberra.
+     */
+    getGtkSoundThemeName(): string;
+    /**
+     * Gets Whether two cursors should be displayed for mixed left-to-right and
+     * right-to-left text.
+     */
+    getGtkSplitCursor(): boolean;
+    /**
+     * Gets Name of the theme to load.
+     *
+     * See {@link Gtk.CssProvider} for details about how
+     * GTK finds the CSS stylesheet for a theme.
+     */
+    getGtkThemeName(): string;
+    /**
+     * Gets Determines the action to take when a double-click
+     * occurs on the titlebar of client-side decorated windows.
+     *
+     * Recognized actions are minimize, toggle-maximize, menu, lower
+     * or none.
+     */
+    getGtkTitlebarDoubleClick(): string;
+    /**
+     * Gets Determines the action to take when a middle-click
+     * occurs on the titlebar of client-side decorated windows.
+     *
+     * Recognized actions are minimize, toggle-maximize, menu, lower
+     * or none.
+     */
+    getGtkTitlebarMiddleClick(): string;
+    /**
+     * Gets Determines the action to take when a right-click
+     * occurs on the titlebar of client-side decorated windows.
+     *
+     * Recognized actions are minimize, toggle-maximize, menu, lower
+     * or none.
+     */
+    getGtkTitlebarRightClick(): string;
+    /**
+     * Gets Whether to antialias fonts.
+     *
+     * The values are 0 for no, 1 for yes, or -1 for the system default.
+     */
+    getGtkXftAntialias(): number;
+    /**
+     * Gets The font resolution, in 1024 * dots/inch.
+     *
+     * -1 to use the default value.
+     */
+    getGtkXftDpi(): number;
+    /**
+     * Gets Whether to enable font hinting.
+     *
+     * The values are 0 for no, 1 for yes, or -1 for the system default.
+     */
+    getGtkXftHinting(): number;
+    /**
+     * Gets What degree of font hinting to use.
+     *
+     * The possible vaues are hintnone, hintslight,
+     * hintmedium, hintfull.
+     */
+    getGtkXftHintstyle(): string;
+    /**
+     * Gets The type of subpixel antialiasing to use.
+     *
+     * The possible values are none, rgb, bgr, vrgb, vbgr.
+     *
+     * Note that GSK does not support subpixel antialiasing, and this
+     * setting has no effect on font rendering in GTK.
+     */
+    getGtkXftRgba(): string;
     /** Sets Whether buttons in dialogs should use the alternative button order. */
     setGtkAlternativeButtonOrder(value: boolean): void;
     /**