Struct HostedWindow 

pub struct HostedWindow { /* private fields */ }

One window a host shows an app in, shared by the host and the app. Clones are the same window.

Implementations

impl HostedWindow

pub fn new() -> HostedWindow

A window with no slots, nothing to hear and no close asked.

pub fn declare(&self, toolbar: Option<WindowToolbar>)

Declare the window’s slots (None: none), bounded as crate::window_toolbar::declare bounds them. Cheap when nothing changed.

pub fn notify(&self, notice: Option<ToolbarNotice>)

Show notice in the bar (None: take it down), bounded as crate::window_toolbar::notify bounds it. Cheap when nothing changed.

pub fn take_notice_press(&self, id: &str) -> bool

Whether the notice’s button id was pressed since the last call.

pub fn notice(&self) -> Option<ToolbarNotice>

The notice up.

pub fn show_reactions(&self, reactions: Option<ToolbarReactions>)

Show reactions at the bar’s end (None: none), bounded as crate::window_toolbar::show_reactions bounds them. Cheap when nothing changed.

pub fn show_view_only(&self, view_only: bool)

Say whether the window’s person may only look at what it shows. Said while the app syncs, inside a frame of its host’s: the host reads the bar after that sync, so this wakes no further frame.

pub fn view_only(&self) -> bool

Whether the window’s person may only look.

pub fn show_edited(&self, edited: bool)

Mark the window’s document as having work not yet saved. Said when a save stalls, fails or lands, which may be outside any sync of the app: the host is woken to read the bar again.

pub fn edited(&self) -> bool

Whether the window marks its document as not yet saved.

pub fn reactions(&self) -> Option<ToolbarReactions>

The reactions shown.

pub fn take_reaction_presses(&self) -> Vec<String>

The emoji pressed among the reactions since the last call.

pub fn take_events(&self) -> Vec<ToolbarEvent>

What the person did with the slots since the last call, oldest first.

pub fn close(&self)

Close this window’s tab, and the window with it when it is the only tab, the way the desktop closes any tab. From any thread.

pub fn set_session(&self, session: Option<String>)

Name the session-supervisor session this tab runs (None: none now), as the supervisor answered when it opened. From any thread.

pub fn set_workspace(&self, workspace: Option<String>)

Put the window in workspace (a workspace id).

pub fn workspace(&self) -> Option<String>

The workspace the window is in, when its host said.

pub fn declared(&self) -> Option<WindowToolbar>

The slots as last declared.

pub fn shown(&self) -> Option<WindowToolbar>

What the window’s bar shows: the slots as declared, with the notice up and the reactions at the end, which are the window’s own (Self::notify, Self::show_reactions).

pub fn revision(&self) -> u64

Bumped by every declaration that changed the slots.

pub fn edit_location(&self)

Ask the bar to turn the location into a field, as a click on it does.

pub fn open_search(&self, opening: SearchOpening)

Ask the bar to open the window’s search, as a click on its control does.

pub fn declare_embeds(&self, embeds: Vec<Embed>)

Ask for embeds in this window (crate::window_share::declare). Cheap when nothing changed.

pub fn embed_state(&self, key: &str) -> Option<EmbedState>

How the host said key’s embed is coming along.

pub fn embeds(&self) -> Vec<Embed>

The embeds the app asks for, as last declared.

pub fn set_embed_state(&self, key: &str, embed: EmbedState)

Say how key’s embed is coming along.

pub fn session(&self) -> Option<String>

The session-supervisor session the tab runs, as the app named it.

pub fn is(&self, other: &HostedWindow) -> bool

Whether other is this same window (a clone of it).

pub fn take_edit_request(&self) -> bool

Whether the app asked to edit its location since the last call.

pub fn take_search_request(&self) -> Option<SearchOpening>

How the app asked to open the window’s search since the last call.

pub fn set_wake(&self, wake: impl Fn() + Send + Sync + 'static)

What the host runs when the app declares new slots or asks to close.

pub fn toolbar_since( &self, seen: Option<u64>, ) -> Option<(u64, Option<WindowToolbar>)>

The slots and their revision, when the revision is not seen (the one the host last showed; None: it showed none yet).

pub fn deliver(&self, event: ToolbarEvent)

Hand the app what the person did with its slots.

pub fn take_close(&self) -> bool

Whether the app asked to close its tab since the last call.

Trait Implementations

impl Clone for HostedWindow

fn clone(&self) -> HostedWindow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HostedWindow

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

Formats the value using the given formatter.

impl Default for HostedWindow

fn default() -> HostedWindow

Returns the “default value” for a type.