Struct PopupCore 

pub struct PopupCore {
    pub constraint: Cell<PopupConstraint>,
    pub offset: (i16, i16),
    pub boundary_area: Option<Rect>,
    pub non_exhaustive: NonExhaustive,
}

Provides the core for popup widgets.

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

It provides the widget area as area.

After rendering the PopupCore the main widget can render it’s content in the calculated PopupCoreState::area.

Event handling

Will detect any mouse-clicks outside its area and return PopupOutcome::Hide. Actually showing/hiding the popup is the job of the main widget.

See See the examples some variants.

Fields

constraint: Cell<PopupConstraint>

Constraints for the popup.

offset: (i16, i16)

Extra offset after calculating the position with constraint.

boundary_area: Option<Rect>

Outer boundary for the popup-placement. If not set uses the buffer-area.

non_exhaustive: NonExhaustive

Implementations

impl PopupCore

pub fn new() -> PopupCore

New.

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

Placement constraints for the popup widget.

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

Placement constraints for the popup widget.

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

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

Sets only the x offset. See offset

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

Sets only the y offset. See offset

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

Sets outer boundaries for the popup widget.

This will be used to ensure that the popup widget is fully visible. First it tries to move the popup in a way that is fully inside this area. If this is not enought the popup area will be clipped.

If this is not set, Buffer::area will be used instead.

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

Set styles

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

Run the layout to calculate the popup area before rendering.

Trait Implementations

impl Clone for PopupCore

fn clone(&self) -> PopupCore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PopupCore

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

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.