Struct Panel 

pub struct Panel {
    pub fill: Option<Role>,
    pub border: Option<Role>,
    pub border_width: i32,
    pub radius: Radius,
    pub backdrop: bool,
}

A filled, optionally bordered rounded rectangle.

Panels are not interactive and are invisible to hit testing, so putting a button on one does not mean the panel steals the click. Panel::backdrop is the exception, for the sheet under an overlay’s contents.

Fields

fill: Option<Role>

Background role, or None to leave what is underneath alone.

border: Option<Role>

Border role, or None for no border.

border_width: i32

Border thickness in pixels, drawn inside the bounds.

radius: Radius

Corner rounding token. The theme decides the pixels.

backdrop: bool

Whether presses stop here instead of falling through.

See Panel::backdrop. Off for every ordinary panel.

Implementations

impl Panel

pub const fn filled(role: Role) -> Self

A panel filled with role and no border.

pub const fn bare() -> Self

A panel that draws nothing: no fill, no border.

A container, for when the grouping is the point — a tabs node’s pages, one per tab, shown and hidden as a unit. The tree already gives a node a rectangle, a clip and children; this is the widget for a node that wants those and no appearance of its own.

// Nothing to see, and that is the whole idea.
let page = Panel::bare();

pub const fn backdrop(self) -> Self

A panel that presses stop at, without disturbing the focus.

The sheet behind an overlay’s contents. An ordinary panel is invisible to hit testing, which is right for a card with a button on it and wrong for the sheet under an on-screen keyboard: a finger landing in the gap between two keys falls through to whatever is behind the overlay, and pressing that takes the focus away from the field being typed into — so a near-miss dismisses the keyboard.

This absorbs the press and leaves the focus exactly where it was, which is the same bargain Button::no_focus makes for the keys themselves.

pub const fn with_radius(self, radius: Radius) -> Self

Sets the corner rounding token.

pub const fn with_border(self, role: Role, width: i32) -> Self

Sets the border role and thickness.

Trait Implementations

impl Clone for Panel

fn clone(&self) -> Panel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Panel

impl Debug for Panel

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

Formats the value using the given formatter.

impl Default for Panel

fn default() -> Self

Returns the “default value” for a type.

impl Describe for Panel

const KIND: &'static str = "panel"

The name a form file uses for this widget. Kebab-case.

const DOC: &'static str = "A themed rectangle: the background other widgets sit on."

One line saying what this widget is, for somebody choosing one.

const GROUP: Group = Group::Container

Which shelf of the catalogue this belongs on.

const ICON: &'static Icon

The widget’s glyph: a small portrait of the thing, for a palette to draw beside — or instead of — its name.

const PROPERTIES: &'static [Property]

Every property, in the order an inspector should show them.

fn get(&self, name: &str) -> Option<Value>

The current value.

fn apply(&mut self, name: &str, value: Value) -> Result<(), Mismatch>

Applies a value, reporting only what went wrong.

fn set(&mut self, name: &str, value: Value) -> Result<(), PropertyError>

Applies a value, reporting what went wrong and where.

impl<M: 'static> Widget<M> for Panel

fn preserves_focus(&self) -> bool

A backdrop is pressed past, not pressed: it must not move the focus and must not clear it.

fn describe(&self) -> Option<&dyn DynDescribe>

This widget’s property description, if it has one.

fn describe_mut(&mut self) -> Option<&mut dyn DynDescribe>

The mutable half of describe.

fn accepts_pointer(&self) -> bool

Returns true if the pointer can hit this widget.

fn paint(&self, ctx: &mut PaintCtx<'_>, canvas: &mut Pen<'_>)

Draws into canvas, which is already clipped to this widget’s bounds intersected with the damage region being repainted.

fn on_event(&mut self, event: &Event<'_>, ctx: &mut EventCtx<'_, M>) -> Handled

Reacts to an event routed to this widget.

fn measure(&self, ctx: &mut MeasureCtx<'_>, offered: Offer) -> Measured

How big this widget would like to be, given what the caller can promise.

fn focusable(&self) -> bool

Returns true if this widget can take keyboard focus.

fn animate(&mut self, now_ms: u64) -> Animation

Advances time-based state. Called only while this widget has asked to animate — see EventCtx::request_animation — and stops being called the moment it answers Wake::Never.

fn snap(&mut self, now_ms: u64) -> Animation

Lands whatever is in flight at its end state, without animating it.