flo_ui 0.1.0

Implementation-free user interface description library
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 super::super::control::*;
use super::super::viewmodel_update::*;

use canvas::*;

///
/// Represents a differnce to the UI
/// 
#[derive(Clone, PartialEq, Debug)]
pub struct UiDiff {
    /// The address of where the UI tree was changed
    pub address: Vec<u32>,

    // The UI that replaces the tree at this address
    pub new_ui: Control
}

///
/// Represents a difference to a canvas
/// 
#[derive(Clone, PartialEq, Serialize, Deserialize, Debug)]
pub struct CanvasDiff {
    /// The path to the controller that owns the canvas being updated
    pub controller: Vec<String>,

    /// The name of the canvas being updated
    pub canvas_name: String,

    // The updates being made to the canvas
    pub updates: Vec<Draw>
}

///
/// Updates that can arrive from the UI
/// 
#[derive(Clone, PartialEq, Debug)]
pub enum UiUpdate {
    /// Start of a stream of UI updates
    Start,

    /// Represents a series of updates to the UI tree
    UpdateUi(Vec<UiDiff>),

    /// Represents an update to a canvas in a controller
    UpdateCanvas(Vec<CanvasDiff>),

    /// Represents an update to the viewmodel
    UpdateViewModel(Vec<ViewModelUpdate>)
}