Skip to main content

CodeEditor

Struct CodeEditor 

Source
pub struct CodeEditor { /* private fields */ }
Expand description

A code editor. Create it once and keep the entity in your view:

ⓘ
let editor = cx.new(|cx| CodeEditor::new(cx).path("src/main.rs").with_text(&source));
cx.subscribe(&editor, |this, editor, event, cx| {
    if *event == CodeEditorEvent::Save {
        std::fs::write(path, editor.read(cx).text()).ok();
        editor.update(cx, |e, cx| e.mark_saved(cx));
    }
});

It fills its parent (give it a height) and draws no background, like super::TextArea.

Not included yet: code folding, multiple cursors, soft wrap, find and replace, and tab stops for hard tabs (a '\t' is drawn one column wide).

Implementations§

Source§

impl CodeEditor

Source

pub fn new(cx: &mut Context<'_, Self>) -> Self

Source

pub fn with_text(self, text: &str) -> Self

Initial text (marked as saved).

Source

pub fn path(self, path: impl Into<SharedString>) -> Self

File path, reported by CodeEditor::selection_context.

Source

pub fn font_size(self, size: Pixels) -> Self

Text size (13 px by default); lines are 1.5 times as tall.

Source

pub fn line_numbers(self, show: bool) -> Self

Shows the line number gutter (on by default).

Source

pub fn read_only(self, read_only: bool) -> Self

Allows selecting and copying but not editing.

Source

pub fn tab_size(self, size: usize) -> Self

Spaces per indentation level (4 by default).

Source

pub fn hard_tabs(self, hard: bool) -> Self

Indents with tab characters instead of spaces.

Source

pub fn auto_pair(self, on: bool) -> Self

Inserts and skips over closing brackets and quotes (on by default).

Source

pub fn highlighter(self, highlighter: impl LineHighlighter) -> Self

Source

pub fn text(&self) -> String

The text, with the line endings it was loaded with.

Source

pub fn buffer(&self) -> &CodeBuffer

Source

pub fn set_text(&mut self, text: &str, cx: &mut Context<'_, Self>)

Replaces the whole text (loading a file): clears the history and marks it saved.

Source

pub fn set_path( &mut self, path: Option<SharedString>, cx: &mut Context<'_, Self>, )

Source

pub fn file_path(&self) -> Option<&SharedString>

Source

pub fn set_highlighter( &mut self, highlighter: Option<Box<dyn LineHighlighter>>, cx: &mut Context<'_, Self>, )

Swaps the highlighter (or removes it with None).

Source

pub fn refresh_highlights(&mut self, cx: &mut Context<'_, Self>)

Forgets the cached colors, e.g. after the theme changed (the highlighter is asked again).

Source

pub fn set_read_only(&mut self, read_only: bool, cx: &mut Context<'_, Self>)

Source

pub fn is_dirty(&self) -> bool

Whether the text changed since it was loaded or last saved.

Source

pub fn mark_saved(&mut self, cx: &mut Context<'_, Self>)

Source

pub fn selection_context(&self) -> CodeSelection

The selection (or the caret’s line) with the file path, to send as context.

Source

pub fn selection(&self) -> BufferSelection

Source

pub fn go_to(&mut self, line: usize, col: usize, cx: &mut Context<'_, Self>)

Moves the caret to a zero-based line and byte column and scrolls to it.

Source

pub fn select(&mut self, selection: BufferSelection, cx: &mut Context<'_, Self>)

Selects a range and scrolls to it.

Source

pub fn focus(&self, window: &mut Window)

Source

pub fn is_focused(&self, window: &Window) -> bool

Source

pub fn undo(&mut self, cx: &mut Context<'_, Self>)

Source

pub fn redo(&mut self, cx: &mut Context<'_, Self>)

Trait Implementations§

Source§

impl EntityInputHandler for CodeEditor

Source§

fn text_for_range( &mut self, range_utf16: Range<usize>, actual_range: &mut Option<Range<usize>>, _: &mut Window, _: &mut Context<'_, Self>, ) -> Option<String>

Source§

fn selected_text_range( &mut self, _: bool, _: &mut Window, _: &mut Context<'_, Self>, ) -> Option<UTF16Selection>

Source§

fn marked_text_range( &self, _: &mut Window, _: &mut Context<'_, Self>, ) -> Option<Range<usize>>

Source§

fn unmark_text(&mut self, _: &mut Window, _: &mut Context<'_, Self>)

Source§

fn replace_text_in_range( &mut self, range_utf16: Option<Range<usize>>, text: &str, _: &mut Window, cx: &mut Context<'_, Self>, )

Source§

fn replace_and_mark_text_in_range( &mut self, range_utf16: Option<Range<usize>>, text: &str, new_selected_range_utf16: Option<Range<usize>>, _: &mut Window, cx: &mut Context<'_, Self>, )

Source§

fn bounds_for_range( &mut self, range_utf16: Range<usize>, bounds: Bounds<Pixels>, _: &mut Window, _: &mut Context<'_, Self>, ) -> Option<Bounds<Pixels>>

Source§

fn character_index_for_point( &mut self, point: Point<Pixels>, _: &mut Window, _: &mut Context<'_, Self>, ) -> Option<usize>

Source§

impl EventEmitter<CodeEditorEvent> for CodeEditor

Source§

impl Focusable for CodeEditor

Source§

fn focus_handle(&self, _: &App) -> FocusHandle

Returns the focus handle associated with this view.
Source§

impl Render for CodeEditor

Source§

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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