Struct azul_core::dom::Dom

pub struct Dom {
    pub root: NodeData,
    pub children: Vec<Dom>,
    // some fields omitted
}

The document model, similar to HTML. This is a create-only structure, you don't actually read anything back

Fields

root: NodeData

children: Vec<Dom>

Implementations

impl Dom

pub const fn new(node_type: NodeType) -> Self

Creates an empty DOM with a give NodeType. Note: This is a const fn and doesn't allocate, it only allocates once you add at least one child node.

pub fn with_capacity(node_type: NodeType, cap: usize) -> Self

Creates an empty DOM with space reserved for cap nodes

pub const fn div() -> Self

Shorthand for Dom::new(NodeType::Div).

pub const fn body() -> Self

Shorthand for Dom::new(NodeType::Body).

pub fn label<S: Into<DomString>>(value: S) -> Self

Shorthand for Dom::new(NodeType::Label(value.into()))

pub const fn text_id(text_id: TextId) -> Self

Shorthand for Dom::new(NodeType::Text(text_id))

pub const fn image(image: ImageId) -> Self

Shorthand for Dom::new(NodeType::Image(image_id))

pub fn gl_texture<I: Into<RefAny>>(callback: GlCallbackType, ptr: I) -> Self

Shorthand for Dom::new(NodeType::GlTexture((callback, ptr)))

pub fn iframe<I: Into<RefAny>>(callback: IFrameCallbackType, ptr: I) -> Self

Shorthand for Dom::new(NodeType::IFrame((callback, ptr)))

pub fn add_child(&mut self, child: Self)

Adds a child DOM to the current DOM

pub fn with_id<S: Into<DomString>>(self, id: S) -> Self

Same as id, but easier to use for method chaining in a builder-style pattern

pub fn with_class<S: Into<DomString>>(self, class: S) -> Self

Same as id, but easier to use for method chaining in a builder-style pattern

pub fn with_callback<O: Into<EventFilter>>(
    self,
    on: O,
    callback: CallbackType,
    ptr: RefAny
) -> Self

Same as event, but easier to use for method chaining in a builder-style pattern

pub fn with_child(self, child: Self) -> Self

pub fn with_css_override<S: Into<DomString>>(
    self,
    id: S,
    property: CssProperty
) -> Self

pub fn with_tab_index(self, tab_index: TabIndex) -> Self

pub fn is_draggable(self, draggable: bool) -> Self

pub fn add_id<S: Into<DomString>>(&mut self, id: S)

pub fn add_class<S: Into<DomString>>(&mut self, class: S)

pub fn add_callback<O: Into<EventFilter>>(
    &mut self,
    on: O,
    callback: CallbackType,
    ptr: RefAny
)

pub fn add_css_override<S: Into<DomString>, P: Into<CssProperty>>(
    &mut self,
    override_id: S,
    property: P
)

pub fn set_tab_index(&mut self, tab_index: TabIndex)

pub fn set_draggable(&mut self, draggable: bool)

pub fn get_html_string(&self) -> String

Returns a HTML-formatted version of the DOM for easier debugging, i.e.

Dom::div().with_id("hello")
    .with_child(Dom::div().with_id("test"))

will return:

<div id="hello">
     <div id="test" />
</div>

Trait Implementations

impl Clone for Dom

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Dom

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for Dom

impl From<Dom> for CompactDom

fn from(dom: Dom) -> Self

Performs the conversion.

impl FromIterator<Dom> for Dom

fn from_iter<I: IntoIterator<Item = Dom>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<NodeData> for Dom

fn from_iter<I: IntoIterator<Item = NodeData>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<NodeType> for Dom

fn from_iter<I: IntoIterator<Item = NodeType>>(iter: I) -> Self

Creates a value from an iterator.

impl PartialEq<Dom> for Dom

fn eq(&self, rhs: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.