Skip to main content

MarkdownEvent

Enum MarkdownEvent 

Source
pub enum MarkdownEvent {
    None,
    FocusedLine {
        line: usize,
    },
    HeadingToggled {
        level: u8,
        text: String,
        collapsed: bool,
    },
    DoubleClick {
        line_number: usize,
        line_kind: String,
        content: String,
    },
    Copied {
        text: String,
    },
    SelectionStarted,
    SelectionEnded,
    Scrolled {
        offset: usize,
        direction: i32,
    },
    TocHoverChanged {
        hovered: bool,
    },
    FilterModeChanged {
        active: bool,
        filter: String,
    },
    FilterModeExited {
        line: usize,
    },
}
Expand description

Events emitted by the markdown widget. Events that can be emitted by the markdown widget.

The widget handles all internal state management and returns these events so the parent application can react appropriately (e.g., show toast messages).

Variants§

§

None

No event occurred.

§

FocusedLine

The focused line changed (via click or keyboard navigation).

Fields

§line: usize

The new focused line number (1-indexed).

§

HeadingToggled

A heading was toggled (collapsed/expanded).

Fields

§level: u8

The heading level (1-6).

§text: String

The heading text.

§collapsed: bool

Whether the heading is now collapsed.

§

DoubleClick

A double-click occurred on a line.

Fields

§line_number: usize

Source line number (1-indexed).

§line_kind: String

Type of line clicked (e.g., “Heading”, “Paragraph”).

§content: String

Text content of the line.

§

Copied

Text was copied to clipboard.

Fields

§text: String

The text that was copied.

§

SelectionStarted

Selection mode was entered (drag started).

§

SelectionEnded

Selection mode was exited.

§

Scrolled

Content was scrolled.

Fields

§offset: usize

The new scroll offset.

§direction: i32

Direction of scroll (positive = down, negative = up).

§

TocHoverChanged

TOC hover state changed and should be redrawn.

Fields

§hovered: bool

Whether the TOC is currently hovered.

§

FilterModeChanged

Filter mode changed (entered, text changed, or exited with Esc).

Fields

§active: bool

Whether filter mode is active.

§filter: String

Current filter text.

§

FilterModeExited

Filter mode exited via Enter (focuses the selected line).

Fields

§line: usize

The line that was focused when filter mode was exited.

Trait Implementations§

Source§

impl Clone for MarkdownEvent

Source§

fn clone(&self) -> MarkdownEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MarkdownEvent

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more