Skip to main content

CodeView

Struct CodeView 

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

Code in a monospace editor: line numbers in a gutter, syntax highlighting (Rust, Python, JSON), the current line highlighted, selection and copy (read-only too). Errors (CodeView::errors, 1-based line numbers as compilers report them) get a red mark in the gutter and a red underline on their line, their message on hover, and are listed under the code: each entry moves the cursor to its line.

Wraps gpui-kit’s EditorState (its tree-sitter grammars), so the look follows the theme (theme::apply sets the code colours). An editable view emits CodeChanged.

ⓘ
let code = cx.new(|cx| CodeView::new(CodeLanguage::Rust, source, window, cx).errors(vec![(6, "mismatched types".into())]).editable(true));
cx.subscribe(&code, |this, _, CodeChanged(text), cx| { /* … */ }).detach();

Implementations§

Source§

impl CodeView

Source

pub fn new( language: CodeLanguage, text: impl Into<SharedString>, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

A read-only view of text highlighted as language.

Source

pub fn errors(self, errors: Vec<(usize, String)>) -> Self

Marks these errors: (line, message), lines 1-based.

Source

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

Editable (true) or read-only (the default).

Source

pub fn max_lines(self, lines: usize) -> Self

As tall as its text up to lines lines, then it scrolls (by default it fills the height its parent gives it).

Source

pub fn set_errors( &mut self, errors: Vec<(usize, String)>, cx: &mut Context<'_, Self>, )

Marks these errors instead of the ones shown: (line, message), lines 1-based.

Source

pub fn error_list(&self) -> &[(usize, String)]

The errors shown.

Source

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

Makes the view editable or read-only.

Source

pub fn is_editable(&self) -> bool

Whether the user can edit the text.

Source

pub fn set_text( &mut self, text: impl Into<SharedString>, window: &mut Window, cx: &mut Context<'_, Self>, )

Replaces the text (no CodeChanged); the errors shown are kept on their line numbers.

Source

pub fn text(&self, cx: &App) -> String

The text.

Source

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

Highlights the text as language.

Source

pub fn language(&self) -> CodeLanguage

The language highlighted.

Source

pub fn editor(&self) -> &Entity<EditorState>

The editor underneath (for its focus handle, cursor, search).

Source

pub fn go_to_line( &mut self, line: usize, window: &mut Window, cx: &mut Context<'_, Self>, )

Moves the cursor to the start of line (1-based) and focuses the code.

Trait Implementations§

Source§

impl EventEmitter<CodeChanged> for CodeView

Source§

impl Render for CodeView

Source§

fn render( &mut self, _: &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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> ErasedDestructor for T
where T: 'static,

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<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

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