Skip to main content

WindowFlags

Struct WindowFlags 

Source
#[repr(C)]
pub struct WindowFlags {
Show 16 fields pub frame: WindowFrame, pub close_requested: bool, pub decorations: WindowDecorations, pub is_visible: bool, pub is_always_on_top: bool, pub is_resizable: bool, pub has_focus: bool, pub background_material: WindowBackgroundMaterial, pub smooth_scroll_enabled: bool, pub autotab_enabled: bool, pub window_type: WindowType, pub has_decorations: bool, pub use_native_menus: bool, pub use_native_context_menus: bool, pub is_top_level: bool, pub prevent_system_sleep: bool,
}

Fields§

§frame: WindowFrame

Is the window currently maximized, minimized or fullscreen

§close_requested: bool

User clicked the close button (set by WindowDelegate, checked by event loop) The close_callback can set this to false to prevent closing

§decorations: WindowDecorations

Window decoration style (title bar, native controls)

§is_visible: bool

Is the window currently visible?

§is_always_on_top: bool

Is the window always on top?

§is_resizable: bool

Whether the window is resizable

§has_focus: bool

Whether the window has focus or not (mutating this will request user attention)

§background_material: WindowBackgroundMaterial

Compositor blur/transparency effect material

§smooth_scroll_enabled: bool

Is smooth scrolling enabled for this window?

§autotab_enabled: bool

Is automatic TAB switching supported?

§window_type: WindowType

Window type classification (Normal, Menu, Tooltip, Dialog)

§has_decorations: bool

Enable client-side decorations (custom titlebar with CSD) Only effective when decorations == WindowDecorations::None

§use_native_menus: bool

Use native menus (Win32 HMENU, macOS NSMenu) instead of Azul window-based menus Default: true on Windows/macOS, false on Linux

§use_native_context_menus: bool

Use native context menus instead of Azul window-based context menus Default: true on Windows/macOS, false on Linux

§is_top_level: bool

Keep window above all others (even from other applications) Platform-specific: Uses SetWindowPos(HWND_TOPMOST) on Windows, [NSWindow setLevel:] on macOS, _NET_WM_STATE_ABOVE on X11, zwlr_layer_shell on Wayland

§prevent_system_sleep: bool

Prevent system from sleeping while window is open Platform-specific: Uses SetThreadExecutionState on Windows, IOPMAssertionCreateWithName on macOS, org.freedesktop.ScreenSaver.Inhibit on Linux

Implementations§

Source§

impl WindowFlags

Source

pub fn is_menu_window(&self) -> bool

Check if window is a menu popup

Source

pub fn is_tooltip_window(&self) -> bool

Check if window is a tooltip

Source

pub fn is_dialog_window(&self) -> bool

Check if window is a dialog

Source

pub fn window_has_focus(&self) -> bool

Check if window currently has focus

Source

pub fn is_close_requested(&self) -> bool

Check if close was requested via callback

Source

pub fn has_csd(&self) -> bool

Check if window has client-side decorations enabled

Source

pub fn use_native_menus(&self) -> bool

Check if native menus should be used

Source

pub fn use_native_context_menus(&self) -> bool

Check if native context menus should be used

Trait Implementations§

Source§

impl Clone for WindowFlags

Source§

fn clone(&self) -> WindowFlags

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WindowFlags

Source§

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

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

impl Default for WindowFlags

Source§

fn default() -> Self

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

impl Hash for WindowFlags

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for WindowFlags

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for WindowFlags

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for WindowFlags

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Copy for WindowFlags

Source§

impl Eq for WindowFlags

Source§

impl StructuralPartialEq for WindowFlags

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> GetHash for T
where T: Hash,

Source§

fn get_hash(&self) -> u64

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.