Struct FullWindowState

pub struct FullWindowState {

    pub title: String,
    pub size: WindowSize,
    pub position: Option<PhysicalPosition<u32>>,
    pub flags: WindowFlags,
    pub debug_state: DebugState,
    pub keyboard_state: KeyboardState,
    pub mouse_state: MouseState,
    pub ime_position: Option<LogicalPosition>,
    pub platform_specific_options: PlatformSpecificOptions,
    pub css: Css,
    pub previous_window_state: Option<Box<FullWindowState>>,
    pub hovered_file: Option<PathBuf>,
    pub dropped_file: Option<PathBuf>,
    pub focused_node: Option<(DomId, NodeId)>,
    pub hovered_nodes: BTreeMap<DomId, BTreeMap<NodeId, HitTestItem>>,
}

Fields

title: String

Current title of the window

size: WindowSize

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

position: Option<PhysicalPosition<u32>>

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

ime_position: Option<LogicalPosition>

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

css: Css

The style of this window

previous_window_state: Option<Box<FullWindowState>>

Previous window state, used for determining mouseout, etc. events

hovered_file: Option<PathBuf>

Whether there is a file currently hovering over the window

dropped_file: Option<PathBuf>

Whether there was a file currently dropped on the window

focused_node: Option<(DomId, NodeId)>

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

hovered_nodes: BTreeMap<DomId, BTreeMap<NodeId, HitTestItem>>

Currently hovered nodes, default to an empty Vec. Important for styling :hover elements.

Implementations

impl FullWindowState

pub fn get_mouse_state(&self) -> &MouseState

pub fn get_keyboard_state(&self) -> &KeyboardState

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

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

pub fn get_previous_window_state(&self) -> Option<&Box<FullWindowState>>

Returns the window state of the previous frame, useful for calculating metrics for dragging motions. Note that you can’t call this function recursively - calling get_previous_window_state() on the returned WindowState will yield a None value.

Trait Implementations

impl Clone for FullWindowState

fn clone(&self) -> FullWindowState

Returns a copy 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 From<WindowState> for FullWindowState

fn from(window_state: WindowState) -> FullWindowState

Creates a FullWindowState from a regular WindowState, fills non-available fields with their default values

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