Struct HeaderRowFace 

pub struct HeaderRowFace {
    pub row: Rect,
    pub toggle: Rect,
    pub back: Rect,
    pub title: Rect,
    pub actions: Rect,
    pub history: Rect,
    pub trailing: Rect,
    pub rule: Rect,
    /* private fields */
}

The geometry of one header row. See the module docs.

Fields

row: Rect

The whole row.

toggle: Rect

The sidebar toggle, or Rect::ZERO.

back: Rect

The Back button, or Rect::ZERO.

title: Rect

Where the title may stand: from the title’s start to the trailing buttons. The title takes its measured width from the leading end.

actions: Rect

Where the column’s actions may stand, trailing-aligned: the same run as the title until Self::split gives the title its width.

history: Rect

The window’s History control, or Rect::ZERO.

trailing: Rect

A trailing shell button before History (the inspector toggle), or Rect::ZERO.

rule: Rect

The hairline under the row, or Rect::ZERO for a row without one (a sidebar, a drawer).

Implementations

impl HeaderRowFace

pub fn new(area: Rect, theme: &Theme) -> HeaderRowFace

The header row across the top of area, with a rule under it and no shell buttons yet.

pub fn height(theme: &Theme) -> f64

The row’s height for theme.

pub fn metrics(&self) -> HeaderRowMetrics

pub fn with_toggle(self) -> HeaderRowFace

Put the sidebar toggle at the row’s leading corner.

pub fn with_back(self) -> HeaderRowFace

Put a Back button at the leading edge, after the toggle.

pub fn with_history(self) -> HeaderRowFace

Put the window’s History control in the row’s trailing corner (a trailing chip placed before it moves one place in).

pub fn with_history_if(self, shown: bool) -> HeaderRowFace

Self::with_history where the host offered the window’s History control (shown: crate::widget::HistoryOpener::is_shown).

pub fn with_trailing(self) -> HeaderRowFace

A trailing shell button before History (an inspector toggle).

pub fn with_inset_title(self) -> HeaderRowFace

Start the title at the shell buttons’ inset instead of the content gutter (a sidebar’s title lines up with its rows, not with content).

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

The area under the row: what a painted app lays its content in.

pub fn history_rect(&self) -> Rect

The History control’s rect: where a painted app paints paint_history_control and routes its presses.

pub fn split(&self, width: f64) -> (Rect, Rect)

Give the title width (its measured width) and the actions what is left after it: (title, actions).

pub fn paint_rule(&self, scene: &mut Scene, transform: Affine, theme: &Theme)

Paint the rule under the row on theme’s ground.

pub fn paint_title( &self, scene: &mut Scene, transform: Affine, text: &mut TextRenderer, theme: &Theme, title: &str, count: Option<usize>, actions_x0: Option<f64>, )

Paint title (and a quiet count after it) in the title band, elided to fit before actions_x0, the leading edge of what the actions took (None: the whole band).

Trait Implementations

impl Clone for HeaderRowFace

fn clone(&self) -> HeaderRowFace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeaderRowFace

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

Formats the value using the given formatter.

impl PartialEq for HeaderRowFace

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for HeaderRowFace

impl StructuralPartialEq for HeaderRowFace