Struct sixtyfps_corelib::window::ComponentWindow

#[repr(C)]
pub struct ComponentWindow(pub Rc<Window>);

The ComponentWindow is the (rust) facing public type that can render the items of components to the screen.

Implementations

impl ComponentWindow

pub fn new(window_impl: Rc<Window>) -> Self

Creates a new instance of a CompomentWindow based on the given window implementation. Only used internally.

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.

pub fn scale_factor(&self) -> f32

Returns the scale factor set on the window.

pub fn set_scale_factor(&self, factor: f32)

Sets an overriding scale factor for the window. This is typically only used for testing.

pub fn free_graphics_resources<'a>(&self, items: &Slice<'a, Pin<ItemRef<'a>>>)

This function is called by the generated code when a component and therefore its tree of items are destroyed. The implementation typically uses this to free the underlying graphics resources cached via RenderingCache.

pub fn set_focus_item(&self, focus_item: &ItemRc)

Clears the focus on any previously focused item and makes the provided item the focus item, in order to receive future key events.

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

Associates this window with the specified component, for future event handling, etc.

pub fn show_popup(&self, popup: &ComponentRc, position: Point)

Show a popup at the given position

pub fn close_popup(&self)

Close the active popup if any

Trait Implementations

impl Clone for ComponentWindow

fn clone(&self) -> ComponentWindow

Returns a copy of the value.

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

Performs copy-assignment from source.