Struct gtk4::Settings

source ·
pub struct Settings { /* private fields */ }
Expand description

Settings provides a mechanism to share global settings between applications.

On the X window system, this sharing is realized by an XSettings manager that is usually part of the desktop environment, along with utilities that let the user change these settings.

On Wayland, the settings are obtained either via a settings portal, or by reading desktop settings from DConf.

In the absence of these sharing mechanisms, GTK reads default values for settings from settings.ini files in /etc/gtk-4.0, $XDG_CONFIG_DIRS/gtk-4.0 and $XDG_CONFIG_HOME/gtk-4.0. These files must be valid key files (see GKeyFile), and have a section called Settings. Themes can also provide default values for settings by installing a settings.ini file next to their gtk.css file.

Applications can override system-wide settings by setting the property of the Settings object with g_object_set(). This should be restricted to special cases though; Settings are not meant as an application configuration facility.

There is one Settings instance per display. It can be obtained with for_display(), but in many cases, it is more convenient to use WidgetExt::settings().

§Properties

§gtk-alternative-button-order

Whether buttons in dialogs should use the alternative button order.

Readable | Writeable

§gtk-alternative-sort-arrows

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.

Readable | Writeable

§gtk-application-prefer-dark-theme

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…).

Readable | Writeable

§gtk-cursor-aspect-ratio

The aspect ratio of the text caret.

Readable | Writeable

Whether the cursor should blink.

Also see the gtk-cursor-blink-timeout setting, which allows more flexible control over cursor blinking.

Readable | Writeable

Length of the cursor blink cycle, in milliseconds.

Readable | Writeable

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 gtk-cursor-blink to false.

Readable | Writeable

§gtk-cursor-theme-name

Name of the cursor theme to use.

Use None to use the default theme.

Readable | Writeable

§gtk-cursor-theme-size

The size to use for cursors.

0 means to use the default size.

Readable | Writeable

§gtk-decoration-layout

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 decoration-layout property.

Readable | Writeable

§gtk-dialogs-use-header

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 Dialog directly, or message dialogs.

Readable | Writeable

§gtk-dnd-drag-threshold

The number of pixels the cursor can move before dragging.

Readable | Writeable

§gtk-double-click-distance

The maximum distance allowed between two clicks for them to be considered a double click, in pixels.

Readable | Writeable

§gtk-double-click-time

The maximum time to allow between two clicks for them to be considered a double click, in milliseconds.

Readable | Writeable

§gtk-enable-accels

Whether menu items should have visible accelerators which can be activated.

Readable | Writeable

§gtk-enable-animations

Whether to enable toolkit-wide animations.

Readable | Writeable

§gtk-enable-event-sounds

Whether to play any event sounds at all.

See the Sound Theme Specifications 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.

Readable | Writeable

§gtk-enable-input-feedback-sounds

Whether to play event sounds as feedback to user input.

See the Sound Theme Specifications 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.

Readable | Writeable

§gtk-enable-primary-paste

Whether a middle click on a mouse should paste the ‘PRIMARY’ clipboard content at the cursor location.

Readable | Writeable

§gtk-entry-password-hint-timeout

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.

Readable | Writeable

§gtk-entry-select-on-focus

Whether to select the contents of an entry when it is focused.

Readable | Writeable

§gtk-error-bell

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.

Readable | Writeable

§gtk-font-name

The default font to use.

GTK uses the family name and size from this string.

Readable | Writeable

§gtk-fontconfig-timestamp

Timestamp of the current fontconfig configuration.

Readable | Writeable

§gtk-hint-font-metrics

Whether hinting should be applied to font metrics.

Note that this also turns off subpixel positioning of glyphs, since it conflicts with metrics hinting.

Readable | Writeable

§gtk-icon-theme-name

Name of the icon theme to use.

See IconTheme for details about how GTK handles icon themes.

Readable | Writeable

§gtk-im-module

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 IMContext.

Readable | Writeable

§gtk-keynav-use-caret

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.

Readable | Writeable

§gtk-label-select-on-focus

Whether to select the contents of a selectable label when it is focused.

Readable | Writeable

§gtk-long-press-time

The time for a button or touch press to be considered a “long press”.

See GestureLongPress.

Readable | Writeable

§gtk-overlay-scrolling

Whether scrolled windows may use overlaid scrolling indicators.

If this is set to false, scrolled windows will have permanent scrollbars.

Readable | Writeable

§gtk-primary-button-warps-slider

If the value of this setting is true, clicking the primary button in a Range 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.

Readable | Writeable

§gtk-print-backends

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”.

Readable | Writeable

§gtk-print-preview-command

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 PrintSettings::to_file().

The preview application is responsible for removing the pdf file and the print settings file when it is done.

Readable | Writeable

§gtk-recent-files-enabled

Whether GTK should keep track of items inside the recently used resources list.

If set to false, the list will always be empty.

Readable | Writeable

§gtk-recent-files-max-age

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.

Readable | Writeable

§gtk-shell-shows-app-menu

Set to true if the desktop environment is displaying the app menu, false if the app should display it itself.

Readable | Writeable

§gtk-shell-shows-desktop

Set to true if the desktop environment is displaying the desktop folder, false if not.

Readable | Writeable

§gtk-shell-shows-menubar

Set to true if the desktop environment is displaying the menubar, false if the app should display it itself.

Readable | Writeable

§gtk-show-status-shapes

When true, widgets like switches include shapes to indicate their on/off state.

Readable | Writeable

§gtk-sound-theme-name

The XDG sound theme to use for event sounds.

See the Sound Theme Specifications 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.

Readable | Writeable

§gtk-split-cursor

Whether two cursors should be displayed for mixed left-to-right and right-to-left text.

Readable | Writeable

§gtk-theme-name

Name of the theme to load.

See CssProvider for details about how GTK finds the CSS stylesheet for a theme.

Readable | Writeable

§gtk-titlebar-double-click

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.

Readable | Writeable

§gtk-titlebar-middle-click

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.

Readable | Writeable

§gtk-titlebar-right-click

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.

Readable | Writeable

§gtk-xft-antialias

Whether to antialias fonts.

The values are 0 for no, 1 for yes, or -1 for the system default.

Readable | Writeable

§gtk-xft-dpi

The font resolution, in 1024 * dots/inch.

-1 to use the default value.

Readable | Writeable

§gtk-xft-hinting

Whether to enable font hinting.

The values are 0 for no, 1 for yes, or -1 for the system default.

Readable | Writeable

§gtk-xft-hintstyle

What degree of font hinting to use.

The possible vaues are hintnone, hintslight, hintmedium, hintfull.

Readable | Writeable

§gtk-xft-rgba

The type of subpixel antialiasing to use.

The possible values are none, rgb, bgr, vrgb, vbgr.

Readable | Writeable

§Implements

[trait@glib::ObjectExt], StyleProviderExt

Implementations§

source§

impl Settings

source

pub fn builder() -> SettingsBuilder

Creates a new builder-pattern struct instance to construct Settings objects.

This method returns an instance of SettingsBuilder which can be used to create Settings objects.

source

pub fn reset_property(&self, name: &str)

Undoes the effect of calling g_object_set() to install an application-specific value for a setting.

After this call, the setting will again follow the session-wide value for this setting.

§name

the name of the setting to reset

source

pub fn is_gtk_alternative_button_order(&self) -> bool

Whether buttons in dialogs should use the alternative button order.

source

pub fn set_gtk_alternative_button_order( &self, gtk_alternative_button_order: bool )

Whether buttons in dialogs should use the alternative button order.

source

pub fn is_gtk_alternative_sort_arrows(&self) -> bool

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.

source

pub fn set_gtk_alternative_sort_arrows(&self, gtk_alternative_sort_arrows: bool)

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.

source

pub fn is_gtk_application_prefer_dark_theme(&self) -> bool

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…).

source

pub fn set_gtk_application_prefer_dark_theme( &self, gtk_application_prefer_dark_theme: bool )

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…).

source

pub fn gtk_cursor_aspect_ratio(&self) -> f64

The aspect ratio of the text caret.

source

pub fn set_gtk_cursor_aspect_ratio(&self, gtk_cursor_aspect_ratio: f64)

The aspect ratio of the text caret.

Whether the cursor should blink.

Also see the gtk-cursor-blink-timeout setting, which allows more flexible control over cursor blinking.

Whether the cursor should blink.

Also see the gtk-cursor-blink-timeout setting, which allows more flexible control over cursor blinking.

Length of the cursor blink cycle, in milliseconds.

Length of the cursor blink cycle, in milliseconds.

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 gtk-cursor-blink to false.

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 gtk-cursor-blink to false.

source

pub fn gtk_cursor_theme_name(&self) -> Option<GString>

Name of the cursor theme to use.

Use None to use the default theme.

source

pub fn set_gtk_cursor_theme_name(&self, gtk_cursor_theme_name: Option<&str>)

Name of the cursor theme to use.

Use None to use the default theme.

source

pub fn gtk_cursor_theme_size(&self) -> i32

The size to use for cursors.

0 means to use the default size.

source

pub fn set_gtk_cursor_theme_size(&self, gtk_cursor_theme_size: i32)

The size to use for cursors.

0 means to use the default size.

source

pub fn gtk_decoration_layout(&self) -> Option<GString>

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 decoration-layout property.

source

pub fn set_gtk_decoration_layout(&self, gtk_decoration_layout: Option<&str>)

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 decoration-layout property.

source

pub fn is_gtk_dialogs_use_header(&self) -> bool

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 Dialog directly, or message dialogs.

source

pub fn set_gtk_dialogs_use_header(&self, gtk_dialogs_use_header: bool)

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 Dialog directly, or message dialogs.

source

pub fn gtk_dnd_drag_threshold(&self) -> i32

The number of pixels the cursor can move before dragging.

source

pub fn set_gtk_dnd_drag_threshold(&self, gtk_dnd_drag_threshold: i32)

The number of pixels the cursor can move before dragging.

source

pub fn gtk_double_click_distance(&self) -> i32

The maximum distance allowed between two clicks for them to be considered a double click, in pixels.

source

pub fn set_gtk_double_click_distance(&self, gtk_double_click_distance: i32)

The maximum distance allowed between two clicks for them to be considered a double click, in pixels.

source

pub fn gtk_double_click_time(&self) -> i32

The maximum time to allow between two clicks for them to be considered a double click, in milliseconds.

source

pub fn set_gtk_double_click_time(&self, gtk_double_click_time: i32)

The maximum time to allow between two clicks for them to be considered a double click, in milliseconds.

source

pub fn is_gtk_enable_accels(&self) -> bool

Whether menu items should have visible accelerators which can be activated.

source

pub fn set_gtk_enable_accels(&self, gtk_enable_accels: bool)

Whether menu items should have visible accelerators which can be activated.

source

pub fn is_gtk_enable_animations(&self) -> bool

Whether to enable toolkit-wide animations.

source

pub fn set_gtk_enable_animations(&self, gtk_enable_animations: bool)

Whether to enable toolkit-wide animations.

source

pub fn is_gtk_enable_event_sounds(&self) -> bool

Whether to play any event sounds at all.

See the Sound Theme Specifications 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.

source

pub fn set_gtk_enable_event_sounds(&self, gtk_enable_event_sounds: bool)

Whether to play any event sounds at all.

See the Sound Theme Specifications 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.

source

pub fn is_gtk_enable_input_feedback_sounds(&self) -> bool

Whether to play event sounds as feedback to user input.

See the Sound Theme Specifications 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.

source

pub fn set_gtk_enable_input_feedback_sounds( &self, gtk_enable_input_feedback_sounds: bool )

Whether to play event sounds as feedback to user input.

See the Sound Theme Specifications 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.

source

pub fn is_gtk_enable_primary_paste(&self) -> bool

Whether a middle click on a mouse should paste the ‘PRIMARY’ clipboard content at the cursor location.

source

pub fn set_gtk_enable_primary_paste(&self, gtk_enable_primary_paste: bool)

Whether a middle click on a mouse should paste the ‘PRIMARY’ clipboard content at the cursor location.

source

pub fn gtk_entry_password_hint_timeout(&self) -> u32

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.

source

pub fn set_gtk_entry_password_hint_timeout( &self, gtk_entry_password_hint_timeout: u32 )

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.

source

pub fn is_gtk_entry_select_on_focus(&self) -> bool

Whether to select the contents of an entry when it is focused.

source

pub fn set_gtk_entry_select_on_focus(&self, gtk_entry_select_on_focus: bool)

Whether to select the contents of an entry when it is focused.

source

pub fn is_gtk_error_bell(&self) -> bool

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.

source

pub fn set_gtk_error_bell(&self, gtk_error_bell: bool)

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.

source

pub fn gtk_font_name(&self) -> Option<GString>

The default font to use.

GTK uses the family name and size from this string.

source

pub fn set_gtk_font_name(&self, gtk_font_name: Option<&str>)

The default font to use.

GTK uses the family name and size from this string.

source

pub fn gtk_fontconfig_timestamp(&self) -> u32

Timestamp of the current fontconfig configuration.

source

pub fn set_gtk_fontconfig_timestamp(&self, gtk_fontconfig_timestamp: u32)

Timestamp of the current fontconfig configuration.

source

pub fn is_gtk_hint_font_metrics(&self) -> bool

Available on crate feature v4_6 only.

Whether hinting should be applied to font metrics.

Note that this also turns off subpixel positioning of glyphs, since it conflicts with metrics hinting.

source

pub fn set_gtk_hint_font_metrics(&self, gtk_hint_font_metrics: bool)

Available on crate feature v4_6 only.

Whether hinting should be applied to font metrics.

Note that this also turns off subpixel positioning of glyphs, since it conflicts with metrics hinting.

source

pub fn gtk_icon_theme_name(&self) -> Option<GString>

Name of the icon theme to use.

See IconTheme for details about how GTK handles icon themes.

source

pub fn set_gtk_icon_theme_name(&self, gtk_icon_theme_name: Option<&str>)

Name of the icon theme to use.

See IconTheme for details about how GTK handles icon themes.

source

pub fn gtk_im_module(&self) -> Option<GString>

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 IMContext.

source

pub fn set_gtk_im_module(&self, gtk_im_module: Option<&str>)

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 IMContext.

source

pub fn is_gtk_keynav_use_caret(&self) -> bool

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.

source

pub fn set_gtk_keynav_use_caret(&self, gtk_keynav_use_caret: bool)

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.

source

pub fn is_gtk_label_select_on_focus(&self) -> bool

Whether to select the contents of a selectable label when it is focused.

source

pub fn set_gtk_label_select_on_focus(&self, gtk_label_select_on_focus: bool)

Whether to select the contents of a selectable label when it is focused.

source

pub fn gtk_long_press_time(&self) -> u32

The time for a button or touch press to be considered a “long press”.

See GestureLongPress.

source

pub fn set_gtk_long_press_time(&self, gtk_long_press_time: u32)

The time for a button or touch press to be considered a “long press”.

See GestureLongPress.

source

pub fn is_gtk_overlay_scrolling(&self) -> bool

Whether scrolled windows may use overlaid scrolling indicators.

If this is set to false, scrolled windows will have permanent scrollbars.

source

pub fn set_gtk_overlay_scrolling(&self, gtk_overlay_scrolling: bool)

Whether scrolled windows may use overlaid scrolling indicators.

If this is set to false, scrolled windows will have permanent scrollbars.

source

pub fn is_gtk_primary_button_warps_slider(&self) -> bool

If the value of this setting is true, clicking the primary button in a Range 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.

source

pub fn set_gtk_primary_button_warps_slider( &self, gtk_primary_button_warps_slider: bool )

If the value of this setting is true, clicking the primary button in a Range 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.

source

pub fn gtk_print_backends(&self) -> Option<GString>

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”.

source

pub fn set_gtk_print_backends(&self, gtk_print_backends: Option<&str>)

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”.

source

pub fn gtk_print_preview_command(&self) -> Option<GString>

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 PrintSettings::to_file().

The preview application is responsible for removing the pdf file and the print settings file when it is done.

source

pub fn set_gtk_print_preview_command( &self, gtk_print_preview_command: Option<&str> )

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 PrintSettings::to_file().

The preview application is responsible for removing the pdf file and the print settings file when it is done.

source

pub fn is_gtk_recent_files_enabled(&self) -> bool

Whether GTK should keep track of items inside the recently used resources list.

If set to false, the list will always be empty.

source

pub fn set_gtk_recent_files_enabled(&self, gtk_recent_files_enabled: bool)

Whether GTK should keep track of items inside the recently used resources list.

If set to false, the list will always be empty.

source

pub fn gtk_recent_files_max_age(&self) -> i32

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.

source

pub fn set_gtk_recent_files_max_age(&self, gtk_recent_files_max_age: i32)

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.

source

pub fn is_gtk_shell_shows_app_menu(&self) -> bool

Set to true if the desktop environment is displaying the app menu, false if the app should display it itself.

source

pub fn set_gtk_shell_shows_app_menu(&self, gtk_shell_shows_app_menu: bool)

Set to true if the desktop environment is displaying the app menu, false if the app should display it itself.

source

pub fn is_gtk_shell_shows_desktop(&self) -> bool

Set to true if the desktop environment is displaying the desktop folder, false if not.

source

pub fn set_gtk_shell_shows_desktop(&self, gtk_shell_shows_desktop: bool)

Set to true if the desktop environment is displaying the desktop folder, false if not.

source

pub fn is_gtk_shell_shows_menubar(&self) -> bool

Set to true if the desktop environment is displaying the menubar, false if the app should display it itself.

source

pub fn set_gtk_shell_shows_menubar(&self, gtk_shell_shows_menubar: bool)

Set to true if the desktop environment is displaying the menubar, false if the app should display it itself.

source

pub fn is_gtk_show_status_shapes(&self) -> bool

Available on crate feature v4_14 only.

When true, widgets like switches include shapes to indicate their on/off state.

source

pub fn set_gtk_show_status_shapes(&self, gtk_show_status_shapes: bool)

Available on crate feature v4_14 only.

When true, widgets like switches include shapes to indicate their on/off state.

source

pub fn gtk_sound_theme_name(&self) -> Option<GString>

The XDG sound theme to use for event sounds.

See the Sound Theme Specifications 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.

source

pub fn set_gtk_sound_theme_name(&self, gtk_sound_theme_name: Option<&str>)

The XDG sound theme to use for event sounds.

See the Sound Theme Specifications 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.

source

pub fn is_gtk_split_cursor(&self) -> bool

Whether two cursors should be displayed for mixed left-to-right and right-to-left text.

source

pub fn set_gtk_split_cursor(&self, gtk_split_cursor: bool)

Whether two cursors should be displayed for mixed left-to-right and right-to-left text.

source

pub fn gtk_theme_name(&self) -> Option<GString>

Name of the theme to load.

See CssProvider for details about how GTK finds the CSS stylesheet for a theme.

source

pub fn set_gtk_theme_name(&self, gtk_theme_name: Option<&str>)

Name of the theme to load.

See CssProvider for details about how GTK finds the CSS stylesheet for a theme.

source

pub fn gtk_titlebar_double_click(&self) -> Option<GString>

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.

source

pub fn set_gtk_titlebar_double_click( &self, gtk_titlebar_double_click: Option<&str> )

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.

source

pub fn gtk_titlebar_middle_click(&self) -> Option<GString>

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.

source

pub fn set_gtk_titlebar_middle_click( &self, gtk_titlebar_middle_click: Option<&str> )

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.

source

pub fn gtk_titlebar_right_click(&self) -> Option<GString>

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.

source

pub fn set_gtk_titlebar_right_click( &self, gtk_titlebar_right_click: Option<&str> )

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.

source

pub fn gtk_xft_antialias(&self) -> i32

Whether to antialias fonts.

The values are 0 for no, 1 for yes, or -1 for the system default.

source

pub fn set_gtk_xft_antialias(&self, gtk_xft_antialias: i32)

Whether to antialias fonts.

The values are 0 for no, 1 for yes, or -1 for the system default.

source

pub fn gtk_xft_dpi(&self) -> i32

The font resolution, in 1024 * dots/inch.

-1 to use the default value.

source

pub fn set_gtk_xft_dpi(&self, gtk_xft_dpi: i32)

The font resolution, in 1024 * dots/inch.

-1 to use the default value.

source

pub fn gtk_xft_hinting(&self) -> i32

Whether to enable font hinting.

The values are 0 for no, 1 for yes, or -1 for the system default.

source

pub fn set_gtk_xft_hinting(&self, gtk_xft_hinting: i32)

Whether to enable font hinting.

The values are 0 for no, 1 for yes, or -1 for the system default.

source

pub fn gtk_xft_hintstyle(&self) -> Option<GString>

What degree of font hinting to use.

The possible vaues are hintnone, hintslight, hintmedium, hintfull.

source

pub fn set_gtk_xft_hintstyle(&self, gtk_xft_hintstyle: Option<&str>)

What degree of font hinting to use.

The possible vaues are hintnone, hintslight, hintmedium, hintfull.

source

pub fn gtk_xft_rgba(&self) -> Option<GString>

The type of subpixel antialiasing to use.

The possible values are none, rgb, bgr, vrgb, vbgr.

source

pub fn set_gtk_xft_rgba(&self, gtk_xft_rgba: Option<&str>)

The type of subpixel antialiasing to use.

The possible values are none, rgb, bgr, vrgb, vbgr.

source

pub fn default() -> Option<Settings>

Gets the Settings object for the default display, creating it if necessary.

See for_display().

§Returns

a Settings object. If there is no default display, then returns None.

source

pub fn for_display(display: &impl IsA<Display>) -> Settings

Gets the Settings object for @display, creating it if necessary.

§display

a gdk::Display

§Returns

a Settings object

source

pub fn connect_gtk_alternative_button_order_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_alternative_sort_arrows_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_application_prefer_dark_theme_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_cursor_aspect_ratio_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_cursor_theme_name_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_cursor_theme_size_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_decoration_layout_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_dialogs_use_header_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_dnd_drag_threshold_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_double_click_distance_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_double_click_time_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_enable_accels_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_enable_animations_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_enable_event_sounds_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_enable_input_feedback_sounds_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_enable_primary_paste_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_entry_password_hint_timeout_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_entry_select_on_focus_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_error_bell_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_font_name_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_fontconfig_timestamp_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_hint_font_metrics_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v4_6 only.
source

pub fn connect_gtk_icon_theme_name_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_im_module_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_keynav_use_caret_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_label_select_on_focus_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_long_press_time_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_overlay_scrolling_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_primary_button_warps_slider_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_print_backends_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_print_preview_command_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_recent_files_enabled_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_recent_files_max_age_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_shell_shows_app_menu_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_shell_shows_desktop_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_shell_shows_menubar_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_show_status_shapes_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v4_14 only.
source

pub fn connect_gtk_sound_theme_name_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_split_cursor_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_theme_name_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_titlebar_double_click_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_titlebar_middle_click_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_titlebar_right_click_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_xft_antialias_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_xft_dpi_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_xft_hinting_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_xft_hintstyle_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source

pub fn connect_gtk_xft_rgba_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations§

source§

impl Clone for Settings

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Settings

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl HasParamSpec for Settings

§

type ParamSpec = ParamSpecObject

§

type SetValue = Settings

Preferred value to be used as setter for the associated ParamSpec.
§

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Settings>

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl Hash for Settings

source§

fn hash<H>(&self, state: &mut H)
where H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Settings

source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl ParentClassIs for Settings

source§

impl<OT: ObjectType> PartialEq<OT> for Settings

source§

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<OT: ObjectType> PartialOrd<OT> for Settings

source§

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl StaticType for Settings

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Eq for Settings

source§

impl IsA<StyleProvider> for Settings

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Cast for T
where T: ObjectType,

source§

fn upcast<T>(self) -> T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a superclass or interface T. Read more
source§

fn upcast_ref<T>(&self) -> &T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a reference of its superclass or interface T. Read more
source§

fn downcast<T>(self) -> Result<T, Self>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a subclass or interface implementor T. Read more
source§

fn downcast_ref<T>(&self) -> Option<&T>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a reference of its subclass or interface implementor T. Read more
source§

fn dynamic_cast<T>(self) -> Result<T, Self>
where T: ObjectType,

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while upcast will do many checks at compile-time already. downcast will perform the same checks at runtime as dynamic_cast, but will also ensure some amount of compile-time safety. Read more
source§

fn dynamic_cast_ref<T>(&self) -> Option<&T>
where T: ObjectType,

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more
source§

unsafe fn unsafe_cast<T>(self) -> T
where T: ObjectType,

Casts to T unconditionally. Read more
source§

unsafe fn unsafe_cast_ref<T>(&self) -> &T
where T: ObjectType,

Casts to &T unconditionally. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( _: *const GPtrArray, _: usize ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GPtrArray, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( ptr: *mut GPtrArray, num: usize ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>

source§

impl<O> GObjectPropertyExpressionExt for O
where O: IsA<Object>,

source§

fn property_expression(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property.
source§

fn property_expression_weak(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property with a weak reference.
source§

fn this_expression(property_name: &str) -> PropertyExpression

Create an expression looking up a property in the bound this object.
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

source§

impl<U> IsSubclassableExt for U

source§

impl<T> ObjectExt for T
where T: ObjectType,

source§

fn is<U>(&self) -> bool
where U: StaticType,

Returns true if the object is an instance of (can be cast to) T.
source§

fn type_(&self) -> Type

Returns the type of the object.
source§

fn object_class(&self) -> &Class<Object>

Returns the ObjectClass of the object. Read more
source§

fn class(&self) -> &Class<T>
where T: IsClass,

Returns the class of the object.
source§

fn class_of<U>(&self) -> Option<&Class<U>>
where U: IsClass,

Returns the class of the object in the given type T. Read more
source§

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>
where U: IsInterface,

Returns the interface T of the object. Read more
source§

fn set_property(&self, property_name: &str, value: impl Into<Value>)

Sets the property property_name of the object to value value. Read more
source§

fn set_property_from_value(&self, property_name: &str, value: &Value)

Sets the property property_name of the object to value value. Read more
source§

fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])

Sets multiple properties of the object at once. Read more
source§

fn set_properties_from_value(&self, property_values: &[(&str, Value)])

Sets multiple properties of the object at once. Read more
source§

fn property<V>(&self, property_name: &str) -> V
where V: for<'b> FromValue<'b> + 'static,

Gets the property property_name of the object and cast it to the type V. Read more
source§

fn property_value(&self, property_name: &str) -> Value

Gets the property property_name of the object. Read more
source§

fn has_property(&self, property_name: &str, type_: Option<Type>) -> bool

Check if the object has a property property_name of the given type_. Read more
source§

fn property_type(&self, property_name: &str) -> Option<Type>

Get the type of the property property_name of this object. Read more
source§

fn find_property(&self, property_name: &str) -> Option<ParamSpec>

Get the ParamSpec of the property property_name of this object.
source§

fn list_properties(&self) -> PtrSlice<ParamSpec>

Return all ParamSpec of the properties of this object.
source§

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

Freeze all property notifications until the return guard object is dropped. Read more
source§

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)
where QD: 'static,

Set arbitrary data on this object with the given key. Read more
source§

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>
where QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>
where QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn set_data<QD>(&self, key: &str, value: QD)
where QD: 'static,

Set arbitrary data on this object with the given key. Read more
source§

unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>
where QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>
where QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more
source§

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more
source§

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.
source§

fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)

Stop emission of the currently emitted signal.
source§

fn stop_signal_emission_by_name(&self, signal_name: &str)

Stop emission of the currently emitted signal by the (possibly detailed) signal name.
source§

fn connect<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_name on this object. Read more
source§

fn connect_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_id on this object. Read more
source§

fn connect_local<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_name on this object. Read more
source§

fn connect_local_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_id on this object. Read more
source§

unsafe fn connect_unsafe<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_name on this object. Read more
source§

unsafe fn connect_unsafe_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_id on this object. Read more
source§

fn connect_closure( &self, signal_name: &str, after: bool, closure: RustClosure ) -> SignalHandlerId

Connect a closure to the signal signal_name on this object. Read more
source§

fn connect_closure_id( &self, signal_id: SignalId, details: Option<Quark>, after: bool, closure: RustClosure ) -> SignalHandlerId

Connect a closure to the signal signal_id on this object. Read more
source§

fn watch_closure(&self, closure: &impl AsRef<Closure>)

Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to invoke_with_values, or invoke when using Rust closures.
source§

fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> R

Emit signal by signal id. Read more
source§

fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>

Same as Self::emit but takes Value for the arguments.
source§

fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> R

Emit signal by its name. Read more
source§

fn emit_by_name_with_values( &self, signal_name: &str, args: &[Value] ) -> Option<Value>

Emit signal by its name. Read more
source§

fn emit_by_name_with_details<R>( &self, signal_name: &str, details: Quark, args: &[&dyn ToValue] ) -> R

Emit signal by its name with details. Read more
source§

fn emit_by_name_with_details_and_values( &self, signal_name: &str, details: Quark, args: &[Value] ) -> Option<Value>

Emit signal by its name with details. Read more
source§

fn emit_with_details<R>( &self, signal_id: SignalId, details: Quark, args: &[&dyn ToValue] ) -> R

Emit signal by signal id with details. Read more
source§

fn emit_with_details_and_values( &self, signal_id: SignalId, details: Quark, args: &[Value] ) -> Option<Value>

Emit signal by signal id with details. Read more
source§

fn disconnect(&self, handler_id: SignalHandlerId)

Disconnect a previously connected signal handler.
source§

fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
where F: Fn(&T, &ParamSpec) + Send + Sync + 'static,

Connect to the notify signal of the object. Read more
source§

fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
where F: Fn(&T, &ParamSpec) + 'static,

Connect to the notify signal of the object. Read more
source§

unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F ) -> SignalHandlerId
where F: Fn(&T, &ParamSpec),

Connect to the notify signal of the object. Read more
source§

fn notify(&self, property_name: &str)

Notify that the given property has changed its value. Read more
source§

fn notify_by_pspec(&self, pspec: &ParamSpec)

Notify that the given property has changed its value. Read more
source§

fn downgrade(&self) -> WeakRef<T>

Downgrade this object to a weak reference.
source§

fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + Send + 'static,

Add a callback to be notified when the Object is disposed.
source§

fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + 'static,

Add a callback to be notified when the Object is disposed. Read more
source§

fn bind_property<'f, 't, O, 'a>( &'a self, source_property: &'a str, target: &'a O, target_property: &'a str ) -> BindingBuilder<'a, 'f, 't>
where O: ObjectType,

Bind property source_property on this object to the target_property on the target object. Read more
source§

fn ref_count(&self) -> u32

Returns the strong reference count of this object.
source§

unsafe fn run_dispose(&self)

Runs the dispose mechanism of the object. Read more
source§

impl<T> Property for T
where T: HasParamSpec,

§

type Value = T

source§

impl<T> PropertyGet for T
where T: HasParamSpec,

§

type Value = T

source§

fn get<R, F>(&self, f: F) -> R
where F: Fn(&<T as PropertyGet>::Value) -> R,

source§

impl<T> StaticTypeExt for T
where T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<O> StyleProviderExt for O
where O: IsA<StyleProvider>,

source§

fn connect_gtk_private_changed<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> TransparentType for T

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T> TryFromClosureReturnValue for T
where T: for<'a> FromValue<'a> + StaticType + 'static,

source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<'a, T, C, E> FromValueOptional<'a> for T
where T: FromValue<'a, Checker = C>, C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError<E>>, E: Error + Send + 'static,

source§

impl<Super, Sub> MayDowncastTo<Sub> for Super
where Super: IsA<Super>, Sub: IsA<Super>,