Enum fyrox_ui::window::WindowMessage

pub enum WindowMessage {
    Open {
        center: bool,
    },
    OpenModal {
        center: bool,
    },
    Close,
    Minimize(bool),
    Maximize,
    CanMinimize(bool),
    CanClose(bool),
    CanResize(bool),
    MoveStart,
    Move(Vector2<f32>),
    MoveEnd,
    Title(WindowTitle),
    SafeBorderSize(Option<Vector2<f32>>),
}

A set of possible messages that can be used to modify the state of a window or listen to changes in the window.

Variants

Open

Fields

center: bool

A flag that defines whether the window should be centered or not.

Opens a window.

OpenModal

Fields

center: bool

A flag that defines whether the window should be centered or not.

Opens window in modal mode. Modal mode does not blocks current thread, instead it just restricts mouse and keyboard events only to window so other content is not clickable/type-able. Closing a window removes that restriction.

Close

Closes a window.

Minimize(bool)

Minimizes a window - it differs from classic minimization in window managers, instead of putting window in system tray, it just collapses internal content panel.

Maximize

Forces the window to take the inner size of main application window.

CanMinimize(bool)

Whether or not window can be minimized by _ mark. false hides _ mark.

CanClose(bool)

Whether or not window can be closed by X mark. false hides X mark.

CanResize(bool)

Whether or not window can be resized by resize grips.

MoveStart

Indicates that move has been started. You should never send this message by hand.

Move(Vector2<f32>)

Moves window to a new position in local coordinates.

MoveEnd

Indicated that move has ended. You should never send this message by hand.

Title(WindowTitle)

Sets new window title.

SafeBorderSize(Option<Vector2<f32>>)

Safe border size defines “part” of a window that should always be on screen when dragged. It is used to prevent moving window outside of main application window bounds, to still be able to drag it.

Implementations

impl WindowMessage

pub fn open( destination: Handle<UiNode>, direction: MessageDirection, center: bool ) -> UiMessage

Creates WindowMessage::Open message.

pub fn open_modal( destination: Handle<UiNode>, direction: MessageDirection, center: bool ) -> UiMessage

Creates WindowMessage::OpenModal message.

pub fn close( destination: Handle<UiNode>, direction: MessageDirection ) -> UiMessage

Creates WindowMessage::Close message.

pub fn minimize( destination: Handle<UiNode>, direction: MessageDirection, value: bool ) -> UiMessage

Creates WindowMessage::Minimize message.

pub fn maximize( destination: Handle<UiNode>, direction: MessageDirection ) -> UiMessage

Creates WindowMessage::Maximize message.

pub fn can_minimize( destination: Handle<UiNode>, direction: MessageDirection, value: bool ) -> UiMessage

Creates WindowMessage::CanMinimize message.

pub fn can_close( destination: Handle<UiNode>, direction: MessageDirection, value: bool ) -> UiMessage

Creates WindowMessage::CanClose message.

pub fn can_resize( destination: Handle<UiNode>, direction: MessageDirection, value: bool ) -> UiMessage

Creates WindowMessage::CanResize message.

pub fn move_start( destination: Handle<UiNode>, direction: MessageDirection ) -> UiMessage

Creates WindowMessage::MoveStart message.

pub fn move_to( destination: Handle<UiNode>, direction: MessageDirection, value: Vector2<f32> ) -> UiMessage

Creates WindowMessage::Move message.

pub fn move_end( destination: Handle<UiNode>, direction: MessageDirection ) -> UiMessage

Creates WindowMessage::MoveEnd message.

pub fn title( destination: Handle<UiNode>, direction: MessageDirection, value: WindowTitle ) -> UiMessage

Creates WindowMessage::Title message.

pub fn safe_border_size( destination: Handle<UiNode>, direction: MessageDirection, value: Option<Vector2<f32>> ) -> UiMessage

Creates WindowMessage::SafeBorderSize message.

Trait Implementations

impl Clone for WindowMessage

fn clone(&self) -> WindowMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowMessage

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

Formats the value using the given formatter.

impl PartialEq<WindowMessage> for WindowMessage

fn eq(&self, other: &WindowMessage) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WindowMessage