Struct PopupCore

pub struct PopupCore<'a> {
    pub style: Style,
    pub constraint: Cell<PopupConstraint>,
    pub offset: (i16, i16),
    pub boundary_area: Option<Rect>,
    pub block: Option<Block<'a>>,
    pub h_scroll: Option<Scroll<'a>>,
    pub v_scroll: Option<Scroll<'a>>,
    pub non_exhaustive: NonExhaustive,
}

Provides the core for popup widgets.

This does widget can calculate the placement of a popup widget using the placement, offset and the outer boundary.

It provides the widget area as widget_area. It’s up to the user to render the actual content for the popup.

Event handling

The widget will detect any suspicious mouse activity outside its bounds and returns PopupOutcome::Hide if it finds such.

The widget doesn’t change its active/visible state by itself, it’s up to the caller to do this.

See See the examples some variants.

Fields

style: Style

constraint: Cell<PopupConstraint>

offset: (i16, i16)

boundary_area: Option<Rect>

block: Option<Block<'a>>

h_scroll: Option<Scroll<'a>>

v_scroll: Option<Scroll<'a>>

non_exhaustive: NonExhaustive

Implementations

impl<'a> PopupCore<'a>

pub fn new() -> PopupCore<'a>

New.

pub fn ref_constraint(&self, constraint: PopupConstraint) -> &PopupCore<'a>

Placement of the popup widget. See placement for the options.

pub fn constraint(self, constraint: PopupConstraint) -> PopupCore<'a>

Placement of the popup widget. See placement for the options.

pub fn offset(self, offset: (i16, i16)) -> PopupCore<'a>

Adds an extra offset to the widget area.

This can be used to

• place the widget under the mouse cursor.
• align the widget not by the outer bounds but by the text content.

pub fn x_offset(self, offset: i16) -> PopupCore<'a>

Sets only the x offset. See offset

pub fn y_offset(self, offset: i16) -> PopupCore<'a>

Sets only the y offset. See offset

pub fn boundary(self, boundary: Rect) -> PopupCore<'a>

Sets outer boundaries for the resulting widget.

This will be used to ensure that the widget is fully visible, after calculation its position using the other parameters.

If not set it will use Buffer::area for this.

pub fn styles(self, styles: PopupStyle) -> PopupCore<'a>

Set styles

pub fn style(self, style: Style) -> PopupCore<'a>

Base style for the popup.

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

Block

pub fn block_opt(self, block: Option<Block<'a>>) -> PopupCore<'a>

Block

pub fn h_scroll(self, h_scroll: Scroll<'a>) -> PopupCore<'a>

Horizontal scroll

pub fn h_scroll_opt(self, h_scroll: Option<Scroll<'a>>) -> PopupCore<'a>

Horizontal scroll

pub fn v_scroll(self, v_scroll: Scroll<'a>) -> PopupCore<'a>

Vertical scroll

pub fn v_scroll_opt(self, v_scroll: Option<Scroll<'a>>) -> PopupCore<'a>

Vertical scroll

pub fn get_block_size(&self) -> Size

Get the padding the block imposes as Size.

pub fn get_block_padding(&self) -> Padding

Get the padding the block imposes as Padding.

pub fn inner(&self, area: Rect) -> Rect

Calculate the inner area.

pub fn layout(&self, area: Rect, buf: &Buffer) -> Rect

Run the layout to calculate the popup area before rendering.

Trait Implementations

impl<'a> Clone for PopupCore<'a>

fn clone(&self) -> PopupCore<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PopupCore<'a>

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

Formats the value using the given formatter.

impl Default for PopupCore<'_>

fn default() -> PopupCore<'_>

Returns the “default value” for a type.

impl<'a> StatefulWidget for &'a PopupCore<'a>

type State = PopupCoreState

State associated with the stateful widget.

fn render( self, area: Rect, buf: &mut Buffer, state: &mut <&'a PopupCore<'a> as StatefulWidget>::State, )

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.

impl StatefulWidget for PopupCore<'_>

type State = PopupCoreState

State associated with the stateful widget.

fn render( self, area: Rect, buf: &mut Buffer, state: &mut <PopupCore<'_> as StatefulWidget>::State, )

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.