EditorTheme

edtui

Struct EditorTheme 

Source 
pub struct EditorTheme<'a> {
    pub base: Style,
    pub cursor_style: Style,
    pub selection_style: Style,
    pub block: Option<Block<'a>>,
    pub status_line: Option<EditorStatusLine>,
}
Expand description

The theme data of the Editor.

Fields§

§base: Style

The base text style

§cursor_style: Style

The cursor style

§selection_style: Style

The text style in visual mode when a text is selected

§block: Option<Block<'a>>

The surrounding block

§status_line: Option<EditorStatusLine>

An optional [StatusLine] displaying the editor mode

Implementations§

Source§

impl<'a> EditorTheme<'a>

Source

pub fn base(self, base: Style) -> Self

This method allows you to customize the base appearance of the Editor.

Examples found in repository?
examples/app/theme.rs (line 24)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
More examples
Hide additional examples
examples/syntax_highlighting/theme.rs (line 24)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
examples/test_text/theme.rs (line 24)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
Source

pub fn base_style(&self) -> Style

Returns the base style.

Source

pub fn block(self, block: Block<'a>) -> Self

This method allows you to customize the block surrrounding the Editor.

Examples found in repository?
examples/app/theme.rs (lines 17-23)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
More examples
Hide additional examples
examples/syntax_highlighting/theme.rs (lines 17-23)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
examples/test_text/theme.rs (lines 17-23)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
Source

pub fn cursor_style(self, style: Style) -> Self

This method allows you to customize the style of the cursor of the Editor.

Examples found in repository?
examples/app/theme.rs (line 25)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
More examples
Hide additional examples
examples/syntax_highlighting/theme.rs (line 25)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
examples/test_text/theme.rs (line 25)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
Source

pub fn hide_cursor(self) -> Self

Hides the cursors.

Source

pub fn selection_style(self, style: Style) -> Self

This method allows you to customize the style of the selection of the Editor in visual mode.

Examples found in repository?
examples/app/theme.rs (line 26)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
More examples
Hide additional examples
examples/syntax_highlighting/theme.rs (line 26)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
examples/test_text/theme.rs (line 26)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
Source

pub fn status_line(self, status_line: EditorStatusLine) -> Self

This method allows you to customize the style of the [StatusLine] of the Editor. See [StatusLine] on how to modify its appearance. Use hide_status_line to hide the status line.

Examples found in repository?
examples/app/theme.rs (lines 27-32)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
More examples
Hide additional examples
examples/syntax_highlighting/theme.rs (lines 27-32)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
examples/test_text/theme.rs (lines 27-32)
14    pub fn new() -> Self {
15        Self {
16            editor: EditorTheme::default()
17                .block(
18                    Block::default()
19                        .borders(Borders::ALL)
20                        .border_type(BorderType::Thick)
21                        .title("|Editor|")
22                        .title_alignment(Alignment::Center),
23                )
24                .base(Style::default().bg(DARK_NIGHT).fg(WHITE))
25                .cursor_style(Style::default().bg(WHITE).fg(DARK_NIGHT))
26                .selection_style(Style::default().bg(ORANGE).fg(DARK_NIGHT))
27                .status_line(
28                    EditorStatusLine::default()
29                        .style_text(Style::default().fg(DARK_NIGHT).bg(GREEN))
30                        .style_line(Style::default().fg(WHITE).bg(DARK_GRAY))
31                        .align_left(true),
32                ),
33        }
34    }
Source

pub fn hide_status_line(self) -> Self

Hides the status lilne.

Trait Implementations§

Source§

impl Default for EditorTheme<'_>

Source§

fn default() -> Self

Creates a new instance of EditorTheme.

This constructor initializes with default style.

Auto Trait Implementations§

§

impl<'a> Freeze for EditorTheme<'a>

§

impl<'a> RefUnwindSafe for EditorTheme<'a>

§

impl<'a> Send for EditorTheme<'a>

§

impl<'a> Sync for EditorTheme<'a>

§

impl<'a> Unpin for EditorTheme<'a>

§

impl<'a> UnwindSafe for EditorTheme<'a>

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

type Index = Index2

Source§

fn push_into(self, array: &mut Jagged<T>)

Source§

fn insert_into(self, index: <T as JaggedSlice<T>>::Index, array: &mut Jagged<T>)

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.