streamdeck-oxide 0.2.1

A high-level framework for creating Stream Deck applications in Rust
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

//! Button types for the view system.
//!
//! This module provides types for representing buttons in the view system.

use crate::Theme;

/// The state of a button.
#[derive(Clone, Copy)]
pub enum ButtonState {
    /// The default state.
    Default,
    /// The button is pressed.
    Pressed,
    /// The button is active.
    Active,
    /// The button is inactive.
    Inactive,
    /// The button is in an error state.
    Error,
}

/// A button in the view system.
///
/// This struct represents a button in the view system. It contains
/// the text, icon, and state of the button.
#[derive(Clone)]
pub struct Button {
    /// The text to display on the button.
    pub(crate) text: String,
    /// The icon to display on the button.
    pub(crate) icon: Option<&'static str>,
    /// The state of the button.
    pub(crate) state: ButtonState,
    /// Alternative theme
    pub(crate) theme: Option<Theme>,
}

impl Button {
    /// Create a new button with the given text, icon, and state.
    pub fn new(text: String, icon: Option<&'static str>, state: ButtonState) -> Self {
        Button {
            text,
            icon,
            state,
            theme: None,
        }
    }

    /// Create a new button with the given text.
    pub fn text(text: String) -> Self {
        Button {
            text,
            icon: None,
            state: ButtonState::Default,
            theme: None,
        }
    }

    /// Create a new button with the given text and icon.
    pub fn with_icon(text: String, icon: &'static str) -> Self {
        Button {
            text,
            icon: Some(icon),
            state: ButtonState::Default,
            theme: None,
        }
    }

    /// Create a new button with the given text and state.
    pub fn with_state(text: String, state: ButtonState) -> Self {
        Button {
            text,
            icon: None,
            state,
            theme: None,
        }
    }

    /// Create a new button with the given text, icon, and state.
    pub fn with_icon_and_state(text: String, icon: &'static str, state: ButtonState) -> Self {
        Button {
            text,
            icon: Some(icon),
            state,
            theme: None,
        }
    }

    /// Update the text of the button.
    pub fn updated_text(&self, text: String) -> Self {
        Button {
            text,
            icon: self.icon,
            state: self.state,
            theme: self.theme.clone(),
        }
    }

    /// Update the icon of the button.
    pub fn updated_icon(&self, icon: &'static str) -> Self {
        Button {
            text: self.text.clone(),
            icon: Some(icon),
            state: self.state,
            theme: self.theme.clone(),
        }
    }

    /// Update the state of the button.
    pub fn updated_state(&self, state: ButtonState) -> Self {
        Button {
            text: self.text.clone(),
            icon: self.icon,
            state,
            theme: self.theme.clone(),
        }
    }

    /// Update the theme of the button.
    pub fn with_theme(self, theme: Theme) -> Self {
        Button {
            theme: Some(theme),
            ..self
        }
    }
}

impl Default for Button {
    fn default() -> Self {
        Button {
            text: "".to_string(),
            icon: None,
            state: ButtonState::Default,
            theme: None,
        }
    }
}