eave-api 0.1.3

Plugin API for the eave status bar
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

use std::fmt::Debug;

use serde::de::DeserializeOwned;

use crate::ui::{Item, Notice, Panel};
use crate::{Effect, Subscription, Task};

/// Something that sits in the bar, with an optional popover.
///
/// It follows the same Elm shape as the host: state lives in `Self`, changes arrive as messages in
/// [`update`](Widget::update), and the views are pure functions of state. `update` must not block:
/// do I/O in a [`Task`] or a [`Subscription`].
pub trait Widget: Sized + 'static {
    /// Options from this widget's entry in `config.toml`, minus the `widget` key.
    ///
    /// The entry may be empty, so use `#[serde(default)]` for options that have one.
    type Config: DeserializeOwned;
    type Message: Clone + Debug + Send + Sync + 'static;

    fn new(config: Self::Config) -> (Self, Task<Self::Message>);

    fn update(&mut self, message: Self::Message) -> Effect<Self::Message>;

    fn subscription(&self) -> Subscription<Self::Message> {
        Subscription::none()
    }

    /// What the widget shows in the bar.
    fn item(&self) -> Item<Self::Message>;

    /// The popover contents, if this widget has one.
    ///
    /// When it returns `Some` and the item has no `on_press`, a click on the item opens and
    /// closes the popover. Returning `None` while the popover is open closes it.
    fn popover(&self) -> Option<Panel<Self::Message>> {
        None
    }

    /// Notifications to show on screen now, newest first. Only for a notification engine: the
    /// widget that serves `org.freedesktop.Notifications` lists here what it received. Any other
    /// widget sends its notifications with `Notify` on the session bus, like any app.
    ///
    /// While there are any, the bar's right island turns into a panel of them, like a popover. The
    /// host takes each one away once its key is no longer in the list. Keep the notices you mean to show in your state, and drop
    /// one when it's dismissed or expires.
    fn notices(&self) -> Vec<Notice<Self::Message>> {
        Vec::new()
    }
}