Skip to main content

FrameController

Struct FrameController 

Source
pub struct FrameController { /* private fields */ }
Expand description

A UI-thread controller for one Slint window.

The controller intentionally is not Send or Sync: Slint windows and Win32 subclass operations belong to the UI thread. Cloning it is cheap.

Implementations§

Source§

impl FrameController

Source

pub fn attach<C: ComponentHandle + 'static>( component: &C, options: FrameOptions, ) -> Result<Self, FrameError>

Attach automatically during Slint’s first RenderingSetup callback.

This is the one-line API for normal applications. It occupies Slint’s rendering notifier for this window; use Self::attach_window if the application already owns that notifier.

Source

pub fn attach_window( window: &Window, options: FrameOptions, ) -> Result<Self, FrameError>

Attach immediately to an already-created Slint window.

Call this from the application’s own RenderingSetup notifier when it needs to keep using that notifier for custom rendering.

Source

pub fn on_event(&self, handler: impl Fn(FrameEvent) + 'static)

Receive hover/install/detach events. Replaces the previous handler.

Source

pub fn clear_event_handler(&self)

Remove the event handler.

Source

pub fn set_client_areas(&self, areas: impl Into<Vec<ClientArea>>)

Replace interactive Slint areas in the title bar.

Source

pub fn caption_hover(&self) -> Option<CaptionButton>

Current caption-button hover state.

Source

pub fn is_attached(&self) -> bool

Whether the Win32 frame is currently installed.

Source

pub fn last_error(&self) -> Option<FrameError>

Most recent asynchronous installation error, if any.

Source

pub fn detach(&self) -> Result<(), FrameError>

Restore the normal Windows non-client frame and remove the subclass.

Trait Implementations§

Source§

impl Clone for FrameController

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.