Struct tao::window::WindowBuilder

pub struct WindowBuilder {
    pub window: WindowAttributes,
    /* private fields */
}

Object that allows you to build windows.

Fields

window: WindowAttributes

The attributes to use to create the window.

Implementations

impl WindowBuilder

pub fn new() -> Self

Initializes a new WindowBuilder with default values.

pub fn with_inner_size<S: Into<Size>>(self, size: S) -> Self

Requests the window to be of specific dimensions.

See Window::set_inner_size for details.

pub fn with_min_inner_size<S: Into<Size>>(self, min_size: S) -> Self

Sets a minimum dimension size for the window.

See Window::set_min_inner_size for details.

pub fn with_max_inner_size<S: Into<Size>>(self, max_size: S) -> Self

Sets a maximum dimension size for the window.

See Window::set_max_inner_size for details.

pub fn with_inner_size_constraints( self, constraints: WindowSizeConstraints ) -> Self

Sets inner size constraints for the window.

See Window::set_inner_size_constraints for details.

pub fn with_position<P: Into<Position>>(self, position: P) -> Self

Sets a desired initial position for the window.

See WindowAttributes::position for details.

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

Sets whether the window is resizable or not.

See Window::set_resizable for details.

pub fn with_minimizable(self, minimizable: bool) -> Self

Sets whether the window is minimizable or not.

See Window::set_minimizable for details.

pub fn with_maximizable(self, maximizable: bool) -> Self

Sets whether the window is maximizable or not.

See Window::set_maximizable for details.

pub fn with_closable(self, closable: bool) -> Self

Sets whether the window is closable or not.

See Window::set_closable for details.

pub fn with_title<T: Into<String>>(self, title: T) -> Self

Requests a specific title for the window.

See Window::set_title for details.

pub fn with_fullscreen(self, fullscreen: Option<Fullscreen>) -> Self

Sets the window fullscreen state.

See Window::set_fullscreen for details.

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

Requests maximized mode.

See Window::set_maximized for details.

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

Sets whether the window will be initially hidden or visible.

See Window::set_visible for details.

pub fn with_transparent(self, transparent: bool) -> Self

Sets whether the background of the window should be transparent.

pub fn with_decorations(self, decorations: bool) -> Self

Sets whether the window should have a border, a title bar, etc.

See Window::set_decorations for details.

pub fn with_always_on_bottom(self, always_on_bottom: bool) -> Self

Sets whether or not the window will always be below other windows.

See Window::set_always_on_bottom for details.

pub fn with_always_on_top(self, always_on_top: bool) -> Self

Sets whether or not the window will always be on top of other windows.

See Window::set_always_on_top for details.

pub fn with_window_icon(self, window_icon: Option<Icon>) -> Self

Sets the window icon.

See Window::set_window_icon for details.

pub fn with_theme(self, theme: Option<Theme>) -> WindowBuilder

Forces a theme or uses the system settings if None was provided.

Platform-specific:

• Windows: It is recommended to always use the same theme used in EventLoopBuilderExtWindows::with_theme for this method also or use None so it automatically uses the theme used in EventLoopBuilderExtWindows::with_theme or falls back to the system preference, because EventLoopBuilderExtWindows::with_theme changes the theme for some controls like context menus which is app-wide and can’t be changed by this method.

pub fn with_focused(self, focused: bool) -> WindowBuilder

Whether the window will be initially focused or not.

Platform-specific:

Android / iOS: Unsupported.

pub fn with_content_protection(self, protected: bool) -> WindowBuilder

Prevents the window contents from being captured by other apps.

Platform-specific

• iOS / Android / Linux: Unsupported.

pub fn with_visible_on_all_workspaces(self, visible: bool) -> WindowBuilder

Sets whether the window should be visible on all workspaces.

Platform-specific

• iOS / Android / Windows: Unsupported.

pub fn build<T: 'static>( self, window_target: &EventLoopWindowTarget<T> ) -> Result<Window, OsError>

Builds the window.

Possible causes of error include denied permission, incompatible system, and lack of memory.

Trait Implementations

impl Clone for WindowBuilder

fn clone(&self) -> WindowBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowBuilder

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

Formats the value using the given formatter.

impl Default for WindowBuilder

fn default() -> WindowBuilder

Returns the “default value” for a type.

impl WindowBuilderExtMacOS for WindowBuilder

fn with_parent_window(self, parent: *mut c_void) -> WindowBuilder

Sets a parent to the window to be created.

fn with_movable_by_window_background( self, movable_by_window_background: bool ) -> WindowBuilder

Enables click-and-drag behavior for the entire window, not just the titlebar.

fn with_titlebar_transparent(self, titlebar_transparent: bool) -> WindowBuilder

Makes the titlebar transparent and allows the content to appear behind it.

fn with_titlebar_hidden(self, titlebar_hidden: bool) -> WindowBuilder

Hides the window titlebar.

fn with_titlebar_buttons_hidden( self, titlebar_buttons_hidden: bool ) -> WindowBuilder

Hides the window titlebar buttons.

fn with_title_hidden(self, title_hidden: bool) -> WindowBuilder

Hides the window title.

fn with_fullsize_content_view( self, fullsize_content_view: bool ) -> WindowBuilder

Makes the window content appear behind the titlebar.

fn with_resize_increments(self, increments: LogicalSize<f64>) -> WindowBuilder

Build window with resizeIncrements property. Values must not be 0.

fn with_disallow_hidpi(self, disallow_hidpi: bool) -> WindowBuilder

fn with_has_shadow(self, has_shadow: bool) -> WindowBuilder

Sets whether or not the window has shadow.

fn with_traffic_light_inset<P: Into<Position>>(self, inset: P) -> WindowBuilder

Sets the traffic light position to (x, y) relative to the upper left corner

fn with_automatic_window_tabbing(self, automatic_tabbing: bool) -> WindowBuilder

Sets whether the system can automatically organize windows into tabs.

fn with_tabbing_identifier(self, tabbing_identifier: &str) -> WindowBuilder

Defines the window tabbing identifier.