Struct Editing 

pub struct Editing<'a> {

    pub selection: Option<Selection>,
    pub caret_on: bool,
    pub layouts: Option<&'a BlockLayouts>,
    pub annotations: &'a [(Selection, Annotation)],
    pub placeholder: Option<SharedString>,
    pub caption: Caption,
    pub typography: Option<Typography>,
    pub text_color: Option<Hsla>,
    pub toggle: Option<Toggle>,
    pub image: Option<OnImage>,
    pub image_menu: Option<OnImageMenu>,
    pub image_overlay: Option<ImageOverlay>,
    pub image_overlay_corner: ImageOverlayCorner,
    pub fence: Option<FenceHost>,
    pub sizing: Option<(usize, u32)>,
    pub table_controls: bool,
    pub copy: CopyButton,
    pub base: Option<&'a Path>,
    pub keep: &'a [usize],
    pub scroll: Option<&'a ScrollHandle>,
    pub jump: Option<OnJump>,
}

What an editor paints over a document.

One value rather than six parameters, and the reason it is public: the caret, the selection, the comment washes and the layout sink all arrive together or not at all, and a read-only render sets none of them.

Fields

selection: Option<Selection>

The caret and what it has selected. None paints neither — a document nobody is editing.

caret_on: bool

The blink’s lit half. A caret painted on every frame reads as frozen, and the phase belongs to whoever owns the focus.

layouts: Option<&'a BlockLayouts>

Filled as the document paints, for a caller resolving clicks against it.

Given, only the blocks near the part of the window the document shows are built, and it answers for those alone. The rest are placed at their last measured height, or a guess at one, and held in it across frames.

annotations: &'a [(Selection, Annotation)]

Ranges washed under the text, in the order given.

placeholder: Option<SharedString>

Shown on the caret’s block while it holds nothing.

caption: Caption

typography: Option<Typography>

What to set the document in. None takes the installed Typography — a caller sizing one document apart from the rest passes Typography::scaled.

text_color: Option<Hsla>

toggle: Option<Toggle>

Makes a task block’s checkbox a control, and says who answers the press. None paints a mark.

image: Option<OnImage>

Handles a picture click with its block index, keeping the arrow cursor. A press and release more than a couple of pixels apart is a drag and calls nothing. The press still reaches whatever is under the picture.

image_menu: Option<OnImageMenu>

Handles a right press on a picture with its block index and the press’s window position, and stops the press. None lets it through to whatever is under the picture. crate::PictureMenu is what the menu offers.

image_overlay: Option<ImageOverlay>

An app control inset at image_overlay_corner, visible on hover. Its presses do not reach the picture. None adds no listeners.

image_overlay_corner: ImageOverlayCorner

Corner for the picture control; defaults to bottom-right.

fence: Option<FenceHost>

Lets a painted fence rewrite its own code and give the keyboard back. None paints a fence that can do neither.

sizing: Option<(usize, u32)>

A painted block held at a height while its resize handle is dragged: the block index and the height, in place of the one the document says.

table_controls: bool

Reserves lanes around tables for editor controls.

copy: CopyButton

Whether a fence offers to copy itself.

base: Option<&'a Path>

The directory a relative image path is joined onto. None leaves it relative, which gpui reads against the process’s working directory.

keep: &'a [usize]

Blocks built wherever they are, alongside the ones near the part of the window the document shows — source lines, for render_source. The caret’s and the selection anchor’s are built without being named. Only read with layouts given.

scroll: Option<&'a ScrollHandle>

The scroll container the document sits in. When blocks above the text showing come out taller or shorter than they were placed at, its offset moves by the difference. Only read with layouts given.

jump: Option<OnJump>

Scrolls to the heading a clicked #fragment link names, matched by crate::app::link::heading. None, or a fragment naming no heading, makes the click do nothing.

Trait Implementations

impl<'a> Clone for Editing<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Editing<'_>

fn default() -> Self

Returns the “default value” for a type.