osui 0.2.0

A TUI library for advanced uis
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

//! # Scope Module
//!
//! Provides the Scope type for managing component hierarchies.
//! Scopes group child components and manage their lifecycle.

use std::sync::{Arc, Mutex};

use crate::{engine::CommandExecutor, View, ViewWrapper};

use super::{context::Context, ComponentImpl};

/// A scope groups child components and manages their rendering
/// 
/// Scopes form the hierarchical structure of a component tree.
/// Each scope contains references to its child components and their
/// optional view wrappers (for layout/styling).
pub struct Scope {
    /// Child components with optional view wrappers
    pub children: Mutex<Vec<(Arc<Context>, Option<ViewWrapper>)>>,
    /// Command executor for this scope's children
    executor: Arc<dyn CommandExecutor>,
}

impl Scope {
    /// Creates a new scope with the given command executor
    pub fn new(executor: Arc<dyn CommandExecutor>) -> Arc<Self> {
        Arc::new(Self {
            children: Mutex::new(Vec::new()),
            executor,
        })
    }

    /// Adds a child component to this scope
    /// 
    /// The view_wrapper is optional and can be used for layout or styling.
    pub fn child<F: ComponentImpl + 'static>(
        self: &Arc<Self>,
        child: F,
        view_wrapper: Option<ViewWrapper>,
    ) {
        let ctx = Context::new(child, self.executor.clone());

        ctx.refresh();

        self.children.lock().unwrap().push((ctx, view_wrapper));
    }

    /// Adds a view directly to this scope
    pub fn view(self: &Arc<Self>, view: View) {
        let ctx = Context::new(view, self.executor.clone());

        ctx.refresh();

        self.children.lock().unwrap().push((ctx, None));
    }
}