Struct State 

pub struct State<Id> { /* private fields */ }

Available on crate feature document-tabs only.

The open documents, the active one and the order they were used in.

Implementations

impl<Id: Copy + PartialEq> State<Id>

pub fn new(documents: impl IntoIterator<Item = Document<Id>>) -> Self

Opens documents, pinned ones first, with the first one active. Ids must be unique.

pub fn with_active(self, id: Id) -> Self

Starts on id, when it exists.

pub fn with_menu_items( self, entries: impl IntoIterator<Item = Entry<MenuItem>>, ) -> Self

Adds items to the end of every tab’s context menu, such as “Copy path”. Give them MenuItem::Custom ids.

pub fn documents(&self) -> &[Document<Id>]

The documents in strip order.

pub fn document(&self, id: Id) -> Option<&Document<Id>>

pub fn active(&self) -> Option<Id>

pub fn is_active(&self, id: Id) -> bool

pub fn recent(&self) -> &[Id]

Document ids, most recently used first.

pub fn menu(&self) -> &State<MenuItem, Id>

The tab context menu.

pub fn overflow(&self) -> &State<Id>

The menu listing every document.

pub fn pinned_count(&self) -> usize

How many documents are pinned. They are always the first ones.

pub fn open(&mut self, document: Document<Id>)

Activates document, adding it at the end of its group (pinned or not) when it is not open yet.

pub fn close(&mut self, ids: &[Id]) -> Option<Id>

Closes documents. When the active one closes, the most recently used one left becomes active, and is returned.

pub fn set_modified(&mut self, id: Id, modified: bool)

Marks a document as having unsaved changes, or as saved.

pub fn set_label(&mut self, id: Id, label: impl Into<String>)

pub fn update(&mut self, event: Event<Id>) -> Option<Output<Id>>

Applies an event and returns what changed, if anything.

Trait Implementations

impl<Id: Clone> Clone for State<Id>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Id: Debug> Debug for State<Id>

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

Formats the value using the given formatter.

impl<Id: PartialEq> PartialEq for State<Id>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<Id: PartialEq> StructuralPartialEq for State<Id>