Struct EditorPaneTab

Source
pub struct EditorPaneTab {
    pub id: String,
    pub title: String,
    pub path: Option<String>,
    pub dirty: bool,
    pub kind: EditorPaneTabKind,
    pub icon: Option<IconId>,
    pub icon_tint: Option<Color>,
}
Expand description

Metadata rendered for one editor-pane tab.

Empty identifiers are accepted but should be avoided because identifiers drive selection and callbacks. None for path, icon, or icon_tint means that the corresponding decoration or override is absent.

§Examples

use ailloli_ui_widgets::editor::{EditorPaneTab, EditorPaneTabKind};
let tab = EditorPaneTab::code("main", "main.rs").path("src/main.rs");
assert_eq!(tab.id, "main");
assert_eq!(tab.kind, EditorPaneTabKind::Code);
assert_eq!(tab.path.as_deref(), Some("src/main.rs"));

Fields§

§id: String

Stable identifier emitted by selection and close actions.

§title: String

Visible tab label and fallback active title.

§path: Option<String>

Optional display path or URI used by the header/breadcrumb.

§dirty: bool

Whether to render the unsaved-change indicator.

§kind: EditorPaneTabKind

Semantic tab category used for the scope strip.

§icon: Option<IconId>

Optional leading icon.

§icon_tint: Option<Color>

Optional icon tint; None uses the pane’s muted-path color.

Implementations§

Source§

impl EditorPaneTab

Source

pub fn new(id: impl Into<String>, title: impl Into<String>) -> Self

Creates an undecorated, clean tab of EditorPaneTabKind::Other.

§Examples
use ailloli_ui_widgets::editor::{EditorPaneTab, EditorPaneTabKind};
let tab = EditorPaneTab::new("notes", "Notes");
assert_eq!(tab.kind, EditorPaneTabKind::Other);
assert!(!tab.dirty && tab.path.is_none() && tab.icon.is_none());
Source

pub fn text(id: impl Into<String>, title: impl Into<String>) -> Self

Creates a tab categorized as plain text.

§Examples
use ailloli_ui_widgets::editor::{EditorPaneTab, EditorPaneTabKind};
assert_eq!(EditorPaneTab::text("readme", "README").kind, EditorPaneTabKind::Text);
Source

pub fn code(id: impl Into<String>, title: impl Into<String>) -> Self

Creates a tab categorized as source code.

§Examples
use ailloli_ui_widgets::editor::{EditorPaneTab, EditorPaneTabKind};
assert_eq!(EditorPaneTab::code("lib", "lib.rs").kind, EditorPaneTabKind::Code);
Source

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

Sets the display path or URI used by the active header.

Empty strings behave as absent while resolving the header. With the files feature, URI strings, slash paths, backslash paths, and parent > child labels are normalized for breadcrumb rendering.

§Examples
use ailloli_ui_widgets::editor::EditorPaneTab;
let tab = EditorPaneTab::code("lib", "lib.rs").path("src/lib.rs");
assert_eq!(tab.path.as_deref(), Some("src/lib.rs"));
Source

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

Marks whether the tab has unsaved changes.

§Examples
use ailloli_ui_widgets::editor::EditorPaneTab;
assert!(EditorPaneTab::text("draft", "Draft").dirty(true).dirty);
Source

pub fn kind(self, kind: EditorPaneTabKind) -> Self

Replaces the semantic category used by the tab scope strip.

§Examples
use ailloli_ui_widgets::editor::{EditorPaneTab, EditorPaneTabKind};
let tab = EditorPaneTab::new("log", "Log").kind(EditorPaneTabKind::Text);
assert_eq!(tab.kind, EditorPaneTabKind::Text);
Source

pub fn icon(self, icon: IconId) -> Self

Sets a leading tab icon.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::editor::EditorPaneTab;
let tab = EditorPaneTab::new("new", "New").icon(IconId::Plus);
assert_eq!(tab.icon, Some(IconId::Plus));
Source

pub fn icon_tint(self, color: Color) -> Self

Sets the leading icon tint.

The tint is retained even when no icon is configured and becomes visible if an icon is added later.

§Examples
use ailloli_ui_core::Color;
use ailloli_ui_widgets::editor::EditorPaneTab;
let color = Color::rgba(255, 0, 0, 1.0);
assert_eq!(EditorPaneTab::new("a", "A").icon_tint(color).icon_tint, Some(color));

Trait Implementations§

Source§

impl Clone for EditorPaneTab

Source§

fn clone(&self) -> EditorPaneTab

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EditorPaneTab

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for EditorPaneTab

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for EditorPaneTab

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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.

§

impl<A> IntoClickAction<A> for A
where A: Clone + 'static,

§

fn into_click_action(self) -> ClickAction<A>

Implements the into_click_action helper used by this module.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

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

§

impl<T> Props for T
where T: Clone + 'static,