Struct i3status_rs::blocks::sound::Sound

pub struct Sound {
    text: TextWidget,
    id: usize,
    device: Box<dyn SoundDevice>,
    device_kind: DeviceKind,
    step_width: u32,
    format: FormatTemplate,
    on_click: Option<String>,
    show_volume_when_muted: bool,
    mappings: Option<BTreeMap<String, String>>,
    max_vol: Option<u32>,
    scrolling: Scrolling,
}

Fields

text: TextWidget

id: usize

device: Box<dyn SoundDevice>

device_kind: DeviceKind

step_width: u32

format: FormatTemplate

on_click: Option<String>

show_volume_when_muted: bool

mappings: Option<BTreeMap<String, String>>

max_vol: Option<u32>

scrolling: Scrolling

Implementations

impl Sound

fn icon(&self, volume: u32) -> String

Trait Implementations

impl Block for Sound

fn update(&mut self) -> Result<Option<Update>, Error>

Required if you don't want a static block.

fn view(&self) -> Vec<&dyn I3BarWidget>

Use this function to return the widgets that comprise the UI of your component.

fn click(&mut self, e: &I3BarEvent) -> Result<(), Error>

Sends click events to the block.

fn id(&self) -> usize

A unique id for the block (asigend by the constructor).

fn signal(&mut self, _signal: i32) -> Result<(), Error>

Sends a signal event with the provided signal, this function is called on every block for every signal event

impl ConfigBlock for Sound

type Config = SoundConfig

fn new(
    id: usize,
    block_config: Self::Config,
    shared_config: SharedConfig,
    tx_update_request: Sender<Task>
) -> Result<Self, Error>

Creates a new block from the relevant configuration.

fn override_on_click(&mut self) -> Option<&mut Option<String>>

TODO: write documentation