bevy_pages 0.4.1

Upgrade your Bevy UI experience with XML and an extended widget collection.
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

use crate::element::ElementProps;
use crate::parser::AttributeMap;
use bevy::app::App;
use bevy::prelude::{Entity, World};
use roxmltree::Node;
use std::fmt::Debug;

/// Contains the checkbox widget and functionality.
pub mod checkbox;

/// Contains the switch widget and functionality.
pub mod switch;

/// Contains the node widget and functionality.
pub mod node;

/// Contains the button widget and functionality.
pub mod button;

/// Contains the text widget and functionality.
pub mod text;

/// Contains the image widget and functionality.
pub mod image;

/// Contains the text input widget and functionality.
pub mod text_input;

/// Contains the slider widget and functionality.
pub mod slider;

/// Contains the progress bar widget and functionality.
pub mod progress_bar;

/// Contains the tooltip widget and functionality.
pub mod tooltip;

/// Contains the divider widget and functionality.
pub mod divider;

/// Contains the scroll view widget and functionality.
pub mod scroll_view;

/// Contains the dropdown widget and functionality.
pub mod dropdown;

/// Contains the notifier widget and functionality.
pub mod notifier;

/// A trait to define a widget.
pub trait Widget: Debug + Send + Sync + 'static {
    /// The name of the widget.
    ///
    /// This should also be its XML tag name.
    fn name() -> &'static str
    where
        Self: Sized;

    /// Set up the widget logic.
    ///
    /// This is where widgets should add systems and observers to the bevy app.
    fn setup(&self, app: &mut App);

    /// Parses the widget from an XML node and an [AttributeMap].
    fn parse(&mut self, node: &Node, attrs: &AttributeMap) -> Result<(), String>;

    /// Spawns the widget. Called inside [Element::spawn](crate::element::Element::spawn).
    fn spawn(&self, entity: Entity, world: &mut World) -> Entity;

    /// Apply this widget's default properties.
    fn apply_defaults(
        &self,
        attrs: &AttributeMap,
        default: &mut ElementProps,
        hover: &mut ElementProps,
        click: &mut ElementProps,
    );

    /// Creates a dynamic clone of the widget.
    fn dyn_clone(&self) -> Box<dyn Widget>;
}

impl Clone for Box<dyn Widget> {
    #[inline(always)]
    fn clone(&self) -> Self {
        self.dyn_clone()
    }
}