Struct zng_app::update::UpdateDeliveryList

pub struct UpdateDeliveryList { /* private fields */ }

Represents all the widgets and windows marked to receive an update.

Implementations

impl UpdateDeliveryList

pub fn new(subscribers: Box<dyn UpdateSubscribers>) -> Self

New list that only allows subscribers.

pub fn new_none() -> Self

New list that does not allow any entry.

pub fn new_any() -> Self

New list that allows all entries.

This is the default value.

pub fn insert_wgt(&mut self, wgt: &impl WidgetPathProvider)

Insert the wgt and ancestors up-to the inner most that is included in the subscribers.

pub fn insert_window(&mut self, id: WindowId)

Insert the window by itself, the window root widget will be targeted.

pub fn search_all(&mut self)

Register all subscribers for search and delivery.

pub fn search_widget(&mut self, widget_id: WidgetId)

Register the widget of unknown location for search before delivery routing starts.

pub fn has_pending_search(&mut self) -> bool

If the list has pending widgets that must be found before delivery can start.

pub fn fulfill_search<'a, 'b>( &'a mut self, windows: impl Iterator<Item = &'b WidgetInfoTree>, )

Search all pending widgets in all windows, all search items are cleared, even if not found.

pub fn enter_window(&self, window_id: WindowId) -> bool

Returns true if the window is on the list.

pub fn enter_widget(&self, widget_id: WidgetId) -> bool

Returns true if the widget is on the list.

pub fn windows(&self) -> &IdSet<WindowId>

Windows in the delivery list.

pub fn widgets(&self) -> &IdSet<WidgetId>

Found widgets in the delivery list, can be targets or ancestors of targets.

pub fn search_widgets(&mut self) -> &IdSet<WidgetId>

Widgets still pending search or not found.

pub fn search_root(&mut self) -> bool

If search for window a root is pending.

Trait Implementations

impl Debug for UpdateDeliveryList

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

Formats the value using the given formatter.

impl Default for UpdateDeliveryList

fn default() -> Self

Returns the “default value” for a type.