Enum ActiveDialog 

pub enum ActiveDialog {
    Menu(FileOpsMenuDialog),
    Delete(DeleteConfirmDialog),
    Rename(RenameDialog),
    Move(MoveDialog),
    CreateNote(CreateNoteDialog),
    Help(HelpDialog),
    QuickNote(QuickNoteModal),
    WorkspaceSwitcher(WorkspaceSwitcherModal),
    SaveSearch(SaveSearchDialog),
    Sort(SortDialog),
    PinnedNotes(PinnedNotesDialog),
    ThemePicker(Box<ThemePickerDialog>),
    UpdateAvailable(UpdateAvailableDialog),
    Info(InfoDialog),
    Properties(PropertiesDialog),
}

Variants

Menu(FileOpsMenuDialog)

Delete(DeleteConfirmDialog)

Rename(RenameDialog)

Move(MoveDialog)

CreateNote(CreateNoteDialog)

Help(HelpDialog)

QuickNote(QuickNoteModal)

WorkspaceSwitcher(WorkspaceSwitcherModal)

SaveSearch(SaveSearchDialog)

Sort(SortDialog)

PinnedNotes(PinnedNotesDialog)

ThemePicker(Box<ThemePickerDialog>)

UpdateAvailable(UpdateAvailableDialog)

Info(InfoDialog)

Properties(PropertiesDialog)

Implementations

impl ActiveDialog

pub fn set_error(&mut self, msg: String)

pub fn help(key_bindings: &KeyBindings, tree: &LeaderNode) -> Self

pub fn cheatsheet(settings: &AppSettings) -> Self

The full leader-tree cheatsheet (leader ?).

pub fn query_syntax() -> Self

The search query syntax reference (F1 over the Find drawer view).

pub fn theme_picker(settings: &AppSettings) -> Self

The live theme picker (leader v c).

pub fn update(status: &UpdateStatus) -> Self

The update-available dialog.

pub fn info( title: impl Into<String>, headline: impl Into<String>, body: impl Into<String>, ) -> Self

A read-only message dialog: headline, wrapped body, [Esc] Close.

pub fn server_update(update: &ServerUpdate) -> Self

The server-update hint (footer rag: segment). The TUI can’t tell how the server was installed, so it only points at the user’s own method.

pub fn quick_note(vault: Arc<NoteVault>) -> Self

pub fn workspace_switcher(settings: &AppSettings) -> Self

pub fn create_note( path: VaultPath, vault: Arc<NoteVault>, content: Option<String>, ) -> Self

pub fn save_search( query: String, provenance: Option<String>, source: SaveSource, vault: Arc<NoteVault>, tx: &AppTx, ) -> Self

Open the save-search dialog. provenance is the saved-search name the query came from (the breadcrumb), pre-filled as the default name. The existing names load in the background and arrive via OverlayData::SavedSearchNamesLoaded to drive the dialog’s hint.

pub fn sort( target: SortTarget, state: SortState, unsorted: bool, allows_property: bool, vault: Option<Arc<NoteVault>>, tx: &AppTx, ) -> Self

The sort dialog for target, opened on its state (shown as “Unsorted” while unsorted). With a vault, the property keys load in the background for the Key picker (pass one exactly when allows_property).

pub fn pinned_notes(vault: Arc<NoteVault>, tx: &AppTx) -> Self

The pinned-notes dialog (leader f p). Loads in the background and arrives via OverlayData::PinnedNotesLoaded.

pub fn properties(path: VaultPath, vault: Arc<NoteVault>, tx: &AppTx) -> Self

pub fn file_ops_menu(path: VaultPath) -> Self

pub fn delete(path: VaultPath, vault: Arc<NoteVault>) -> Self

pub fn rename(path: VaultPath, vault: Arc<NoteVault>) -> Self

pub fn move_to(path: VaultPath, vault: Arc<NoteVault>, tx: &AppTx) -> Self

Trait Implementations

impl Component for ActiveDialog

fn handle_input(&mut self, event: &InputEvent, tx: &AppTx) -> EventState

Handle an event. Send AppEvents through tx for app-level effects. Returns whether this component consumed the event.

fn render( &mut self, f: &mut Frame<'_>, rect: Rect, theme: &Theme, _focused: bool, )

fn hint_shortcuts(&self) -> Vec<(String, String)>

Context-sensitive shortcut hints shown in the hints bar when this component is focused. Each entry is (key_display, label).

impl Overlay for ActiveDialog

fn kind(&self) -> OverlayKind

fn handle_input(&mut self, event: &InputEvent, tx: &AppTx) -> EventState

fn handle_data( &mut self, data: &OverlayData, _vault: &Arc<NoteVault>, tx: &AppTx, ) -> OverlayMsg

Receive an Overlay data result addressed to this overlay (see CONTEXT.md). NotConsumed means the data was not for this overlay (or is stale) — the host drops it; nothing else ever sees it.

fn render(&mut self, f: &mut Frame<'_>, area: Rect, theme: &Theme)

fn hint_shortcuts(&self) -> Vec<(String, String)>

fn query(&self) -> Option<&str>

The query string this overlay holds, if it is query-backed (the note browser). Used by the editor’s save-current-query action to source the query from the active overlay. Defaults to None for non-query overlays.

fn saved_search_provenance(&self) -> Option<&str>

The saved-search name this overlay’s query came from (its breadcrumb provenance), if any. Used to pre-fill the save-search dialog’s name. Defaults to None for overlays without a breadcrumb.

fn as_sortable(&self) -> Option<&dyn SortableList>

This overlay as a list the sort dialog can sort, if it is one (the Ctrl+K search browser or the Ctrl+O file finder). Drives Ctrl+R over an open overlay. Defaults to None.

fn takes_query_syntax(&self) -> bool

Whether this overlay’s input takes the query syntax (the Ctrl+K search browser) — F1 and its [F1] chip then open the syntax reference over it. Defaults to false.

fn as_sortable_mut(&mut self) -> Option<&mut dyn SortableList>

Mutable twin of Self::as_sortable, for applying a sort to the overlay parked under the sort dialog.