Struct bitbar::ContentItem

pub struct ContentItem {
    pub text: String,
    pub extra: Option<Extra>,
    pub href: Option<Url>,
    pub color: Option<Color>,
    pub font: Option<String>,
    pub command: Option<Command>,
    pub refresh: bool,
    pub image: Option<Image>,
}

A menu item that's not a separator.

Fields

text: String

This menu item's main content text.

Any | in the text will be displayed as ¦, and any newlines will be displayed as spaces.

extra: Option<Extra>

This menu item's alternate-mode menu item or submenu.

href: Option<Url>

Corresponds to BitBar's href= parameter.

color: Option<Color>

Corresponds to BitBar's color= parameter.

font: Option<String>

Corresponds to BitBar's font= parameter.

command: Option<Command>

Corresponds to BitBar's bash=, terminal=, param1=, etc. parameters.

refresh: bool

Corresponds to BitBar's refresh= parameter.

image: Option<Image>

Corresponds to BitBar's image= or templateImage= parameter.

Methods

impl ContentItem

pub fn new(text: impl ToString) -> ContentItem

Returns a new menu item with the given text.

Any | in the text will be displayed as ¦, and any newlines will be displayed as spaces.

pub fn sub(self, items: impl IntoIterator<Item = MenuItem>) -> Self

Adds a submenu to this menu item.

pub fn href(self, href: impl IntoUrl) -> Result<Self, ParseError>

Adds a clickable link to this menu item.

pub fn color(self, color: impl IntoColor) -> Result<Self, ColorParseError>

Sets this menu item's text color. Alpha channel is ignored.

pub fn font(self, font: impl ToString) -> Self

Sets this menu item's text font.

pub fn command(self, cmd: impl Into<Command>) -> Self

Make this menu item run the given command when clicked.

pub fn refresh(self) -> Self

Causes the BitBar plugin to be refreshed when this menu item is clicked.

pub fn alt(self, alt: impl Into<ContentItem>) -> Self

Adds an alternate menu item, which is shown instead of this one as long as the option key ⌥ is held.

pub fn template_image<T: TryInto<Image>>(self, img: T) -> Result<Self, T::Error>

Adds a template image to this menu item.

pub fn image<T: TryInto<Image>>(self, img: T) -> Result<Self, T::Error>

Adds an image to this menu item. The image will not be considered a template image unless specified as such by the img parameter.

Trait Implementations

impl Debug for ContentItem

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

Formats the value using the given formatter.

impl Default for ContentItem

fn default() -> ContentItem

Returns the "default value" for a type.

impl Display for ContentItem

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

Formats the value using the given formatter.

impl From<ContentItem> for MenuItem

fn from(i: ContentItem) -> MenuItem

Performs the conversion.