pub struct WindowBuilder { /* private fields */ }
Expand description

A builder-pattern type to construct Window objects.

Implementations§

source§

impl WindowBuilder

source

pub fn application(self, application: &impl IsA<Application>) -> Self

The Application 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.

source

pub fn child(self, child: &impl IsA<Widget>) -> Self

The child widget.

source

pub fn decorated(self, decorated: bool) -> Self

Whether the window should have a frame (also known as decorations).

source

pub fn default_height(self, default_height: i32) -> Self

The default height of the window.

source

pub fn default_widget(self, default_widget: &impl IsA<Widget>) -> Self

The default widget.

source

pub fn default_width(self, default_width: i32) -> Self

The default width of the window.

source

pub fn deletable(self, deletable: bool) -> Self

Whether the window frame should have a close button.

source

pub fn destroy_with_parent(self, destroy_with_parent: bool) -> Self

If this window should be destroyed when the parent is destroyed.

source

pub fn display(self, display: &impl IsA<Display>) -> Self

The display that will display this window.

source

pub fn focus_visible(self, focus_visible: bool) -> Self

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.

source

pub fn focus_widget(self, focus_widget: &impl IsA<Widget>) -> Self

The focus widget.

source

pub fn fullscreened(self, fullscreened: bool) -> Self

Whether the window is fullscreen.

Setting this property is the equivalent of calling GtkWindowExt::fullscreen() or GtkWindowExt::unfullscreen(); either operation is asynchronous, which means you will need to connect to the ::notify signal in order to know whether the operation was successful.

source

pub fn handle_menubar_accel(self, handle_menubar_accel: bool) -> Self

Available on crate feature v4_2 only.

Whether the window frame should handle F10 for activating menubars.

source

pub fn hide_on_close(self, hide_on_close: bool) -> Self

If this window should be hidden when the users clicks the close button.

source

pub fn icon_name(self, icon_name: impl Into<GString>) -> Self

Specifies the name of the themed icon to use as the window icon.

See IconTheme for more details.

source

pub fn maximized(self, maximized: bool) -> Self

Whether the window is maximized.

Setting this property is the equivalent of calling GtkWindowExt::maximize() or GtkWindowExt::unmaximize(); either operation is asynchronous, which means you will need to connect to the ::notify signal in order to know whether the operation was successful.

source

pub fn mnemonics_visible(self, mnemonics_visible: bool) -> Self

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.

source

pub fn modal(self, modal: bool) -> Self

If true, the window is modal.

source

pub fn resizable(self, resizable: bool) -> Self

If true, users can resize the window.

source

pub fn startup_id(self, startup_id: impl Into<GString>) -> Self

A write-only property for setting window’s startup notification identifier.

source

pub fn title(self, title: impl Into<GString>) -> Self

The title of the window.

source

pub fn titlebar(self, titlebar: &impl IsA<Widget>) -> Self

Available on crate feature v4_6 only.

The titlebar widget.

source

pub fn transient_for(self, transient_for: &impl IsA<Window>) -> Self

The transient parent of the window.

source

pub fn can_focus(self, can_focus: bool) -> Self

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

source

pub fn can_target(self, can_target: bool) -> Self

Whether the widget can receive pointer events.

source

pub fn css_classes(self, css_classes: impl Into<StrV>) -> Self

A list of css classes applied to this widget.

source

pub fn css_name(self, css_name: impl Into<GString>) -> Self

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

source

pub fn cursor(self, cursor: &Cursor) -> Self

The cursor used by @widget.

source

pub fn focus_on_click(self, focus_on_click: bool) -> Self

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

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

source

pub fn focusable(self, focusable: bool) -> Self

Whether this widget itself will accept the input focus.

source

pub fn halign(self, halign: Align) -> Self

How to distribute horizontal space if widget gets extra space.

source

pub fn has_tooltip(self, has_tooltip: bool) -> Self

Enables or disables the emission of the ::query-tooltip signal on @widget.

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

source

pub fn height_request(self, height_request: i32) -> Self

Override for height request of the widget.

If this is -1, the natural request will be used.

source

pub fn hexpand(self, hexpand: bool) -> Self

Whether to expand horizontally.

source

pub fn hexpand_set(self, hexpand_set: bool) -> Self

Whether to use the hexpand property.

source

pub fn layout_manager(self, layout_manager: &impl IsA<LayoutManager>) -> Self

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

source

pub fn margin_bottom(self, margin_bottom: i32) -> Self

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 WidgetExt::set_size_request() for example.

source

pub fn margin_end(self, margin_end: i32) -> Self

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 WidgetExt::set_size_request() for example.

source

pub fn margin_start(self, margin_start: i32) -> Self

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 WidgetExt::set_size_request() for example.

source

pub fn margin_top(self, margin_top: i32) -> Self

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 WidgetExt::set_size_request() for example.

source

pub fn name(self, name: impl Into<GString>) -> Self

The name of the widget.

source

pub fn opacity(self, opacity: f64) -> Self

The requested opacity of the widget.

source

pub fn overflow(self, overflow: Overflow) -> Self

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

source

pub fn receives_default(self, receives_default: bool) -> Self

Whether the widget will receive the default action when it is focused.

source

pub fn sensitive(self, sensitive: bool) -> Self

Whether the widget responds to input.

source

pub fn tooltip_markup(self, tooltip_markup: impl Into<GString>) -> Self

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

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

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

source

pub fn tooltip_text(self, tooltip_text: impl Into<GString>) -> Self

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

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

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

source

pub fn valign(self, valign: Align) -> Self

How to distribute vertical space if widget gets extra space.

source

pub fn vexpand(self, vexpand: bool) -> Self

Whether to expand vertically.

source

pub fn vexpand_set(self, vexpand_set: bool) -> Self

Whether to use the vexpand property.

source

pub fn visible(self, visible: bool) -> Self

Whether the widget is visible.

source

pub fn width_request(self, width_request: i32) -> Self

Override for width request of the widget.

If this is -1, the natural request will be used.

source

pub fn accessible_role(self, accessible_role: AccessibleRole) -> Self

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

source

pub fn build(self) -> Window

Build the Window.

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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, U> TryFrom<U> for Twhere
    U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.