Struct leechbar::Foreground

pub struct Foreground { /* fields omitted */ }

Foreground of a component.

The foreground of a component. This is used for setting the text, the text alignment and the vertical text offset.

Examples

use leechbar::{Foreground, Text, BarBuilder, Alignment};

let bar = BarBuilder::new().spawn().unwrap();
let text = Text::new(&bar, "Hello, World", None, None).unwrap();
let fg = Foreground::new()
                    .text(text)
                    .yoffset(3)
                    .alignment(Alignment::RIGHT);

Methods

impl Foreground

pub fn new() -> Self

Create a new empty Foreground.

Examples

use leechbar::Foreground;

let fg = Foreground::new();

pub fn text(self, text: Text) -> Self

Set the text of the foreground.

Default: No text.

Examples

use leechbar::{Foreground, Text, BarBuilder};

let bar = BarBuilder::new().spawn().unwrap();
let text = Text::new(&bar, "Text :)", None, None).unwrap();
let fg = Foreground::new().text(text);

pub fn alignment(self, alignment: Alignment) -> Self

Set the alignment of the text inside the component.

Default: Alignment::CENTER

Examples

use leechbar::{Foreground, Alignment};

let fg = Foreground::new().alignment(Alignment::RIGHT);

pub fn yoffset(self, yoffset: i16) -> Self

Offset the text vertically. Increasing this offset, moves the text down from the center.

Default: Bar's vertical text offset.

use leechbar::Foreground;

let fg = Foreground::new().yoffset(-3);

Trait Implementations

impl Clone for Foreground

fn clone(&self) -> Foreground

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Text> for Foreground

fn from(text: Text) -> Foreground

Performs the conversion.

impl Default for Foreground

fn default() -> Self

Returns the "default value" for a type.