Skip to main content

Pane

Struct Pane 

Source
pub struct Pane { /* private fields */ }
Available on crate feature master-layout only.
Expand description

A pane within a tab

Implementations§

Source§

impl Pane

Source

pub fn new(id: PaneId, content: Box<dyn PaneContent>) -> Self

Create a new pane with given ID and content

Source

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

Set the icon for the title

Source

pub fn with_padding(self, top: u16, right: u16, bottom: u16, left: u16) -> Self

Set the padding (top, right, bottom, left)

Source

pub fn with_uniform_padding(self, padding: u16) -> Self

Set uniform padding on all sides

Set a text footer (displayed in the border)

Source

pub fn with_border_type(self, border_type: BorderType) -> Self

Set the border type

Source

pub fn id(&self) -> PaneId

Get the pane’s ID

Source

pub fn area(&self) -> Rect

Get the pane’s current area

Source

pub fn set_area(&mut self, area: Rect)

Set the pane’s area (called during layout)

Source

pub fn title(&self) -> String

Get the pane’s title

Source

pub fn is_focusable(&self) -> bool

Check if pane is focusable

Source

pub fn handle_key(&mut self, key: KeyEvent) -> bool

Handle keyboard input

Source

pub fn handle_mouse(&mut self, mouse: MouseEvent) -> bool

Handle mouse input (coordinates already translated to pane-local)

Source

pub fn start_selection(&mut self, x: u16, y: u16)

Start text selection at the given coordinates

Source

pub fn update_selection(&mut self, x: u16, y: u16)

Update text selection to the given coordinates

Source

pub fn end_selection(&mut self)

End text selection

Source

pub fn get_selected_text(&self) -> Option<String>

Get the currently selected text

Source

pub fn clear_selection(&mut self)

Clear the current selection

Source

pub fn has_selection(&self) -> bool

Check if there is an active selection

Source

pub fn set_focused(&mut self, focused: bool)

Notify pane content about focus state change

Source

pub fn translate_mouse(&self, mouse: MouseEvent) -> MouseEvent

Translate global mouse coordinates to pane-local coordinates

Source

pub fn contains_point(&self, x: u16, y: u16) -> bool

Check if point is within pane bounds

Source

pub fn render( &mut self, frame: &mut Frame<'_>, is_selected: bool, is_focused: bool, )

Render the pane with border

Source§

impl Pane

Source

pub fn render_content( &mut self, area: Rect, buf: &mut Buffer, is_selected: bool, is_focused: bool, )

Get a reference to render the content widget This is used during the render phase

Auto Trait Implementations§

§

impl Freeze for Pane

§

impl !RefUnwindSafe for Pane

§

impl !Send for Pane

§

impl !Sync for Pane

§

impl Unpin for Pane

§

impl !UnwindSafe for Pane

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> 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> 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> 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.
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