Struct EditorPane

Source
pub struct EditorPane<A = ()> { /* private fields */ }
Expand description

Framed editor view with tab and active-document chrome.

The pane has a 640×420 logical-pixel intrinsic size, then obeys the standard layout builders and incoming constraints. Its tabs and metadata header take their configured heights; a smaller constrained height gives the content a zero-height remainder. A is the application action type dispatched by callback adapters.

§Examples

use ailloli_ui_widgets::editor::{EditorPane, EditorPaneTab};
use ailloli_ui_widgets::text::Text;
let pane = EditorPane::<()>::new(Text::new("Preview"))
    .tabs([EditorPaneTab::text("preview", "Preview")])
    .active_tab("preview");
let _ = pane;

Implementations§

Source§

impl<A: 'static> EditorPane<A>

Source

pub fn width(self, value: impl Into<Length>) -> Self

Sets preferred width from a logical-pixel or length value.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().width(120.0);
let _ = widget;
Source

pub fn height(self, value: impl Into<Length>) -> Self

Sets preferred height from a logical-pixel or length value.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().height(40.0);
let _ = widget;
Source

pub fn min_width(self, value: impl Into<Length>) -> Self

Sets the minimum width bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().min_width(40.0);
let _ = widget;
Source

pub fn max_width(self, value: impl Into<Length>) -> Self

Sets the maximum width bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().max_width(320.0);
let _ = widget;
Source

pub fn min_height(self, value: impl Into<Length>) -> Self

Sets the minimum height bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().min_height(24.0);
let _ = widget;
Source

pub fn max_height(self, value: impl Into<Length>) -> Self

Sets the maximum height bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().max_height(240.0);
let _ = widget;
Source

pub fn fill(self) -> Self

Sets both preferred axes to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill();
let _ = widget;
Source

pub fn fill_width(self) -> Self

Sets preferred width to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill_width();
let _ = widget;
Source

pub fn fill_height(self) -> Self

Sets preferred height to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill_height();
let _ = widget;
Source

pub fn margin(self, value: f32) -> Self

Sets uniform outer margin in logical pixels.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().margin(8.0);
let _ = widget;
Source

pub fn padding(self, value: f32) -> Self

Sets uniform inner padding in logical pixels.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().padding(8.0);
let _ = widget;
Source

pub fn flex_grow(self) -> Self

Sets flex-grow weight to one.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_grow();
let _ = widget;
Source

pub fn flex_grow_by(self, value: f32) -> Self

Sets a dimensionless flex-grow weight.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_grow_by(2.0);
let _ = widget;
Source

pub fn flex_shrink(self, value: f32) -> Self

Sets a dimensionless flex-shrink weight.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_shrink(1.0);
let _ = widget;
Source

pub fn flex_basis(self, value: impl Into<Length>) -> Self

Sets the preferred main-axis flex basis.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_basis(80.0);
let _ = widget;
Source

pub fn align_self(self, value: AlignItems) -> Self

Overrides cross-axis alignment for this flex item.

§Examples
use ailloli_ui_core::style::AlignItems;
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().align_self(AlignItems::Center);
let _ = widget;
Source§

impl<A: 'static> EditorPane<A>

Source

pub fn new(child: impl IntoView<A>) -> Self

Wraps any view as pane content with empty tabs and default chrome.

§Examples
use ailloli_ui_widgets::editor::EditorPane;
use ailloli_ui_widgets::text::Text;
let pane = EditorPane::<()>::new(Text::new("content"));
let _ = pane;
Source

pub fn text(buffer: impl Into<Signal<TextBuffer>>) -> Self

Creates a pane whose content is a fill-sized plain-text Editor.

Edits mutate the shared buffer signal. No tab is synthesized from the buffer; configure tabs/title/path explicitly when chrome text is wanted.

§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_text::TextBuffer;
use ailloli_ui_widgets::editor::EditorPane;
let pane: EditorPane<()> = EditorPane::text(State::new(TextBuffer::from_string("notes")));
let _ = pane;
Source

pub fn code(document: impl Into<Signal<Document>>) -> Self

Creates a pane whose content is a fill-sized CodeEditor.

Document source metadata and dirty state become fallbacks for the pane header. No visible tab is synthesized automatically.

§Examples
use ailloli_ui_editor::{Document, DocumentId};
use ailloli_ui_runtime::component::State;
use ailloli_ui_text::TextBuffer;
use ailloli_ui_widgets::editor::EditorPane;
let document = Document::new(DocumentId(1), TextBuffer::new()).with_path("src/lib.rs");
let pane: EditorPane<()> = EditorPane::code(State::new(document));
let _ = pane;
Source

pub fn tabs(self, tabs: impl IntoIterator<Item = EditorPaneTab>) -> Self

Replaces static tabs and removes any previously bound tab signal.

Iteration order is paint and hit-test order. An empty list suppresses tabs; no implicit tab is derived from editor content.

§Examples
use ailloli_ui_widgets::editor::{EditorPane, EditorPaneTab};
use ailloli_ui_widgets::text::Text;
let pane = EditorPane::<()>::new(Text::new("body"))
    .tabs([EditorPaneTab::text("one", "One"), EditorPaneTab::text("two", "Two")]);
let _ = pane;
Source

pub fn bind_tabs(self, tabs: impl Into<Signal<Vec<EditorPaneTab>>>) -> Self

Binds the visible tabs to live shared state.

Bound tabs take precedence over stored static tabs. Later calling Self::tabs returns to static input by clearing this binding.

§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_widgets::editor::{EditorPane, EditorPaneTab};
use ailloli_ui_widgets::text::Text;
let tabs = State::new(vec![EditorPaneTab::code("lib", "lib.rs")]);
let pane = EditorPane::<()>::new(Text::new("body")).bind_tabs(tabs);
let _ = pane;
Source

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

Sets a static or generic binding for the active tab identifier.

Empty or unknown identifiers fall back to the first tab. This method removes the special writable signal installed by Self::bind_active_tab, so user clicks no longer update active state automatically.

§Examples
use ailloli_ui_widgets::editor::EditorPane;
use ailloli_ui_widgets::text::Text;
let pane = EditorPane::<()>::new(Text::new("body")).active_tab("main");
let _ = pane;
Source

pub fn bind_active_tab(self, active_tab: impl Into<Signal<String>>) -> Self

Binds active-tab selection to writable shared state.

A left click on a tab writes its identifier before invoking selection and aggregate callbacks. Empty or unknown values display the first tab.

§Examples
use ailloli_ui_runtime::component::State;
use ailloli_ui_widgets::editor::EditorPane;
use ailloli_ui_widgets::text::Text;
let active = State::new(String::from("main"));
let pane = EditorPane::<()>::new(Text::new("body")).bind_active_tab(active);
let _ = pane;
Source

pub fn active_title(self, title: impl Into<Binding<String>>) -> Self

Overrides the selected tab or document title.

An empty value is treated as no override. Resolution order is explicit non-empty title, selected-tab title, document filename, then empty.

§Examples
use ailloli_ui_widgets::editor::EditorPane;
use ailloli_ui_widgets::text::Text;
let pane = EditorPane::<()>::new(Text::new("body")).active_title("Untitled");
let _ = pane;
Source

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

Overrides the selected tab or document path in the header.

An empty value is treated as absent. Resolution order is explicit path, selected-tab path, then document source path/URI.

§Examples
use ailloli_ui_widgets::editor::EditorPane;
use ailloli_ui_widgets::text::Text;
let pane = EditorPane::<()>::new(Text::new("body")).active_path("src/main.rs");
let _ = pane;
Source

pub fn dirty(self, dirty: impl Into<Binding<bool>>) -> Self

Overrides active dirty state, including an explicit false.

Without an override, the selected tab and active document are combined with logical OR. The value controls the header dot and selected tab’s unread/dirty decoration only.

§Examples
use ailloli_ui_widgets::editor::EditorPane;
use ailloli_ui_widgets::text::Text;
let pane = EditorPane::<()>::new(Text::new("body")).dirty(true);
let _ = pane;
Source

pub fn pane_style(self, style: EditorPaneStyle) -> Self

Replaces all pane and tab chrome styling.

§Examples
use ailloli_ui_widgets::editor::{EditorPane, EditorPaneStyle};
use ailloli_ui_widgets::text::Text;
let pane = EditorPane::<()>::new(Text::new("body")).pane_style(EditorPaneStyle::default());
let _ = pane;
Source

pub fn pane_size(self, size: EditorPaneSize) -> Self

Applies a size preset using the default theme.

This replaces the entire existing EditorPaneStyle, so call it before Self::pane_style when combining a size preset with custom colors.

§Examples
use ailloli_ui_widgets::editor::{EditorPane, EditorPaneSize};
use ailloli_ui_widgets::text::Text;
let pane = EditorPane::<()>::new(Text::new("body")).pane_size(EditorPaneSize::Compact);
let _ = pane;
Source

pub fn on_select_tab(self, f: impl Fn(String) -> A + 'static) -> Self

Maps a selected tab identifier into an application action.

The callback runs after a bound active-tab signal is updated and before the optional aggregate action callback.

§Examples
use ailloli_ui_widgets::editor::EditorPane;
use ailloli_ui_widgets::text::Text;
enum Action { Select(String) }
let pane = EditorPane::<Action>::new(Text::new("body")).on_select_tab(Action::Select);
let _ = pane;
Source

pub fn on_select_tab_ctx( self, f: impl Fn(&mut EventCtx<A>, String) + 'static, ) -> Self

Handles selection with direct access to the event context.

Use this form to dispatch zero or multiple actions or request additional runtime work. Callback order matches Self::on_select_tab.

§Examples
use ailloli_ui_widgets::editor::EditorPane;
use ailloli_ui_widgets::text::Text;
let pane = EditorPane::<()>::new(Text::new("body"))
    .on_select_tab_ctx(|_ctx, _id| {});
let _ = pane;
Source

pub fn on_close_tab(self, f: impl Fn(String) -> A + 'static) -> Self

Maps a close request identifier into an application action.

Clicking a tab’s trailing 22-logical-pixel close region takes priority over selection, invokes this callback, then invokes the aggregate action callback. The pane does not remove the tab itself.

§Examples
use ailloli_ui_widgets::editor::EditorPane;
use ailloli_ui_widgets::text::Text;
enum Action { Close(String) }
let pane = EditorPane::<Action>::new(Text::new("body")).on_close_tab(Action::Close);
let _ = pane;
Source

pub fn on_close_tab_ctx( self, f: impl Fn(&mut EventCtx<A>, String) + 'static, ) -> Self

Handles a close request with direct access to the event context.

§Examples
use ailloli_ui_widgets::editor::EditorPane;
use ailloli_ui_widgets::text::Text;
let pane = EditorPane::<()>::new(Text::new("body"))
    .on_close_tab_ctx(|_ctx, _id| {});
let _ = pane;
Source

pub fn on_action(self, f: impl Fn(EditorPaneAction) -> A + 'static) -> Self

Maps every select/close event into one application action.

A specialized selection or close callback, when installed, runs first; both callbacks may therefore dispatch actions for one pointer event.

§Examples
use ailloli_ui_widgets::editor::{EditorPane, EditorPaneAction};
use ailloli_ui_widgets::text::Text;
let pane = EditorPane::<EditorPaneAction>::new(Text::new("body")).on_action(|action| action);
let _ = pane;
Source

pub fn on_action_ctx( self, f: impl Fn(&mut EventCtx<A>, EditorPaneAction) + 'static, ) -> Self

Handles every select/close event with direct event-context access.

§Examples
use ailloli_ui_widgets::editor::EditorPane;
use ailloli_ui_widgets::text::Text;
let pane = EditorPane::<()>::new(Text::new("body"))
    .on_action_ctx(|_ctx, _action| {});
let _ = pane;

Trait Implementations§

Source§

impl<A: 'static> IntoView<A> for EditorPane<A>

Converts the pane builder into a clipped frame, chrome, and content tree.

Source§

fn into_view(self) -> View<A>

Consumes a builder/value and returns its declarative view tree. Read more
Source§

impl<A: 'static> LayoutExt for EditorPane<A>

Source§

fn layout_mut(&mut self) -> &mut LayoutStyle

Returns the widget’s mutable declarative size/inset state. Read more

Auto Trait Implementations§

§

impl<A> Freeze for EditorPane<A>

§

impl<A = ()> !RefUnwindSafe for EditorPane<A>

§

impl<A = ()> !Send for EditorPane<A>

§

impl<A = ()> !Sync for EditorPane<A>

§

impl<A> Unpin for EditorPane<A>

§

impl<A = ()> !UnwindSafe for EditorPane<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, A> FlexItemExt<A> for T
where T: IntoView<A>,

Source§

fn flex_grow(self) -> View<A>

Sets flex-grow weight to one. Read more
Source§

fn flex_grow_by(self, value: f32) -> View<A>

Sets the dimensionless flex-grow weight. Read more
Source§

fn flex_shrink(self, value: f32) -> View<A>

Sets the dimensionless flex-shrink weight. Read more
Source§

fn flex_basis(self, value: impl Into<Length>) -> View<A>

Sets the preferred main-axis flex basis. Read more
Source§

fn align_self(self, value: AlignItems) -> View<A>

Overrides the parent cross-axis alignment for this view. Read more
Source§

fn fill_width(self) -> View<A>

Marks width as parent-fill in the view size hint. Read more
Source§

fn fill_height(self) -> View<A>

Marks height as parent-fill in the view size hint. Read more
Source§

fn fill(self) -> View<A>

Marks both axes as parent-fill in the view size hint. 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<T, A> IntoViewKeyExt<A> for T
where T: IntoView<A>,

§

fn key(self, key: impl Into<String>) -> View<A>

Converts self, assigns the owned key, and returns the view. Read more
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 = 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,