Struct CodeEditor

pub struct CodeEditor { /* private fields */ }

CodeEditor struct which stores settings for highlighting.

Implementations

impl CodeEditor

pub fn id_source(self, id_source: impl Into<String>) -> Self

pub fn with_rows(self, rows: usize) -> Self

Minimum number of rows to show.

Default: 10

pub fn with_theme(self, theme: ColorTheme) -> Self

Use custom Color Theme

Default: Gruvbox

pub fn with_fontsize(self, fontsize: f32) -> Self

Use custom font size

Default: 10.0

pub fn with_ui_fontsize(self, ui: &mut Ui) -> Self

Use UI font size

pub fn with_numlines(self, numlines: bool) -> Self

Show or hide lines numbering

Default: true

pub fn with_numlines_shift(self, numlines_shift: isize) -> Self

Shift lines numbering by this value

Default: 0

pub fn with_numlines_only_natural(self, numlines_only_natural: bool) -> Self

Show lines numbering only above zero, useful for enabling numbering since nth row

Default: false

pub fn with_syntax(self, syntax: Syntax) -> Self

Use custom syntax for highlighting

Default: Rust

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

Turn on/off scrolling on the vertical axis.

Default: true

pub fn auto_shrink(self, shrink: bool) -> Self

Should the containing area shrink if the content is small?

Default: false

pub fn desired_width(self, width: f32) -> Self

Sets the desired width of the code editor

Default: f32::INFINITY

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

Stick to bottom The scroll handle will stick to the bottom position even while the content size changes dynamically. This can be useful to simulate terminal UIs or log/info scrollers. The scroll handle remains stuck until user manually changes position. Once “unstuck” it will remain focused on whatever content viewport the user left it on. If the scroll handle is dragged to the bottom it will again become stuck and remain there until manually pulled from the end position.

Default: false

pub fn format(&self, ty: TokenType) -> TextFormat

pub fn show(&mut self, ui: &mut Ui, text: &mut dyn TextBuffer) -> TextEditOutput

Show Code Editor

Trait Implementations

impl Clone for CodeEditor

fn clone(&self) -> CodeEditor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodeEditor

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

Formats the value using the given formatter.

impl Default for CodeEditor

fn default() -> CodeEditor

Returns the “default value” for a type.

impl Editor for CodeEditor

fn append(&self, job: &mut LayoutJob, token: &Token)

fn syntax(&self) -> &Syntax

impl Hash for CodeEditor

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CodeEditor

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CodeEditor