ferroui-controls 0.2.0

The controls of FerroUI: the application model, top levels, the control set and automation peers
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

use crate::{ControlImpl, Decorator};
use ferroui_base::input::InputElementImpl;
use ferroui_base::interactivity::InteractiveImpl;
use ferroui_base::layout::LayoutableImpl;
use ferroui_base::styling::ThemeVariant;
use ferroui_base::{
    ferro_class, ferro_class_info, ferro_impl_classes, instantiate, FerroObjectImpl, Ref, StyledElementImpl,
    StyledProperty, VisualImpl,
};

/// Decorator control that isolates a subtree of controls with a locally
/// defined [`ThemeVariant`].
#[repr(C)]
pub struct ThemeVariantScope {
    base: Decorator,
}

ferro_class!(ThemeVariantScope: Decorator);
ferro_class_info!(ThemeVariantScope { new: ThemeVariantScope::new });
ferro_impl_classes!(
    ThemeVariantScope: FerroObjectImpl,
    StyledElementImpl,
    VisualImpl,
    LayoutableImpl,
    InteractiveImpl,
    InputElementImpl,
    ControlImpl
);

impl ThemeVariantScope {
    /// Defines the `ActualThemeVariant` property: the property of
    /// [`ThemeVariant`], which every styled element owns.
    pub fn actual_theme_variant_property() -> &'static StyledProperty<Option<ThemeVariant>> {
        ThemeVariant::actual_theme_variant_property()
    }

    /// Defines the `RequestedThemeVariant` property: the property of
    /// [`ThemeVariant`], which every styled element owns.
    pub fn requested_theme_variant_property() -> &'static StyledProperty<Option<ThemeVariant>> {
        ThemeVariant::requested_theme_variant_property()
    }

    /// Creates the class data; see [`ferroui_base::FerroObject::construct`].
    pub fn construct() -> Self {
        Self { base: Decorator::construct() }
    }

    pub fn new() -> Ref<Self> {
        instantiate(Self::construct())
    }

    /// The UI theme variant that is used by the control (and its child
    /// elements) for resource determination. The UI theme specified with it
    /// can override the app-level theme variant.
    ///
    /// Setting it to the default theme variant applies the actual theme
    /// variant of the parent on the current scope.
    pub fn requested_theme_variant(&self) -> Option<ThemeVariant> {
        self.get_value(Self::requested_theme_variant_property())
    }

    pub fn set_requested_theme_variant(&self, value: Option<ThemeVariant>) {
        self.set_value(Self::requested_theme_variant_property(), value)
    }
}