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

source

impl ContentItem

source

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.

source

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

Adds a submenu to this menu item.

source

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

Adds a clickable link to this menu item.

source

pub fn color<C: TryInto<Color>>(self, color: C) -> Result<Self, C::Error>

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

source

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

Sets this menu item’s text font.

source

pub fn size(self, size: usize) -> Self

Sets this menu item’s font size.

source

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

Make this menu item run the given command when clicked.

source

pub fn refresh(self) -> Self

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

source

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.

source

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

Adds a template image to this menu item.

source

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

source

impl Debug for ContentItem

source

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

Formats the value using the given formatter. Read more

source

impl Default for ContentItem

source

fn default() -> ContentItem

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

source

impl Display for ContentItem

source

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

Formats the value using the given formatter. Read more

source

impl From<ContentItem> for MenuItem

source

fn from(i: ContentItem) -> MenuItem

Converts to this type from the input type.

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

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

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

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

source

fn in_current_span(self) -> Instrumented<Self>

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

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> NoneValue for T where
T: Default,

type NoneType = T

fn null_value() -> T

The none-equivalent value.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

source

impl<R, P> ReadPrimitive<R> for P where
R: Read + ReadEndian,
P: Default,

source

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().

source

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().

source

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().

source

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

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct bitbar::ContentItem

Fields

Implementations

impl ContentItem

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

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

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

pub fn color<C: TryInto<Color>>(self, color: C) -> Result<Self, C::Error>

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

pub fn size(self, size: usize) -> Self

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

pub fn refresh(self) -> Self

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

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

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

Trait Implementations

impl Debug for ContentItem

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

impl Default for ContentItem

fn default() -> ContentItem

impl Display for ContentItem

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

impl From<ContentItem> for MenuItem

fn from(i: ContentItem) -> MenuItem

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,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> NoneValue for T where T: Default,

type NoneType = T

fn null_value() -> T

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

impl<R, P> ReadPrimitive<R> for P where R: Read + ReadEndian<P>, P: Default,

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

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

default fn to_string(&self) -> String

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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

impl<T> NoneValue for T where
T: Default,

impl<R, P> ReadPrimitive<R> for P where
R: Read + ReadEndian<P>,
P: Default,

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

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