Struct WindowConf 

pub struct WindowConf {
    pub width: u32,
    pub height: u32,
    pub anchor: (Option<Anchor>, Option<Anchor>),
    pub margin: (i32, i32, i32, i32),
    pub layer_type: Layer,
    pub board_interactivity: Cell<KeyboardInteractivity>,
    pub exclusive_zone: Option<i32>,
}

WindowConf is an essential struct passed on to widget constructor functions (like invoke_spell) for defining the specifications of the widget.

Panics

event loops like cast_spell and encahnt_spells will panic if 0 is provided as width or height.

Fields

width: u32

Defines the widget width in pixels. On setting values greater than the provided pixels of monitor, the widget offsets from monitor’s rectangular monitor space. It is important to note that the value should be the maximum width the widget will ever attain, not the current width in case of resizeable widgets.

height: u32

Defines the widget height in pixels. On setting values greater than the provided pixels of monitor, the widget offsets from monitor’s rectangular monitor space. It is important to note that the value should be the maximum height the widget will ever attain, not the current height in case of resizeable widgets.

anchor: (Option<Anchor>, Option<Anchor>)

Defines the Anchors to which the window needs to be attached. View Anchor for related explaination of usage. If both values are None, then widget is displayed in the center of screen.

margin: (i32, i32, i32, i32)

Defines the margin of widget from monitor edges, negative values make the widget go outside of monitor pixels if anchored to some edge(s). Otherwise, the widget moves to the opposite direction to the given pixels.

layer_type: Layer

Defines the possible layer on which to define the widget. View Layer for more details.

board_interactivity: Cell<KeyboardInteractivity>

Defines the relation of widget with Keyboard. View KeyboardInteractivity for more details.

exclusive_zone: Option<i32>

Defines if the widget is exclusive of not,if not set to None, else set to number of pixels to set as exclusive zone as i32.

Implementations

impl WindowConf

pub fn new( max_width: u32, max_height: u32, anchor: (Option<Anchor>, Option<Anchor>), margin: (i32, i32, i32, i32), layer_type: Layer, board_interactivity: KeyboardInteractivity, exclusive_zone: Option<i32>, ) -> Self

constructor method for initialising an instance of WindowConf.

Trait Implementations

impl Clone for WindowConf

fn clone(&self) -> WindowConf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WindowConf

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

Formats the value using the given formatter.