Struct rust_bitbar::Line

pub struct Line { /* fields omitted */ }

Line holds the content, styling and behaviour of a line in a Bitbar menu, both in the menu and submenus

Methods

impl Line

pub fn style(&mut self, style: Style) -> &mut Self

Style provides a alternate method for setting the text style related options.

pub fn command(&mut self, cmd: Cmd) -> &mut Self

command provides a alternate method for setting the bash script and params along with some related flags via a Cmd struct.

pub fn href(&mut self, href: String) -> &mut Self

href adds a URL to the line and makes it clickable.

pub fn color(&mut self, color: String) -> &mut Self

Color sets the lines font color, can take a name or hex value.

pub fn font(&mut self, font: String) -> &mut Self

Font sets the lines font.

pub fn size(&mut self, size: i64) -> &mut Self

Size sets the lines font size.

pub fn bash(&mut self, bash: String) -> &mut Self

Bash makes makes the line clickable and adds a script that will be run on click.

pub fn params(&mut self, params: Vec<String>) -> &mut Self

Params adds arguments which are passed to the script specified by line.bash()

pub fn terminal(&mut self, terminal: bool) -> &mut Self

Terminal sets a flag which controls whether a Terminal is opened when the bash script is run.

pub fn refresh(&mut self, refresh: bool) -> &mut Self

Refresh controls whether clicking the line results in the plugin being refreshed. If the line has a bash script attached then the plugin is refreshed after the script finishes.

pub fn drop_down(&mut self, drop_down: bool) -> &mut Self

DropDown sets a flag which controls whether the line only appears and cycles in the status bar but not in the dropdown.

pub fn length(&mut self, length: i64) -> &mut Self

Length truncates the line after the specified number of characters. An elipsis will be added to any truncated strings, as well as a tooltip displaying the full string.

pub fn trim(&mut self, trim: bool) -> &mut Self

Trim sets a flag to control whether leading/trailing whitespace is trimmed from the title. Defaults to true.

pub fn alternate(&mut self, alternate: bool) -> &mut Self

Alternate sets a flag to mark a line as an alternate to the previous one for when the Option key is pressed in the dropdown.

pub fn emojize(&mut self, emojize: bool) -> &mut Self

Emojize sets a flag to control parsing of github style :mushroom: into 🍄.

pub fn ansi(&mut self, ansi: bool) -> &mut Self

Ansi sets a flag to control parsing of ANSI codes.

Trait Implementations

impl Clone for Line

fn clone(&self) -> Line

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ToString for Line

fn to_string(&self) -> String

Converts the given value to a String.

impl Default for Line

fn default() -> Line

Returns the "default value" for a type.

impl Debug for Line

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

Formats the value using the given formatter.