Struct LayoutMenu 

pub struct LayoutMenu {
    pub curr_layout: Option<String>,
    pub layouts: Vec<String>,
    pub config: LayoutMenuConfig,
    pub autosave: bool,
    pub favorites: Vec<String>,
    /* private fields */
}

Named layout menu. The host handles the returned intents, capturing a SavedLayout for each save. With set_storage the menu lists the layouts of StoreKind::Layouts and save, open, rename and delete keep them there; without it the host supplies layouts and keeps them itself.

Fields

curr_layout: Option<String>

Name of the current layout.

layouts: Vec<String>

The layouts available to open, sorted by name when read from storage.

config: LayoutMenuConfig

Menu sizing.

autosave: bool

Whether the current layout is saved after each change; see autosave_due.

favorites: Vec<String>

Names of the starred layouts. The menu stars and unstars them, moves a name on a rename and drops it on a delete; keep it between sessions in UserSettings::layout_favorites.

Implementations

impl LayoutMenu

pub const AUTOSAVE_DELAY: Duration

How long the layout stays unchanged before autosave_due asks for a save.

pub fn new() -> Self

Creates an unnamed layout menu.

pub fn set_storage(&mut self, storage: Arc<dyn Storage>)

Keep layouts in storage and list them from it.

pub fn set_sharing(&mut self, sharing: Arc<dyn Sharing>)

Offers copy-link and save-a-copy on the current stored layout, as sharing reports them. A saved copy is read back from the Storage given to set_storage, where the host writes it.

pub fn save(&mut self, name: &str, layout: &SavedLayout)

Saves layout as name, which becomes the current layout. With a layout of that name, replaces it.

pub fn open(&mut self, name: &str)

Reads the layout name; poll returns it to restore.

pub fn rename(&mut self, name: &str, layout: &SavedLayout)

Renames the current layout to name by saving layout, the current layout, under it and then deleting the old one.

pub fn delete(&mut self, name: &str)

Deletes the layout name.

pub fn poll(&mut self, ctx: &Context) -> Option<(String, SavedLayout)>

Receives storage’s answers, updating the list, and wakes the UI on the next answer. Returns a layout open read, now the current layout, for the host to restore before its next autosave_due.

pub fn autosave_due(&mut self, ctx: &Context, edits: u64) -> bool

Call every frame with a count that changes whenever the layout does, such as the sum of Chart::edit_count over its charts. Returns true when the host should save the current layout: autosave is on, the layout is stored, and the count changed and then stayed the same for AUTOSAVE_DELAY.

pub fn take_error(&mut self) -> Option<String>

The error of a failed storage request since the last call, to show to the user.

pub fn width(&self, ui: &Ui) -> f32

Width of the named trigger.

pub fn show(&mut self, ui: &mut Ui) -> LayoutAction

Shows the current name and an anchored menu. Actions do not mutate the host’s catalog.

pub fn show_menu(&mut self, ui: &mut Ui) -> LayoutAction

Named layout menu contents, shared with the save dropdown.

Trait Implementations

impl Default for LayoutMenu

fn default() -> Self

Returns the “default value” for a type.