Struct sixtyfps_corelib::window::Window

pub struct Window {
    pub meta_properties_tracker: Pin<Rc<PropertyTracker>>,
    // some fields omitted
}

Structure that represent a Window in the runtime

Fields

meta_properties_tracker: Pin<Rc<PropertyTracker>>

Gets dirty when the layout restrictions, or some other property of the windows change FIXME: should only be exposed to the backend

Implementations

impl Window

pub fn new(
    platform_window_fn: impl FnOnce(&Weak<Window>) -> Rc<dyn PlatformWindow>
) -> Rc<Self>

Create a new instance of the window, given the platform_window factory fn

pub fn set_component(&self, component: &ComponentRc)

Associates this window with the specified component. Further event handling and rendering, etc. will be done with that component.

pub fn component(&self) -> ComponentRc

return the component. Panics if it wasn’t set.

pub fn try_component(&self) -> Option<ComponentRc>

returns the component or None if it isn’t set.

pub fn process_mouse_input(self: Rc<Self>, event: MouseEvent)

Receive a mouse event and pass it to the items of the component to change their state.

Arguments:

• pos: The position of the mouse event in window physical coordinates.
• what: The type of mouse event.
• component: The SixtyFPS compiled component that provides the tree of items.

pub fn process_key_input(self: Rc<Self>, event: &KeyEvent)

Receive a key event and pass it to the items of the component to change their state.

Arguments:

• event: The key event received by the windowing system.
• component: The SixtyFPS compiled component that provides the tree of items.

pub fn set_cursor_blink_binding(&self, prop: &Property<bool>)

Installs a binding on the specified property that’s toggled whenever the text cursor is supposed to be visible or not.

pub fn set_focus_item(self: Rc<Self>, focus_item: &ItemRc)

Sets the focus to the item pointed to by item_ptr. This will remove the focus from any currently focused item.

pub fn set_focus(self: Rc<Self>, have_focus: bool)

Sets the focus on the window to true or false, depending on the have_focus argument. This results in WindowFocusReceived and WindowFocusLost events.

pub fn update_window_properties(&self)

If the component’s root item is a Window element, then this function synchronizes its properties, such as the title for example, with the properties known to the windowing system.

pub fn draw_tracked<R>(self: Rc<Self>, draw_fn: impl FnOnce() -> R) -> R

Calls draw_fn using a crate::properties::PropertyTracker, which is set up to issue a call to PlatformWindow::request_redraw when any properties accessed during drawing change.

pub fn show(&self)

Registers the window with the windowing system, in order to render the component’s items and react to input events once the event loop spins.

pub fn hide(&self)

De-registers the window with the windowing system.

Trait Implementations

impl Deref for Window

type Target = dyn PlatformWindow

The resulting type after dereferencing.

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

Dereferences the value.

impl Drop for Window

fn drop(&mut self)

Executes the destructor for this type.