flux-tui 0.5.0

Fast and lightweight Terminal UI drawing 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
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

use std::sync::{OnceLock, mpsc::*};

use crossterm::event::Event;

use super::*;

// Changed property with the corresponding UID of the [Window]
pub(super) struct ChangedProperty {
	pub(super) uid: WindowUID,
	pub(super) property: WindowProperty,
}

impl ChangedProperty {
	fn new(uid: WindowUID, property: WindowProperty) -> Self {
		Self { property, uid }
	}
}

/// All Properties of the [Window] trait that can be evoked
#[derive(Debug, Copy, Clone, PartialEq, Hash)]
pub enum WindowProperty {
	Focus,
	Children,
	Alignment,
	Size,
	Margin,
	Border,
	IsVisible,
}

pub(super) struct TreeUpdate {
	pub win: WindowRef,
	pub depth: u8,
	pub rect: Rect,
}

pub(super) struct FocusUpdate {
	pub win: WindowRef,
	pub depth: u8,
}

static SENDER: OnceLock<SyncSender<ChangedProperty>> = OnceLock::new();

/// Handles externally fired events
pub struct WindowEventQueue {
	pub(super) recv: Receiver<ChangedProperty>,
}

impl WindowEventQueue {
	pub(super) fn initialize() -> Self {
		let (send, recv) = sync_channel(32);
		SENDER.set(send).unwrap();
		Self { recv }
	}

	/// On the next render call, all internal metadata that correlate to the property will update
	pub fn provoke_changed_property(uid: WindowUID, property: WindowProperty) {
		if let Some(sender) = SENDER.get() {
			let change = ChangedProperty::new(uid, property);
			sender.send(change).unwrap();
		}
	}
}

#[derive(Debug)]
/// [Event] wrapper with some additional information used by this library
pub struct WindowEvent {
	event: Event,
	pub handled: bool,
}

impl WindowEvent {
	pub(crate) fn new(event: Event) -> Self {
		Self {
			event,
			handled: false,
		}
	}

	/// Returns the raw [Event]
	pub fn raw(&self) -> &Event {
		&self.event
	}
}