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>,
    pub monitor_name: Option<String>,
    pub natural_scroll: bool,
}

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. This value has no default and needs to be set.

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. This value has no default and needs to be set.

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. Defaults to 0 for all sides.

layer_type: Layer

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

board_interactivity: Cell<KeyboardInteractivity>

Defines the relation of widget with Keyboard. View KeyboardInteractivity for more details. Defauts to KeyboardInteractivity::None

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. Defaults to no exclusive zone.

monitor_name: Option<String>

Defines the monitor name on which to spawn the window. When no monitor is provided, the window is spawned on the default monitor.

natural_scroll: bool

Defines if the method of scrolling for the widget should be natural or reverse. Defaults to reverse scrolling. Learn more about scrolling types here.

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

👎Deprecated since 1.0.2: Use the builder method to access all the configuration. It will be removed in release 1.0.3.

constructor method for initialising an instance of WindowConf.

pub fn builder() -> WindowConfBuilder

Creates a builder instance for creation of WindowConf, to view defaults head over to documentation of WindowConf’s parameters.

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.