Struct DescriptionEditor 

pub struct DescriptionEditor {
    pub menu: Option<SlashMenu>,
    /* private fields */
}

Fields

menu: Option<SlashMenu>

Implementations

impl DescriptionEditor

pub fn new(blocks: &[Block]) -> Self

pub fn new_with_images( blocks: &[Block], image_root: PathBuf, attachments: &[Attachment], ) -> Self

pub fn plain(text: &str) -> Self

A text-only editor for category descriptions. It supports prose, bullets, numbered lists, and links, but not task-only to-dos or images.

pub fn set_image_root(&mut self, image_root: PathBuf)

pub fn set_attachments(&mut self, attachments: &[Attachment])

pub fn image_root(&self) -> &Path

pub fn allowed_commands(&self) -> &'static [Command]

Commands the / menu may offer in this editor.

pub fn menu_commands(&self) -> Vec<Command>

Filtered slash-menu rows for the open menu, if any.

pub fn command_hint(&self, command: Command) -> &'static str

pub fn plain_value(&self) -> String

The prose back out, one block per line.

pub fn value(&self) -> Vec<Block>

The blocks worth saving. Empty prose lines are layout and round-trip with surrounding content; an entirely empty editor stays an empty description.

pub fn is_empty(&self) -> bool

pub fn progress(&self) -> (usize, usize)

pub fn cursor_line(&self) -> usize

Index of the block under the cursor.

pub fn has_selection(&self) -> bool

Whether any description or in-line selection is active (no string build).

pub fn selected_text(&self) -> Option<String>

Selected text: multi-line description selection if active, else the current line’s in-line selection. Pictures become [image: path].

pub fn selected_payload(&self) -> Option<CopyPayload>

Clipboard payload for the current selection (text, picture, or both).

pub fn line_in_selection(&self, i: usize) -> bool

Whether line i sits inside the description selection (for frames / paint). A picture is selected as a whole unit whenever the range covers it (including when the caret has only just landed on it).

pub fn delete_description_selection(&mut self) -> bool

Delete description-level or in-line selection. Returns true if anything was removed.

pub fn link_url_at_cursor(&self) -> Option<String>

URL of the link block under the cursor, if any.

pub fn link_url_at_position(&self, row: u16, col: usize) -> Option<String>

URL under a rendered description cell. Padding to the right of a short link is deliberately not interactive.

pub fn selected_image(&self) -> Option<PathBuf>

pub fn images(&self) -> Vec<PathBuf>

Every image in the description, so the dialog can preview one.

pub fn abandon_image_selection(&mut self)

Move the cursor off a picture onto a neighbouring text line without inserting blanks. Used when a click lands on the letterbox gutter. If there is no editable neighbour, the cursor stays on the picture (←/→ still create a caret).

pub fn insert(&mut self, c: char)

pub fn insert_str(&mut self, text: &str)

pub fn newline(&mut self) -> bool

Enter continues to-do, bullet and numbered lines. An empty list item returns to plain text; prose, links and pictures still start prose. Returns false only when adding a line would exceed the line cap.

pub fn backspace(&mut self)

pub fn delete(&mut self)

pub fn remove_block(&mut self)

Drops the block under the cursor, keeping at least one line.

pub fn toggle(&mut self)

pub fn up(&mut self)

pub fn down(&mut self)

pub fn left(&mut self)

pub fn right(&mut self)

pub fn home(&mut self)

pub fn end(&mut self)

pub fn word_left(&mut self)

pub fn word_right(&mut self)

pub fn select_word(&mut self)

pub fn select_left(&mut self)

pub fn select_right(&mut self)

pub fn select_word_left(&mut self)

Shift+Option+← — extend selection by a word, crossing lines and pictures.

pub fn select_word_right(&mut self)

Shift+Option+→ — extend selection by a word, crossing lines and pictures.

pub fn select_home(&mut self)

pub fn select_end(&mut self)

pub fn delete_to_start(&mut self)

pub fn delete_to_end(&mut self)

pub fn delete_word_left(&mut self)

pub fn menu_next(&mut self)

pub fn menu_prev(&mut self)

pub fn close_menu(&mut self)

pub fn menu_selected(&self) -> Option<Command>

The command under the cursor in the open menu, if any.

pub fn text_for_copy(&self) -> String

Plain-text export of every non-image block, for /copy.

pub fn lines_for_copy_all(&self) -> Vec<CopyLine>

Full description in order for /copyall — text lines and pictures.

pub fn image_for_copy(&self) -> Option<PathBuf>

Picture nearest the cursor: search upward first, then downward.

pub fn apply(&mut self, command: Command) -> Option<CommandRequest>

Removes the typed /command and applies it. Returns work that needs access to the platform clipboard.

pub fn insert_block(&mut self, block: Block) -> bool

Puts a block in at the cursor, replacing the line when it is an empty one and pushing it down otherwise.

pub fn layout( &mut self, width: usize, height: u16, ) -> (Vec<Placed>, Option<(u16, u16)>)

Lays the blocks out in a width x height box and scrolls so the cursor stays in view. Returns the visible blocks and where the text cursor sits, if it is on an editable line.

pub fn scroll(&self) -> usize

Description scroll offset after the last Self::layout call.

pub fn content_height(&self) -> usize

Total laid-out rows after the last Self::layout call (scrollbar).

pub fn click(&mut self, row: u16, col: usize) -> bool

Moves the cursor to a clicked cell of the description box. Returns true when the click landed on a real block (not empty padding below the content).

Trait Implementations

impl Clone for DescriptionEditor

fn clone(&self) -> DescriptionEditor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescriptionEditor

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

Formats the value using the given formatter.

impl Eq for DescriptionEditor

impl PartialEq for DescriptionEditor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DescriptionEditor