Struct Window

pub struct Window<T> {
    pub name: String,
    pub inner: T,
    pub options: WindowOptions,
}

Window component.

Fields

name: String

The name (title) of the window.

inner: T

Inner Component responsible for rendering content.

options: WindowOptions

Current window options state.

Implementations

impl<T> Window<T>

pub fn new<P>(name: impl Into<String>, inner: T, options: WindowOptions) -> Self

where T: Windowable<P>,

Creates a new window with WindowOptions and the passed Windowable component.

pub fn with_default<P>(name: impl Into<String>, options: WindowOptions) -> Self

where T: Default + Windowable<P>,

Creates a new window with WindowOptions and a default Windowable component.

pub fn key_press(&mut self, key: usize) -> bool

Handles a key press event.

Toggles visibility and returns true if the key matches the hotkey.

Trait Implementations

impl<T: Clone> Clone for Window<T>

fn clone(&self) -> Window<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, P> Component<P> for Window<T>

where T: Windowable<P>,

fn render(&mut self, ui: &Ui<'_>, props: P)

Renders the component.

impl<T: Debug> Debug for Window<T>

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

Formats the value using the given formatter.

impl<T> Deref for Window<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Window<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> HasSettings for Window<T>

where T: HasSettings,

const SETTINGS_ID: &'static str = T::SETTINGS_ID

The component’s settings id.

type Settings = WindowSettings<T>

fn current_settings(&self) -> Self::Settings

Returns the component’s current settings state.

fn load_settings(&mut self, loaded: Self::Settings)

Loads the component’s settings from a loaded state.

fn reset_settings(&mut self)

where Self::Settings: Default,

Resets the component’s settings to the defaults.

impl<T> Hideable for Window<T>

fn is_visible(&self) -> bool

Returns whether the component is currently visible.

fn visible_mut(&mut self) -> &mut bool

Returns a mutable reference to the component’s visibility state.

fn hide(&mut self)

Hides the component.

fn show(&mut self)

Shows the component.

fn toggle_visibility(&mut self)

Toggles the component’s visibility.

fn set_visibility(&mut self, visible: bool)

Sets the component’s visibility state.