Struct FullWindowState 

pub struct FullWindowState {

    pub theme: WindowTheme,
    pub title: AzString,
    pub size: WindowSize,
    pub position: WindowPosition,
    pub flags: WindowFlags,
    pub debug_state: DebugState,
    pub keyboard_state: KeyboardState,
    pub mouse_state: MouseState,
    pub touch_state: TouchState,
    pub ime_position: ImePosition,
    pub platform_specific_options: PlatformSpecificOptions,
    pub renderer_options: RendererOptions,
    pub background_color: ColorU,
    pub layout_callback: LayoutCallback,
    pub close_callback: OptionCallback,
    pub monitor: Monitor,
    pub hovered_file: Option<AzString>,
    pub dropped_file: Option<AzString>,
    pub focused_node: Option<DomNodeId>,
    pub last_hit_test: FullHitTest,
}

Fields

theme: WindowTheme

Theme of this window (dark or light) - can be set / overridden by the user

Usually the operating system will set this field. On change, it will emit a WindowEventFilter::ThemeChanged event

title: AzString

Current title of the window

size: WindowSize

Size of the window + max width / max height: 800 x 600 by default

position: WindowPosition

The x and y position, or None to let the WM decide where to put the window (default)

flags: WindowFlags

Flags such as whether the window is minimized / maximized, fullscreen, etc.

debug_state: DebugState

Mostly used for debugging, shows WebRender-builtin graphs on the screen. Used for performance monitoring and displaying frame times (rendering-only).

keyboard_state: KeyboardState

Current keyboard state - NOTE: mutating this field (currently) does nothing (doesn’t get synchronized with OS-level window)!

mouse_state: MouseState

Current mouse state

touch_state: TouchState

Stores all states of currently connected touch input devices, pencils, tablets, etc.

ime_position: ImePosition

Sets location of IME candidate box in client area coordinates relative to the top left of the window.

platform_specific_options: PlatformSpecificOptions

Window options that can only be set on a certain platform (WindowsWindowOptions / LinuxWindowOptions / MacWindowOptions).

renderer_options: RendererOptions

Information about vsync and hardware acceleration

background_color: ColorU

Background color of the window

layout_callback: LayoutCallback

The layout() function for this window, stored as a callback function pointer, There are multiple reasons for doing this (instead of requiring T: Layout everywhere):

• It seperates the Dom from the Layout trait, making it possible to split the UI solving and styling into reusable crates
• It’s less typing work (prevents having to type <T: Layout> everywhere)
• It’s potentially more efficient to compile (less type-checking required)
• It’s a preparation for the C ABI, in which traits don’t exist (for language bindings). In the C ABI “traits” are simply structs with function pointers (and void* instead of T)

close_callback: OptionCallback

Callback to run before the window closes. If this callback returns DoNothing, the window won’t close, otherwise it’ll close regardless

monitor: Monitor

Current monitor

hovered_file: Option<AzString>

Whether there is a file currently hovering over the window

dropped_file: Option<AzString>

Whether there was a file currently dropped on the window

focused_node: Option<DomNodeId>

What node is currently hovered over, default to None. Only necessary internal to the crate, for emitting On::FocusReceived and On::FocusLost events, as well as styling :focus elements

last_hit_test: FullHitTest

Last hit-test that was performed: necessary because the events are stored in a queue and only storing the hovered nodes is not sufficient to correctly determine events

Implementations

impl FullWindowState

pub fn get_mouse_state(&self) -> &MouseState

pub fn get_keyboard_state(&self) -> &KeyboardState

pub fn get_hovered_file(&self) -> Option<&AzString>

pub fn get_dropped_file(&self) -> Option<&AzString>

pub fn get_scroll_amount(&self) -> Option<(f32, f32)>

pub fn layout_callback_changed(&self, other: &Option<Self>) -> bool

pub fn from_window_state( window_state: &WindowState, dropped_file: Option<AzString>, hovered_file: Option<AzString>, focused_node: Option<DomNodeId>, last_hit_test: FullHitTest, ) -> Self

Creates a FullWindowState from a regular WindowState, fills non-available fields with the given values

You need to pass the extra fields explicitly in order to prevent state management bugs

pub fn process_system_scroll( &mut self, scroll_states: &ScrollStates, ) -> Option<ScrollResult>

Trait Implementations

impl Clone for FullWindowState

fn clone(&self) -> FullWindowState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FullWindowState

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

Formats the value using the given formatter.

impl Default for FullWindowState

fn default() -> Self

Returns the “default value” for a type.

impl From<FullWindowState> for WindowState

fn from(full_window_state: FullWindowState) -> WindowState

Converts to this type from the input type.

impl PartialEq for FullWindowState

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for FullWindowState