Struct libhandy::PreferencesWindow

pub struct PreferencesWindow { /* private fields */ }

A window to present an application’s preferences.

The PreferencesWindow widget presents an application’s preferences gathered into pages and groups. The preferences are searchable by the user.

CSS nodes

PreferencesWindow has a main CSS node with the name window and the style class .preferences.

Properties

can-swipe-back

Whether the window allows closing the subpage via a swipe gesture.

Readable | Writeable

search-enabled

Whether search is enabled.

Readable | Writeable

Window

accept-focus

Whether the window should receive the input focus.

Readable | Writeable

application

The #GtkApplication associated with the window.

The application will be kept alive for at least as long as it has any windows associated with it (see g_application_hold() for a way to keep it alive without windows).

Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove it by setting the :application property to None.

Readable | Writeable

attached-to

The widget to which this window is attached. See gtk_window_set_attached_to().

Examples of places where specifying this relation is useful are for instance a #GtkMenu created by a #GtkComboBox, a completion popup window created by #GtkEntry or a typeahead search entry created by #GtkTreeView.

Readable | Writeable | Construct

decorated

Whether the window should be decorated by the window manager.

Readable | Writeable

default-height

Readable | Writeable

default-width

Readable | Writeable

deletable

Whether the window frame should have a close button.

Readable | Writeable

destroy-with-parent

Readable | Writeable

focus-on-map

Whether the window should receive the input focus when mapped.

Readable | Writeable

focus-visible

Whether ‘focus rectangles’ are currently visible in this window.

This property is maintained by GTK+ based on user input and should not be set by applications.

Readable | Writeable

gravity

The window gravity of the window. See gtk_window_move() and #GdkGravity for more details about window gravity.

Readable | Writeable

has-resize-grip

Whether the window has a corner resize grip.

Note that the resize grip is only shown if the window is actually resizable and not maximized. Use #GtkWindow:resize-grip-visible to find out if the resize grip is currently shown.

Readable | Writeable

has-toplevel-focus

Readable

hide-titlebar-when-maximized

Whether the titlebar should be hidden during maximization.

Readable | Writeable

icon

Readable | Writeable

icon-name

The :icon-name property specifies the name of the themed icon to use as the window icon. See #GtkIconTheme for more details.

Readable | Writeable

is-active

Readable

is-maximized

Readable

mnemonics-visible

Whether mnemonics are currently visible in this window.

This property is maintained by GTK+ based on user input, and should not be set by applications.

Readable | Writeable

modal

Readable | Writeable

resizable

Readable | Writeable

resize-grip-visible

Whether a corner resize grip is currently shown.

Readable

role

Readable | Writeable

screen

Readable | Writeable

skip-pager-hint

Readable | Writeable

skip-taskbar-hint

Readable | Writeable

startup-id

The :startup-id is a write-only property for setting window’s startup notification identifier. See gtk_window_set_startup_id() for more details.

Writeable

title

Readable | Writeable

transient-for

The transient parent of the window. See gtk_window_set_transient_for() for more details about transient windows.

Readable | Writeable | Construct

type

Readable | Writeable | Construct Only

type-hint

Readable | Writeable

urgency-hint

Readable | Writeable

window-position

Readable | Writeable

Container

border-width

Readable | Writeable

child

Writeable

resize-mode

Readable | Writeable

Widget

app-paintable

Readable | Writeable

can-default

Readable | Writeable

can-focus

Readable | Writeable

composite-child

Readable

double-buffered

Whether the widget is double buffered.

Readable | Writeable

events

Readable | Writeable

expand

Whether to expand in both directions. Setting this sets both #GtkWidget:hexpand and #GtkWidget:vexpand

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Before 3.20, several widgets (GtkButton, GtkFileChooserButton, GtkComboBox) implemented this property individually.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space, see #GtkAlign

Readable | Writeable

has-default

Readable | Writeable

has-focus

Readable | Writeable

has-tooltip

Enables or disables the emission of #GtkWidget::query-tooltip on @widget. A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using #GtkWidget::query-tooltip to determine whether it will provide a tooltip or not.

Note that setting this property to true for the first time will change the event masks of the GdkWindows of this widget to include leave-notify and motion-notify events. This cannot and will not be undone when the property is set to false again.

Readable | Writeable

height-request

Readable | Writeable

hexpand

Whether to expand horizontally. See gtk_widget_set_hexpand().

Readable | Writeable

hexpand-set

Whether to use the #GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().

Readable | Writeable

is-focus

Readable | Writeable

margin

Sets all four sides’ margin at once. If read, returns max margin on any side.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-left

Margin on left side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-right

Margin on right side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from gtk_widget_set_size_request() for example.

Readable | Writeable

name

Readable | Writeable

no-show-all

Readable | Writeable

opacity

The requested opacity of the widget. See gtk_widget_set_opacity() for more details about window opacity.

Before 3.8 this was only available in GtkWindow

Readable | Writeable

parent

Readable | Writeable

receives-default

Readable | Writeable

scale-factor

The scale factor of the widget. See gtk_widget_get_scale_factor() for more details about widget scaling.

Readable

sensitive

Readable | Writeable

style

The style of the widget, which contains information about how it will look (colors, etc).

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see gtk_tooltip_set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: #GtkWidget:has-tooltip will automatically be set to true and there will be taken care of #GtkWidget::query-tooltip in the default signal handler.

Note that if both #GtkWidget:tooltip-text and #GtkWidget:tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see gtk_tooltip_set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: #GtkWidget:has-tooltip will automatically be set to true and there will be taken care of #GtkWidget::query-tooltip in the default signal handler.

Note that if both #GtkWidget:tooltip-text and #GtkWidget:tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space, see #GtkAlign

Readable | Writeable

vexpand

Whether to expand vertically. See gtk_widget_set_vexpand().

Readable | Writeable

vexpand-set

Whether to use the #GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().

Readable | Writeable

visible

Readable | Writeable

width-request

Readable | Writeable

window

The widget’s window if it is realized, None otherwise.

Readable

Implements

PreferencesWindowExt, [WindowExt][trait@crate::prelude::WindowExt], gtk::prelude::GtkWindowExt, gtk::prelude::BinExt, gtk::prelude::ContainerExt, gtk::prelude::WidgetExt, glib::ObjectExt, gtk::prelude::BuildableExt

Implementations

impl PreferencesWindow

pub const NONE: Option<&'static PreferencesWindow> = None

pub fn new() -> PreferencesWindow

Creates a new PreferencesWindow.

Returns

the newly created PreferencesWindow

pub fn builder() -> PreferencesWindowBuilder

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

This method returns an instance of PreferencesWindowBuilder which can be used to create PreferencesWindow objects.

Trait Implementations

impl Clone for PreferencesWindow

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PreferencesWindow

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

Formats the value using the given formatter.

impl Default for PreferencesWindow

fn default() -> Self

Returns the “default value” for a type.

impl Display for PreferencesWindow

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

Formats the value using the given formatter.

impl HasParamSpec for PreferencesWindow

type ParamSpec = ParamSpecObject

type SetValue = PreferencesWindow

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for PreferencesWindow

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PreferencesWindow

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for PreferencesWindow

type Parent = Window

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

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

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

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.

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

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for PreferencesWindow

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PreferencesWindow

impl IsA<Bin> for PreferencesWindow

impl IsA<Buildable> for PreferencesWindow

impl IsA<Container> for PreferencesWindow

impl IsA<Widget> for PreferencesWindow

impl IsA<Window> for PreferencesWindow

impl IsA<Window> for PreferencesWindow