Struct ViewRegistration

Source

pub struct ViewRegistration<'a, ViewId, const N: usize> { /* private fields */ }

Expand description

Mutable registration object passed to crate::UiView::configure.

Implementations§

Source §

impl<'a, ViewId, const N: usize> ViewRegistration<'a, ViewId, N>

Source

pub fn new(frame: Rectangle) -> Self

Creates a registration rooted at the given frame.

Examples found in repository ?

src/system.rs (line 30)

29    pub fn new(display: Display, root: Root, theme: FsTheme, i18n: I18n<'text>) -> Self {
30        let registration = ViewRegistration::new(display.bounds());
31        let mut system = Self {
32            display,
33            root,
34            theme,
35            i18n,
36            registration,
37            marker: PhantomData,
38        };
39        system.configure_root();
40        system
41    }

Source

pub const fn frame(&self) -> Rectangle

Returns the current root frame for the view.

Examples found in repository ?

examples/runtime_shell.rs (line 29)

27    fn configure(&mut self, registration: &mut ViewRegistration<'static, RootId, 1>) {
28        let _ = registration.add_child(
29            ChildView::new(RootId::Surface, registration.frame()).with_kind(ViewKind::Custom),
30        );
31    }
32
33    fn handle_touch(
34        &mut self,
35        _touch: TouchEvent,
36        _registration: &ViewRegistration<'static, RootId, 1>,
37        _env: &ViewEnvironment<'_, 'static>,
38    ) -> ViewEvent<()> {
39        ViewEvent::redraw(ViewRedraw::Full)
40    }
41
42    fn draw<D>(
43        &self,
44        display: &mut D,
45        registration: &ViewRegistration<'static, RootId, 1>,
46        _env: &ViewEnvironment<'_, 'static>,
47    ) where
48        D: DrawTarget<Color = Rgb565>,
49    {
50        registration
51            .frame()
52            .into_styled(PrimitiveStyle::with_fill(Rgb565::new(31, 63, 31)))
53            .draw(display)
54            .ok();
55    }

More examples

Hide additional examples

examples/uikit_root.rs (line 45)

42    fn configure(&mut self, registration: &mut ViewRegistration<'static, DemoViewId, 2>) {
43        registration.set_title(Localized::new("root.title", "Devices"));
44        registration.set_clips_to_bounds(true);
45        let list_frame = registration.frame();
46        let _ = registration.add_child(
47            ChildView::new(DemoViewId::DevicesList, list_frame)
48                .with_kind(ViewKind::List)
49                .with_title(Localized::new("devices.title", "Devices")),
50        );
51        let _ = registration.add_child(
52            ChildView::new(
53                DemoViewId::AlertOverlay,
54                Rectangle::new(Point::new(16, 16), Size::new(0, 0)),
55            )
56            .with_kind(ViewKind::AlertHost)
57            .with_hidden(true)
58            .with_alpha(0),
59        );
60    }

Source

pub fn set_frame(&mut self, frame: Rectangle)

Updates the root frame for the view.

Examples found in repository ?

src/system.rs (line 46)

44    pub fn configure_root(&mut self) {
45        self.registration.clear_children();
46        self.registration.set_frame(self.display.bounds());
47        self.root.configure(&mut self.registration);
48    }

Source

pub const fn properties(&self) -> &ViewProperties<'a>

Returns the accumulated properties for the registered view.

Source

pub fn set_title(&mut self, title: Localized<'a>)

Sets the view title.

Examples found in repository ?

examples/uikit_root.rs (line 43)

42    fn configure(&mut self, registration: &mut ViewRegistration<'static, DemoViewId, 2>) {
43        registration.set_title(Localized::new("root.title", "Devices"));
44        registration.set_clips_to_bounds(true);
45        let list_frame = registration.frame();
46        let _ = registration.add_child(
47            ChildView::new(DemoViewId::DevicesList, list_frame)
48                .with_kind(ViewKind::List)
49                .with_title(Localized::new("devices.title", "Devices")),
50        );
51        let _ = registration.add_child(
52            ChildView::new(
53                DemoViewId::AlertOverlay,
54                Rectangle::new(Point::new(16, 16), Size::new(0, 0)),
55            )
56            .with_kind(ViewKind::AlertHost)
57            .with_hidden(true)
58            .with_alpha(0),
59        );
60    }

Source

pub fn set_alpha(&mut self, alpha: u8)

Sets the alpha value used for the view.

Source

pub fn set_hidden(&mut self, hidden: bool)

Marks the registered view as hidden or visible.

Source

pub fn set_clips_to_bounds(&mut self, clips_to_bounds: bool)

Enables or disables clipping to bounds.

Examples found in repository ?

examples/uikit_root.rs (line 44)

42    fn configure(&mut self, registration: &mut ViewRegistration<'static, DemoViewId, 2>) {
43        registration.set_title(Localized::new("root.title", "Devices"));
44        registration.set_clips_to_bounds(true);
45        let list_frame = registration.frame();
46        let _ = registration.add_child(
47            ChildView::new(DemoViewId::DevicesList, list_frame)
48                .with_kind(ViewKind::List)
49                .with_title(Localized::new("devices.title", "Devices")),
50        );
51        let _ = registration.add_child(
52            ChildView::new(
53                DemoViewId::AlertOverlay,
54                Rectangle::new(Point::new(16, 16), Size::new(0, 0)),
55            )
56            .with_kind(ViewKind::AlertHost)
57            .with_hidden(true)
58            .with_alpha(0),
59        );
60    }

Source

pub fn set_user_interaction_enabled(&mut self, enabled: bool)

Enables or disables touch handling for the view.

Source

pub fn clear_children(&mut self)

Removes all previously registered child views.

Examples found in repository ?

src/system.rs (line 45)

44    pub fn configure_root(&mut self) {
45        self.registration.clear_children();
46        self.registration.set_frame(self.display.bounds());
47        self.root.configure(&mut self.registration);
48    }

Source

pub fn add_child( &mut self, child: ChildView<'a, ViewId>, ) -> Result<(), ChildView<'a, ViewId>>

Registers one child view.

Examples found in repository ?

examples/runtime_shell.rs (lines 28-30)

27    fn configure(&mut self, registration: &mut ViewRegistration<'static, RootId, 1>) {
28        let _ = registration.add_child(
29            ChildView::new(RootId::Surface, registration.frame()).with_kind(ViewKind::Custom),
30        );
31    }

More examples

Hide additional examples

examples/uikit_root.rs (lines 46-50)

42    fn configure(&mut self, registration: &mut ViewRegistration<'static, DemoViewId, 2>) {
43        registration.set_title(Localized::new("root.title", "Devices"));
44        registration.set_clips_to_bounds(true);
45        let list_frame = registration.frame();
46        let _ = registration.add_child(
47            ChildView::new(DemoViewId::DevicesList, list_frame)
48                .with_kind(ViewKind::List)
49                .with_title(Localized::new("devices.title", "Devices")),
50        );
51        let _ = registration.add_child(
52            ChildView::new(
53                DemoViewId::AlertOverlay,
54                Rectangle::new(Point::new(16, 16), Size::new(0, 0)),
55            )
56            .with_kind(ViewKind::AlertHost)
57            .with_hidden(true)
58            .with_alpha(0),
59        );
60    }

Source

pub fn children(&self) -> &[ChildView<'a, ViewId>]

Returns the registered children as a slice.

Examples found in repository ?

examples/uikit_root.rs (line 68)

62    fn update(
63        &mut self,
64        dt_ms: u32,
65        registration: &ViewRegistration<'static, DemoViewId, 2>,
66        _env: &ViewEnvironment<'_, 'static>,
67    ) -> ViewEvent<DemoMessage> {
68        let list = registration.children()[0].frame;
69        ViewEvent::redraw(self.list.tick(dt_ms, list))
70    }
71
72    fn handle_touch(
73        &mut self,
74        touch: TouchEvent,
75        registration: &ViewRegistration<'static, DemoViewId, 2>,
76        _env: &ViewEnvironment<'_, 'static>,
77    ) -> ViewEvent<DemoMessage> {
78        self.list
79            .handle_touch(touch, registration.children()[0].frame)
80            .into_view_event()
81    }
82
83    fn draw<D>(
84        &self,
85        display: &mut D,
86        registration: &ViewRegistration<'static, DemoViewId, 2>,
87        env: &ViewEnvironment<'_, 'static>,
88    ) where
89        D: DrawTarget<Color = Rgb565>,
90    {
91        self.list
92            .draw(display, registration.children()[0].frame, env);
93    }