Skip to main content

WindowOptions

Struct WindowOptions 

Source
pub struct WindowOptions {
Show 16 fields pub window_bounds: Option<WindowBounds>, pub titlebar: Option<TitlebarOptions>, pub focus: bool, pub show: bool, pub kind: WindowKind, pub is_movable: bool, pub app_owns_titlebar_drag: bool, pub is_resizable: bool, pub is_minimizable: bool, pub display_id: Option<DisplayId>, pub window_background: WindowBackgroundAppearance, pub app_id: Option<String>, pub window_min_size: Option<Size<Pixels>>, pub window_decorations: Option<WindowDecorations>, pub icon: Option<Arc<RgbaImage>>, pub tabbing_identifier: Option<String>,
}
Expand description

The variables that can be configured when creating a new window

Fields§

§window_bounds: Option<WindowBounds>

Specifies the state and bounds of the window in screen coordinates.

  • None: Inherit the bounds.
  • Some(WindowBounds): Open a window with corresponding state and its restore size.
§titlebar: Option<TitlebarOptions>

The titlebar configuration of the window

§focus: bool

Whether the window should be focused when created

§show: bool

Whether the window should be shown when created

§kind: WindowKind

The kind of window to create

§is_movable: bool

Whether the window can be moved by the user. When false, the user cannot drag the window (on macOS this sets NSWindow.isMovable, which also disables the Window-menu tiling items); programmatic moves are still allowed.

§app_owns_titlebar_drag: bool

Whether the application owns dragging of the (custom) titlebar, rather than AppKit. Only has an effect on macOS.

Set this to true for windows that draw their own titlebar and move the window themselves via Window::start_window_move. It marks the whole content view as app-owned titlebar content, so AppKit neither drags the window from the titlebar nor delays titlebar clicks while disambiguating double-clicks (a delay first observed on macOS 27). It is independent of is_movable, so such windows stay user-movable (via their own drag) and keep the Window-menu tiling items enabled.

Leave this false for windows that rely on AppKit’s native titlebar dragging.

§is_resizable: bool

Whether the window should be resizable by the user

§is_minimizable: bool

Whether the window should be minimized by the user

§display_id: Option<DisplayId>

The display to create the window on, if this is None, the window will be created on the main display

§window_background: WindowBackgroundAppearance

The appearance of the window background.

§app_id: Option<String>

Application identifier of the window. Can by used by desktop environments to group applications together.

§window_min_size: Option<Size<Pixels>>

Window minimum size

§window_decorations: Option<WindowDecorations>

Whether to use client or server-side decorations on X11 and Wayland. The platform may ignore requests it cannot satisfy.

§icon: Option<Arc<RgbaImage>>

Icon image (X11 only)

§tabbing_identifier: Option<String>

Tab group name, allows opening the window as a native tab on macOS 10.12+. Windows with the same tabbing identifier will be grouped together.

Trait Implementations§

Source§

impl Debug for WindowOptions

Source§

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

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

impl Default for WindowOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

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

Source§

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, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more