Struct Document 

pub struct Document<Id> {
    pub id: Id,
    pub label: String,
    pub icon: Option<Glyph>,
    pub modified: bool,
    pub pinned: bool,
    pub closable: bool,
    pub locked: bool,
}

Available on crate feature document-tabs only.

One open document.

Fields

id: Id

label: String

icon: Option<Glyph>

modified: bool

Unsaved changes, shown as a dot in the tab’s slot.

pinned: bool

closable: bool

Whether the user can ask to close it. See Document::closable.

locked: bool

Whether it keeps its pinned state. See Document::locked.

Implementations

impl<Id> Document<Id>

pub fn icon(self, glyph: Glyph) -> Self

pub fn modified(self, modified: bool) -> Self

pub fn pinned(self, pinned: bool) -> Self

pub fn closable(self, closable: bool) -> Self

With false, the tab has no close button or Close item, and no close event or shortcut asks to close it. Defaults to true.

pub fn locked(self, locked: bool) -> Self

With true, the document stays pinned or unpinned as it is: its menu has no Pin or Unpin item and Event::Pin leaves it alone. It still moves within its group. Defaults to false.

Trait Implementations

impl<Id: Clone> Clone for Document<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 Document<Id>

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

Formats the value using the given formatter.

impl<Id: PartialEq> PartialEq for Document<Id>

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

Equality operator ==.

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

Inequality operator !=.

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