Struct TaoWindowBuilder

pub struct TaoWindowBuilder {
    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() -> WindowBuilder

Initializes a new WindowBuilder with default values.

pub fn with_inner_size<S>(self, size: S) -> WindowBuilder

where S: Into<Size>,

Requests the window to be of specific dimensions.

See Window::set_inner_size for details.

pub fn with_min_inner_size<S>(self, min_size: S) -> WindowBuilder

where S: Into<Size>,

Sets a minimum dimension size for the window.

See Window::set_min_inner_size for details.

pub fn with_max_inner_size<S>(self, max_size: S) -> WindowBuilder

where S: Into<Size>,

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, ) -> WindowBuilder

Sets inner size constraints for the window.

See Window::set_inner_size_constraints for details.

pub fn with_position<P>(self, position: P) -> WindowBuilder

where P: Into<Position>,

Sets a desired initial position for the window.

See WindowAttributes::position for details.

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

Sets whether the window is resizable or not.

See Window::set_resizable for details.

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

Sets whether the window is minimizable or not.

See Window::set_minimizable for details.

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

Sets whether the window is maximizable or not.

See Window::set_maximizable for details.

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

Sets whether the window is closable or not.

See Window::set_closable for details.

pub fn with_title<T>(self, title: T) -> WindowBuilder

where T: Into<String>,

Requests a specific title for the window.

See Window::set_title for details.

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

Sets the window fullscreen state.

See Window::set_fullscreen for details.

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

Requests maximized mode.

See Window::set_maximized for details.

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

Sets whether the window will be initially hidden or visible.

See Window::set_visible for details.

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

Sets whether the background of the window should be transparent.

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

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) -> WindowBuilder

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) -> WindowBuilder

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>) -> WindowBuilder

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 with_background_color(self, color: (u8, u8, u8, u8)) -> WindowBuilder

Sets the window background color.

Platform-specific:

• Windows: alpha channel is ignored. Instead manually draw the window, for example using softbuffer crate, see https://github.com/tauri-apps/tao/blob/dev/examples/transparent.rs
• iOS / Android: Unsupported.

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

where T: 'static,

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<(), Error>

Formats the value using the given formatter.

impl Default for WindowBuilder

fn default() -> WindowBuilder

Returns the “default value” for a type.

impl WindowBuilderExtWindows for WindowBuilder

fn with_parent_window(self, parent: isize) -> WindowBuilder

Sets a parent to the window to be created.

fn with_owner_window(self, parent: isize) -> WindowBuilder

Set an owner to the window to be created. Can be used to create a dialog box, for example. Can be used in combination with WindowExtWindows::set_enable(false) on the owner window to create a modal dialog box.

fn with_menu(self, menu: isize) -> WindowBuilder

Sets a menu on the window to be created.

fn with_taskbar_icon(self, taskbar_icon: Option<Icon>) -> WindowBuilder

This sets ICON_BIG. A good ceiling here is 256x256.

fn with_no_redirection_bitmap(self, flag: bool) -> WindowBuilder

This sets WS_EX_NOREDIRECTIONBITMAP.

fn with_drag_and_drop(self, flag: bool) -> WindowBuilder

Enables or disables drag and drop support (enabled by default). Will interfere with other crates that use multi-threaded COM API (CoInitializeEx with COINIT_MULTITHREADED instead of COINIT_APARTMENTTHREADED) on the same thread. Note that tao may still attempt to initialize COM API regardless of this option. Currently only fullscreen mode does that, but there may be more in the future. If you need COM API with COINIT_MULTITHREADED you must initialize it before calling any tao functions. See https://docs.microsoft.com/en-us/windows/win32/api/objbase/nf-objbase-coinitialize#remarks for more information.

fn with_skip_taskbar(self, skip: bool) -> WindowBuilder

Whether to create the window icon with the taskbar icon or not.

fn with_window_classname<S>(self, classname: S) -> WindowBuilder

where S: Into<String>,

Customize the window class name.

fn with_undecorated_shadow(self, shadow: bool) -> WindowBuilder

Shows or hides the background drop shadow for undecorated windows.

fn with_rtl(self, rtl: bool) -> WindowBuilder

Sets right-to-left layout.