Struct bitbar::ContentItem

source · [−]

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

Expand description

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.

size: Option<usize>

Corresponds to BitBar’s size= 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.

flavor_attrs: Option<Attrs>

Parameters for flavor-specific features.

Implementations

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<C: TryInto<Color>>(self, color: C) -> Result<Self, C::Error>

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 size(self, size: usize) -> Self

Sets this menu item’s font size.

pub fn command<C: TryInto<Command>>(self, cmd: C) -> Result<Self, C::Error>

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. Read more

impl Default for ContentItem

fn default() -> ContentItem

Returns the “default value” for a type. Read more

impl Display for ContentItem

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

Formats the value using the given formatter. Read more

impl From<ContentItem> for MenuItem

fn from(i: ContentItem) -> MenuItem

Performs the conversion.

Auto Trait Implementations

impl RefUnwindSafe for ContentItem

impl Send for ContentItem

impl Sync for ContentItem

impl Unpin for ContentItem

impl UnwindSafe for ContentItem

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> SetParameter for T

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,

Sets value as a parameter of self.

impl<T> ToString for T where
T: Display + ?Sized,

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more