Struct HistoryOpener 

pub struct HistoryOpener { /* private fields */ }

The window’s History control in a painted header row: what the host offered, the pointer’s hover over it, and a press waiting to go through the History door. Modelled on crate::search::SearchOpener: return Self::take from ActionControls::take_control_invocation.

A painted header row paints the control (Self::paint) and routes its pointer and its semantic node through the opener. A header row that hosts retained controls (a bar of library buttons) hosts Self::button_mut instead: the same History button NavShell shows, bound to the History door, at HISTORY_CONTROL_ID.

Implementations

impl HistoryOpener

pub fn new() -> HistoryOpener

pub fn set_control(&mut self, control: Option<HistoryControl>)

What the host offered (call from WindowHeader::set_history_control).

pub fn button(&self) -> Option<&Button>

The retained History button for a header row that hosts library controls: lay it out at the row’s History rect, keep it among the host’s children, draw it and route its events like the others. Its press goes through the History door by itself.

pub fn button_mut(&mut self) -> Option<&mut Button>

pub fn take_rebuilt(&mut self) -> bool

Whether the button was replaced since the last call: the host rebuilds its tree. Call Self::tree_rebuilt once it has.

pub fn tree_rebuilt(&mut self)

The host rebuilt its tree: replaced buttons may now be dropped.

pub fn control(&self) -> Option<HistoryControl>

The control to show, or None when the row has no History control.

pub fn is_shown(&self) -> bool

Whether the row shows the control.

pub fn activate(&mut self)

Press the control: open History, or close it while it shows.

pub fn take(&mut self) -> Option<ControlInvocation>

The press as an invocation of the History door, once.

pub fn is_pending(&self) -> bool

pub fn is_hovered(&self) -> bool

pub fn handle_event( &mut self, event: &WindowEvent, rect: Rect, scale_factor: f64, ) -> bool

Route event to the control at rect (its HeaderRowFace::history_rect). Returns whether the control took it (a press on it, and the release that follows; pointer motion only updates the hover); a release over the control after a press on it queues the press.

pub fn paint( &self, scene: &mut Scene, transform: Affine, text: &mut TextRenderer, theme: &Theme, rect: Rect, )

Paint the control at rect.

pub fn accessibility(&self, rect: Rect) -> Option<AccessNode>

The control’s node for the window’s semantic tree: a toggle button named “History”, pressed while History shows. Route an Activate on it back with Self::perform_action.

pub fn is_target(key_path: &[u64]) -> bool

Whether key_path (from Widget::perform_action) addresses the node Self::accessibility published.

pub fn perform_semantic_action(&mut self, target: &str, action: &Action) -> bool

Activate the control from its node addressed by its action target (Widget::perform_semantic_action); returns whether it did.

pub fn perform_action(&mut self, action: &Action, key_path: &[u64]) -> bool

Activate the control from its node; returns whether it did.

Trait Implementations

impl Debug for HistoryOpener

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

Formats the value using the given formatter.

impl Default for HistoryOpener

fn default() -> HistoryOpener

Returns the “default value” for a type.