rtop_dev 1.1.0-beta.1

Development librairy for creating plugin for RtopRS
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

//! Module containing all essentials tools to create a Rtop's plugin

/// Trait representing a Widget. Must be implemented on your struct to declare it as a Widget.
pub trait Widget {
    /// # Called every time Rtop need to update the widget display
    fn display(&mut self, height: i32, width: i32) -> String;

    /// # Called every time `display` is called, Change the title of the window if None is not returned.
    fn title(&mut self) -> Option<String> {
        None
    }

    /// # `Event` -- Called three time per second, even if the widget is not focused or not visible for the user.
    fn on_update(&mut self) {}

    /// # `Event` -- Called when an user input somethings when the widget is focused<br>
    /// ```⚠️ Only called if input is defined to true when creating the widget```
    fn on_input(&mut self, _key: String) {}

    /// # Called once when a widget is loaded. Can be used to init some information
    fn init(&mut self) {}
}