Struct Frame 

pub struct Frame {
    pub inner_margin: Margin,
    pub outer_margin: Margin,
    pub visuals: FrameVisuals,
    pub sense: Sense,
    pub interactive: bool,
    pub selected: bool,
    pub fill_width: bool,
}

A frame around some content: margin, fill ([Fill]), stroke, rounding, shadow.

Same geometry as egui::Frame: content_size + inner_margin + 2 * stroke.width + outer_margin.

The difference is the fill is a [Fill], so it can be a two-stop gradient, and state colors live on FrameVisuals like the other widgets.

Stroke width is taken from the idle border at begin. Changing stroke width on hover after begin does not relayout.

Fields

inner_margin: Margin

outer_margin: Margin

visuals: FrameVisuals

sense: Sense

interactive: bool

When false, paint always uses idle fill / border, even if the pointer is over the frame. Hover / click fills need Self::interactive.

selected: bool

Paint FrameVisuals::bg_selected instead of idle / hover / click.

fill_width: bool

Stretch the frame to the available width (useful for sidebar rows).

Implementations

impl Frame

pub const NONE: Self

pub const fn new() -> Self

pub fn from_egui(frame: Frame) -> Self

Copy margins, idle fill, stroke, radius, and shadow from an egui::Frame. Hover / click start equal to idle.

pub fn inner_margin(self, inner_margin: impl Into<Margin>) -> Self

pub fn outer_margin(self, outer_margin: impl Into<Margin>) -> Self

pub fn fill(self, fill: impl Into<Color32>) -> Self

Idle fill. Does not change hover / click unless they were still the old idle fill.

pub fn stroke(self, stroke: impl Into<Stroke>) -> Self

pub fn corner_radius(self, corner_radius: impl Into<CornerRadius>) -> Self

pub fn square_corners(self) -> Self

Make the frame square corners.

pub fn shadow(self, shadow: Shadow) -> Self

pub fn visuals(self, visuals: FrameVisuals) -> Self

Replace fill, stroke, radius, and shadow. Margins and sense are kept.

pub fn sense(self, sense: Sense) -> Self

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

true → Sense::click and hover / click fills. false → idle chrome only (pointer hover does not swap fill).

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

Paint FrameVisuals::bg_selected even when not hovered.

pub fn fill_width(self, fill: bool) -> Self

Stretch the frame to the available width.

The content Ui also gets that min width, so inner right-to-left rows (unread counts, timestamps) land on the far edge.

pub fn multiply_with_opacity(self, opacity: f32) -> Self

pub fn total_margin(&self) -> MarginF32

Idle stroke width is part of the margin (same as egui::Frame).

pub fn fill_rect(&self, content_rect: Rect) -> Rect

pub fn widget_rect(&self, content_rect: Rect) -> Rect

pub fn outer_rect(&self, content_rect: Rect) -> Rect

impl Frame

pub fn begin(self, ui: &mut Ui) -> Prepared

pub fn show<R>( self, ui: &mut Ui, add_contents: impl FnOnce(&mut Ui) -> R, ) -> InnerResponse<R>

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Frame

impl Debug for Frame

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

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame