Struct Highlight

pub struct Highlight {
    pub overline_height: f64,
    pub overline_color: Color,
    pub underline_height: f64,
    pub underline_color: Color,
}

Describes a bar to be drawn below a workspace name

Fields

overline_height: f64

the height in pixels of the top highlight

overline_color: Color

the color of the top highlight

underline_height: f64

the height in pixels of the bottom highlight

underline_color: Color

the color of the bottom highlight

Implementations

impl Highlight

pub const fn empty() -> Self

Creates an empty instance (height set to 0.0, color set to black).

This creates the same Highlight as Highlight::default, but this is a const function.

pub const fn new( overline_height: f64, overline_color: Color, underline_height: f64, underline_color: Color, ) -> Self

Creates a new instance.

pub fn draw(&self, cr: &Context, bar_height: f64, width: f64) -> Result<()>

Draws the {over,under}lines associated with this highlight.

The current point of cr should have the same x coordinate as the left edge of the expected rectangles.

pub fn parse(name: impl AsRef<str>) -> Option<Self>

Parses a new instance from a subset of the global Config

Configuration options:

• {over,under}line_height: the height in pixels of the highlight
  • type: f64
  • default: none
• {over,under}line_color: the color of the highlight
  • type: String
  • default: none

Trait Implementations

impl Clone for Highlight

fn clone(&self) -> Highlight

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Highlight

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

Formats the value using the given formatter.

impl Default for Highlight

fn default() -> Highlight

Returns the “default value” for a type.

impl PartialEq for Highlight

fn eq(&self, other: &Highlight) -> 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 PartialOrd for Highlight

fn partial_cmp(&self, other: &Highlight) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Highlight