Struct Divider 

pub struct Divider { /* private fields */ }

A rule between two groups of content.

The smallest widget here, and worth having only because everybody draws it slightly differently otherwise — one pixel or two, Base300 or a faded BaseContent, inset or full width. It is here so a panel is consistent with itself.

Not interactive, not focusable, no messages.

A label only makes sense across

A horizontal divider with a label draws line, gap, text, gap, line. A vertical one ignores its label and draws an unbroken rule, because the text would have to be rotated and there is no rotated text in the rasteriser. Ignoring it is better than drawing horizontal text through a vertical line and calling that a feature.

About “one pixel”

The thickness comes from Metrics::border, which is a logical pixel — one at scale factor 1, two under Metrics::TOUCH, and whatever the application’s scale factor makes of it on a dense display: a scale-aware application passes theme.scaled(factor) at construction and this widget’s rule thickens with everything else. See docs/design.md for the pattern.

Implementations

impl Divider

pub fn new() -> Self

A horizontal rule with no label.

pub fn labelled(label: impl Into<String>) -> Self

A horizontal rule with label in the middle.

pub fn vertical() -> Self

A vertical rule. Any label is ignored — see the type documentation.

pub fn with_role(self, role: Role) -> Self

Sets the line’s colour role.

pub fn with_style(self, style: TextStyle) -> Self

Sets the label’s font and size.

pub fn label(&self) -> &str

The current label, empty if there is none.

pub fn set_label(&mut self, label: impl Into<String>)

Replaces the label.

pub fn set_style(&mut self, style: TextStyle)

Replaces the label’s font and size.

pub const fn orientation(&self) -> Orientation

Which way it runs.

Trait Implementations

impl Clone for Divider

fn clone(&self) -> Divider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Divider

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

Formats the value using the given formatter.

impl Default for Divider

fn default() -> Self

Returns the “default value” for a type.

impl Describe for Divider

const KIND: &'static str = "divider"

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

const DOC: &'static str = "A line between things, with an optional label in the middle."

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

const GROUP: Group = Group::Display

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 Divider

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 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 accepts_pointer(&self) -> bool

Returns true if the pointer can hit this widget.

fn focusable(&self) -> bool

Returns true if this widget can take keyboard focus.

fn preserves_focus(&self) -> bool

Returns true if a press on this widget should leave focus exactly where it is.

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.