html_sys/embedded/
object.rs

1/// The HTML `<object>` element
2///
3/// [MDN Documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/object)
4#[doc(alias = "object")]
5#[non_exhaustive]
6#[derive(Debug, Clone, PartialEq, Default)]
7pub struct Object {
8    pub data_map: crate::DataMap,
9    global_attrs: crate::GlobalAttributes,
10    /// Address of the resource
11    pub data: std::option::Option<std::borrow::Cow<'static, str>>,
12    /// Type of embedded resource
13    pub type_: std::option::Option<std::borrow::Cow<'static, str>>,
14    /// Name of content navigable
15    pub name: std::option::Option<std::borrow::Cow<'static, str>>,
16    /// Associates the element with a form element
17    pub form: std::option::Option<std::borrow::Cow<'static, str>>,
18    /// Horizontal dimension
19    pub width: std::option::Option<std::borrow::Cow<'static, str>>,
20    /// Vertical dimension
21    pub height: std::option::Option<std::borrow::Cow<'static, str>>,
22    /// Describes the role(s) the current element plays in the context of the document.
23    pub role: std::option::Option<std::borrow::Cow<'static, str>>,
24    /// Identifies the currently active element when DOM focus is on a composite widget, combobox, textbox, group, or application.
25    pub aria_active_descendant_element: std::option::Option<
26        std::borrow::Cow<'static, str>,
27    >,
28    /// Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
29    pub aria_atomic: bool,
30    /// Defines a string value that labels the current element, which is intended to be converted into Braille. See related aria-label.
31    pub aria_braille_label: std::option::Option<std::borrow::Cow<'static, str>>,
32    /// Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. See related aria-roledescription.
33    pub aria_braille_role_description: std::option::Option<
34        std::borrow::Cow<'static, str>,
35    >,
36    /// Indicates an element is being modified and that assistive technologies could wait until the modifications are complete before exposing them to the user.
37    pub aria_busy: bool,
38    /// Identifies the element (or elements) whose contents or presence are controlled by the current element. See related aria-owns.
39    pub aria_controls_elements: std::option::Option<std::borrow::Cow<'static, str>>,
40    /// Indicates the element that represents the current item within a container or set of related elements.
41    pub aria_current: std::option::Option<std::borrow::Cow<'static, str>>,
42    /// Identifies the element (or elements) that describes the object. See related aria-labelledby and aria-description.
43    pub aria_described_by_elements: std::option::Option<std::borrow::Cow<'static, str>>,
44    /// Defines a string value that describes or annotates the current element. See related aria-describedby.
45    pub aria_description: std::option::Option<std::borrow::Cow<'static, str>>,
46    /// Identifies the element (or elements) that provide additional information related to the object. See related aria-describedby.
47    pub aria_details_elements: std::option::Option<std::borrow::Cow<'static, str>>,
48    /// Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. See related aria-hidden and aria-readonly.
49    pub aria_disabled: bool,
50    /// [Deprecated in ARIA 1.1] Indicates what functions can be performed when a dragged object is released on the drop target.
51    pub aria_drop_effect: std::option::Option<std::borrow::Cow<'static, str>>,
52    /// Identifies the element (or elements) that provides an error message for an object. See related aria-invalid and aria-describedby.
53    pub aria_error_message_elements: std::option::Option<std::borrow::Cow<'static, str>>,
54    /// Indicates whether a grouping element owned or controlled by this element is expanded or collapsed.
55    pub aria_expanded: bool,
56    /// Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
57    pub aria_flow_to_elements: std::option::Option<std::borrow::Cow<'static, str>>,
58    /// [Deprecated in ARIA 1.1] Indicates an element's "grabbed" state in a drag-and-drop operation.
59    pub aria_grabbed: bool,
60    /// Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
61    pub aria_has_popup: std::option::Option<std::borrow::Cow<'static, str>>,
62    /// Indicates whether the element is exposed to an accessibility API. See related aria-disabled.
63    pub aria_hidden: bool,
64    /// Indicates the entered value does not conform to the format expected by the application. See related aria-errormessage.
65    pub aria_invalid: std::option::Option<std::borrow::Cow<'static, str>>,
66    /// Defines keyboard shortcuts that an author has implemented to activate or give focus to an element.
67    pub aria_key_shortcuts: std::option::Option<std::borrow::Cow<'static, str>>,
68    /// Defines a string value that labels the current element. See related aria-labelledby.
69    pub aria_label: std::option::Option<std::borrow::Cow<'static, str>>,
70    /// Identifies the element (or elements) that labels the current element. See related aria-label and aria-describedby.
71    pub aria_labelled_by_elements: std::option::Option<std::borrow::Cow<'static, str>>,
72    /// Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
73    pub aria_live: std::option::Option<std::borrow::Cow<'static, str>>,
74    /// Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. See related aria-controls.
75    pub aria_owns_elements: std::option::Option<std::borrow::Cow<'static, str>>,
76    /// Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. See related aria-atomic.
77    pub aria_relevant: std::option::Option<std::borrow::Cow<'static, str>>,
78    /// Defines a human-readable, author-localized description for the role of an element.
79    pub aria_role_description: std::option::Option<std::borrow::Cow<'static, str>>,
80}
81impl crate::RenderElement for Object {
82    fn write_opening_tag<W: std::fmt::Write>(&self, writer: &mut W) -> std::fmt::Result {
83        write!(writer, "<object")?;
84        if let Some(field) = self.data.as_ref() {
85            write!(writer, r#" data="{field}""#)?;
86        }
87        if let Some(field) = self.type_.as_ref() {
88            write!(writer, r#" type="{field}""#)?;
89        }
90        if let Some(field) = self.name.as_ref() {
91            write!(writer, r#" name="{field}""#)?;
92        }
93        if let Some(field) = self.form.as_ref() {
94            write!(writer, r#" form="{field}""#)?;
95        }
96        if let Some(field) = self.width.as_ref() {
97            write!(writer, r#" width="{field}""#)?;
98        }
99        if let Some(field) = self.height.as_ref() {
100            write!(writer, r#" height="{field}""#)?;
101        }
102        if let Some(field) = self.role.as_ref() {
103            write!(writer, r#" role="{field}""#)?;
104        }
105        if let Some(field) = self.aria_active_descendant_element.as_ref() {
106            write!(writer, r#" aria-activedescendant="{field}""#)?;
107        }
108        if self.aria_atomic {
109            write!(writer, r#" aria-atomic"#)?;
110        }
111        if let Some(field) = self.aria_braille_label.as_ref() {
112            write!(writer, r#" aria-braillelabel="{field}""#)?;
113        }
114        if let Some(field) = self.aria_braille_role_description.as_ref() {
115            write!(writer, r#" aria-brailleroledescription="{field}""#)?;
116        }
117        if self.aria_busy {
118            write!(writer, r#" aria-busy"#)?;
119        }
120        if let Some(field) = self.aria_controls_elements.as_ref() {
121            write!(writer, r#" aria-controls="{field}""#)?;
122        }
123        if let Some(field) = self.aria_current.as_ref() {
124            write!(writer, r#" aria-current="{field}""#)?;
125        }
126        if let Some(field) = self.aria_described_by_elements.as_ref() {
127            write!(writer, r#" aria-describedby="{field}""#)?;
128        }
129        if let Some(field) = self.aria_description.as_ref() {
130            write!(writer, r#" aria-description="{field}""#)?;
131        }
132        if let Some(field) = self.aria_details_elements.as_ref() {
133            write!(writer, r#" aria-details="{field}""#)?;
134        }
135        if self.aria_disabled {
136            write!(writer, r#" aria-disabled"#)?;
137        }
138        if let Some(field) = self.aria_drop_effect.as_ref() {
139            write!(writer, r#" aria-dropeffect="{field}""#)?;
140        }
141        if let Some(field) = self.aria_error_message_elements.as_ref() {
142            write!(writer, r#" aria-errormessage="{field}""#)?;
143        }
144        if self.aria_expanded {
145            write!(writer, r#" aria-expanded"#)?;
146        }
147        if let Some(field) = self.aria_flow_to_elements.as_ref() {
148            write!(writer, r#" aria-flowto="{field}""#)?;
149        }
150        if self.aria_grabbed {
151            write!(writer, r#" aria-grabbed"#)?;
152        }
153        if let Some(field) = self.aria_has_popup.as_ref() {
154            write!(writer, r#" aria-haspopup="{field}""#)?;
155        }
156        if self.aria_hidden {
157            write!(writer, r#" aria-hidden"#)?;
158        }
159        if let Some(field) = self.aria_invalid.as_ref() {
160            write!(writer, r#" aria-invalid="{field}""#)?;
161        }
162        if let Some(field) = self.aria_key_shortcuts.as_ref() {
163            write!(writer, r#" aria-keyshortcuts="{field}""#)?;
164        }
165        if let Some(field) = self.aria_label.as_ref() {
166            write!(writer, r#" aria-label="{field}""#)?;
167        }
168        if let Some(field) = self.aria_labelled_by_elements.as_ref() {
169            write!(writer, r#" aria-labelledby="{field}""#)?;
170        }
171        if let Some(field) = self.aria_live.as_ref() {
172            write!(writer, r#" aria-live="{field}""#)?;
173        }
174        if let Some(field) = self.aria_owns_elements.as_ref() {
175            write!(writer, r#" aria-owns="{field}""#)?;
176        }
177        if let Some(field) = self.aria_relevant.as_ref() {
178            write!(writer, r#" aria-relevant="{field}""#)?;
179        }
180        if let Some(field) = self.aria_role_description.as_ref() {
181            write!(writer, r#" aria-roledescription="{field}""#)?;
182        }
183        write!(writer, "{}", self.global_attrs)?;
184        write!(writer, "{}", self.data_map)?;
185        write!(writer, ">")?;
186        Ok(())
187    }
188    #[allow(unused_variables)]
189    fn write_closing_tag<W: std::fmt::Write>(&self, writer: &mut W) -> std::fmt::Result {
190        write!(writer, "</object>")?;
191        Ok(())
192    }
193}
194impl std::fmt::Display for Object {
195    fn fmt(&self, writer: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
196        use crate::RenderElement;
197        self.write_opening_tag(writer)?;
198        self.write_closing_tag(writer)?;
199        Ok(())
200    }
201}
202impl std::ops::Deref for Object {
203    type Target = crate::GlobalAttributes;
204    fn deref(&self) -> &Self::Target {
205        &self.global_attrs
206    }
207}
208impl std::ops::DerefMut for Object {
209    fn deref_mut(&mut self) -> &mut Self::Target {
210        &mut self.global_attrs
211    }
212}