Struct arc_util::ui::window::WindowOptions

pub struct WindowOptions {
    pub visible: bool,
    pub position: WindowPosition,
    pub width: f32,
    pub height: f32,
    pub title_bar: bool,
    pub background: bool,
    pub title_bar_background: bool,
    pub resize: bool,
    pub auto_resize: bool,
    pub scroll: bool,
    pub scroll_bar: bool,
    pub hotkey: WindowHotkey,
}

Window options.

Fields

visible: bool

Whether the window is (currently) visible.

position: WindowPosition

Position of the window.

width: f32

Width of the window in pixels.

height: f32

Height of the window in pixels.

title_bar: bool

Whether to show the window titlebar.

background: bool

Whether to show the window body background.

title_bar_background: bool

Whether to show the window titlebar background.

resize: bool

Whether to allow manually resizing the window.

auto_resize: bool

Whether to automatically resize the window according to contents.

scroll: bool

Whether to allow scrolling.

scroll_bar: bool

Whether to show the scrollbar.

hotkey: WindowHotkey

Hotkey to open the window with.

Implementations

impl WindowOptions

pub fn new() -> Self

Creates new window options.

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.

pub fn update(&mut self, ui: &Ui<'_>)

Updates the options with values from the Ui

pub fn render_options_menus(&mut self, ui: &Ui<'_>, pos: [f32; 2])

Renders the options menus for window style & position.

pub fn render_style_options(&mut self, ui: &Ui<'_>)

Renders the window style options.

impl WindowOptions

pub fn render_window<'ui>( &mut self, ui: &'ui Ui<'_>, name: &str ) -> Option<WindowToken<'ui>>

Renders the window according to the options.

Trait Implementations

impl Clone for WindowOptions

fn clone(&self) -> WindowOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowOptions

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

Formats the value using the given formatter.

impl Default for WindowOptions

fn default() -> Self

Returns the “default value” for a type.

impl Hideable for WindowOptions

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.