objc2_web_kit/generated/
DOMNode.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ffi::*;
4use core::ptr::NonNull;
5use objc2::__framework_prelude::*;
6use objc2_foundation::*;
7
8use crate::*;
9
10/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_element_node?language=objc)
11#[deprecated]
12pub const DOM_ELEMENT_NODE: c_uint = 1;
13/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_attribute_node?language=objc)
14#[deprecated]
15pub const DOM_ATTRIBUTE_NODE: c_uint = 2;
16/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_text_node?language=objc)
17#[deprecated]
18pub const DOM_TEXT_NODE: c_uint = 3;
19/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_cdata_section_node?language=objc)
20#[deprecated]
21pub const DOM_CDATA_SECTION_NODE: c_uint = 4;
22/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_entity_reference_node?language=objc)
23#[deprecated]
24pub const DOM_ENTITY_REFERENCE_NODE: c_uint = 5;
25/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_entity_node?language=objc)
26#[deprecated]
27pub const DOM_ENTITY_NODE: c_uint = 6;
28/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_processing_instruction_node?language=objc)
29#[deprecated]
30pub const DOM_PROCESSING_INSTRUCTION_NODE: c_uint = 7;
31/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_comment_node?language=objc)
32#[deprecated]
33pub const DOM_COMMENT_NODE: c_uint = 8;
34/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_node?language=objc)
35#[deprecated]
36pub const DOM_DOCUMENT_NODE: c_uint = 9;
37/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_type_node?language=objc)
38#[deprecated]
39pub const DOM_DOCUMENT_TYPE_NODE: c_uint = 10;
40/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_fragment_node?language=objc)
41#[deprecated]
42pub const DOM_DOCUMENT_FRAGMENT_NODE: c_uint = 11;
43/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_notation_node?language=objc)
44#[deprecated]
45pub const DOM_NOTATION_NODE: c_uint = 12;
46/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_position_disconnected?language=objc)
47#[deprecated]
48pub const DOM_DOCUMENT_POSITION_DISCONNECTED: c_uint = 0x01;
49/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_position_preceding?language=objc)
50#[deprecated]
51pub const DOM_DOCUMENT_POSITION_PRECEDING: c_uint = 0x02;
52/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_position_following?language=objc)
53#[deprecated]
54pub const DOM_DOCUMENT_POSITION_FOLLOWING: c_uint = 0x04;
55/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_position_contains?language=objc)
56#[deprecated]
57pub const DOM_DOCUMENT_POSITION_CONTAINS: c_uint = 0x08;
58/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_position_contained_by?language=objc)
59#[deprecated]
60pub const DOM_DOCUMENT_POSITION_CONTAINED_BY: c_uint = 0x10;
61/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_position_implementation_specific?language=objc)
62#[deprecated]
63pub const DOM_DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: c_uint = 0x20;
64
65extern_class!(
66    /// [Apple's documentation](https://developer.apple.com/documentation/webkit/domnode?language=objc)
67    #[unsafe(super(DOMObject, WebScriptObject, NSObject))]
68    #[derive(Debug, PartialEq, Eq, Hash)]
69    #[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
70    #[deprecated]
71    pub struct DOMNode;
72);
73
74#[cfg(all(
75    feature = "DOMEventTarget",
76    feature = "DOMObject",
77    feature = "WebScriptObject"
78))]
79extern_conformance!(
80    unsafe impl DOMEventTarget for DOMNode {}
81);
82
83#[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
84extern_conformance!(
85    unsafe impl NSCopying for DOMNode {}
86);
87
88#[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
89unsafe impl CopyingHelper for DOMNode {
90    type Result = Self;
91}
92
93#[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
94extern_conformance!(
95    unsafe impl NSObjectProtocol for DOMNode {}
96);
97
98#[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
99impl DOMNode {
100    extern_methods!(
101        #[deprecated]
102        #[unsafe(method(nodeName))]
103        #[unsafe(method_family = none)]
104        pub unsafe fn nodeName(&self) -> Retained<NSString>;
105
106        #[deprecated]
107        #[unsafe(method(nodeValue))]
108        #[unsafe(method_family = none)]
109        pub unsafe fn nodeValue(&self) -> Retained<NSString>;
110
111        /// Setter for [`nodeValue`][Self::nodeValue].
112        #[deprecated]
113        #[unsafe(method(setNodeValue:))]
114        #[unsafe(method_family = none)]
115        pub unsafe fn setNodeValue(&self, node_value: Option<&NSString>);
116
117        #[deprecated]
118        #[unsafe(method(nodeType))]
119        #[unsafe(method_family = none)]
120        pub unsafe fn nodeType(&self) -> c_ushort;
121
122        #[deprecated]
123        #[unsafe(method(parentNode))]
124        #[unsafe(method_family = none)]
125        pub unsafe fn parentNode(&self) -> Option<Retained<DOMNode>>;
126
127        #[cfg(feature = "DOMNodeList")]
128        #[deprecated]
129        #[unsafe(method(childNodes))]
130        #[unsafe(method_family = none)]
131        pub unsafe fn childNodes(&self) -> Option<Retained<DOMNodeList>>;
132
133        #[deprecated]
134        #[unsafe(method(firstChild))]
135        #[unsafe(method_family = none)]
136        pub unsafe fn firstChild(&self) -> Option<Retained<DOMNode>>;
137
138        #[deprecated]
139        #[unsafe(method(lastChild))]
140        #[unsafe(method_family = none)]
141        pub unsafe fn lastChild(&self) -> Option<Retained<DOMNode>>;
142
143        #[deprecated]
144        #[unsafe(method(previousSibling))]
145        #[unsafe(method_family = none)]
146        pub unsafe fn previousSibling(&self) -> Option<Retained<DOMNode>>;
147
148        #[deprecated]
149        #[unsafe(method(nextSibling))]
150        #[unsafe(method_family = none)]
151        pub unsafe fn nextSibling(&self) -> Option<Retained<DOMNode>>;
152
153        #[cfg(feature = "DOMDocument")]
154        #[deprecated]
155        #[unsafe(method(ownerDocument))]
156        #[unsafe(method_family = none)]
157        pub unsafe fn ownerDocument(&self) -> Option<Retained<DOMDocument>>;
158
159        #[deprecated]
160        #[unsafe(method(namespaceURI))]
161        #[unsafe(method_family = none)]
162        pub unsafe fn namespaceURI(&self) -> Retained<NSString>;
163
164        #[deprecated]
165        #[unsafe(method(prefix))]
166        #[unsafe(method_family = none)]
167        pub unsafe fn prefix(&self) -> Retained<NSString>;
168
169        /// Setter for [`prefix`][Self::prefix].
170        #[deprecated]
171        #[unsafe(method(setPrefix:))]
172        #[unsafe(method_family = none)]
173        pub unsafe fn setPrefix(&self, prefix: Option<&NSString>);
174
175        #[deprecated]
176        #[unsafe(method(localName))]
177        #[unsafe(method_family = none)]
178        pub unsafe fn localName(&self) -> Retained<NSString>;
179
180        #[cfg(feature = "DOMNamedNodeMap")]
181        #[deprecated]
182        #[unsafe(method(attributes))]
183        #[unsafe(method_family = none)]
184        pub unsafe fn attributes(&self) -> Option<Retained<DOMNamedNodeMap>>;
185
186        #[unsafe(method(baseURI))]
187        #[unsafe(method_family = none)]
188        pub unsafe fn baseURI(&self) -> Retained<NSString>;
189
190        #[unsafe(method(textContent))]
191        #[unsafe(method_family = none)]
192        pub unsafe fn textContent(&self) -> Retained<NSString>;
193
194        /// Setter for [`textContent`][Self::textContent].
195        #[unsafe(method(setTextContent:))]
196        #[unsafe(method_family = none)]
197        pub unsafe fn setTextContent(&self, text_content: Option<&NSString>);
198
199        #[cfg(feature = "DOMElement")]
200        #[unsafe(method(parentElement))]
201        #[unsafe(method_family = none)]
202        pub unsafe fn parentElement(&self) -> Option<Retained<DOMElement>>;
203
204        #[unsafe(method(isContentEditable))]
205        #[unsafe(method_family = none)]
206        pub unsafe fn isContentEditable(&self) -> bool;
207
208        #[unsafe(method(insertBefore:refChild:))]
209        #[unsafe(method_family = none)]
210        pub unsafe fn insertBefore_refChild(
211            &self,
212            new_child: Option<&DOMNode>,
213            ref_child: Option<&DOMNode>,
214        ) -> Option<Retained<DOMNode>>;
215
216        #[unsafe(method(replaceChild:oldChild:))]
217        #[unsafe(method_family = none)]
218        pub unsafe fn replaceChild_oldChild(
219            &self,
220            new_child: Option<&DOMNode>,
221            old_child: Option<&DOMNode>,
222        ) -> Option<Retained<DOMNode>>;
223
224        #[deprecated]
225        #[unsafe(method(removeChild:))]
226        #[unsafe(method_family = none)]
227        pub unsafe fn removeChild(&self, old_child: Option<&DOMNode>) -> Option<Retained<DOMNode>>;
228
229        #[deprecated]
230        #[unsafe(method(appendChild:))]
231        #[unsafe(method_family = none)]
232        pub unsafe fn appendChild(&self, new_child: Option<&DOMNode>) -> Option<Retained<DOMNode>>;
233
234        #[deprecated]
235        #[unsafe(method(hasChildNodes))]
236        #[unsafe(method_family = none)]
237        pub unsafe fn hasChildNodes(&self) -> bool;
238
239        #[deprecated]
240        #[unsafe(method(cloneNode:))]
241        #[unsafe(method_family = none)]
242        pub unsafe fn cloneNode(&self, deep: bool) -> Option<Retained<DOMNode>>;
243
244        #[deprecated]
245        #[unsafe(method(normalize))]
246        #[unsafe(method_family = none)]
247        pub unsafe fn normalize(&self);
248
249        #[unsafe(method(isSupported:version:))]
250        #[unsafe(method_family = none)]
251        pub unsafe fn isSupported_version(
252            &self,
253            feature: Option<&NSString>,
254            version: Option<&NSString>,
255        ) -> bool;
256
257        #[deprecated]
258        #[unsafe(method(hasAttributes))]
259        #[unsafe(method_family = none)]
260        pub unsafe fn hasAttributes(&self) -> bool;
261
262        #[unsafe(method(isSameNode:))]
263        #[unsafe(method_family = none)]
264        pub unsafe fn isSameNode(&self, other: Option<&DOMNode>) -> bool;
265
266        #[unsafe(method(isEqualNode:))]
267        #[unsafe(method_family = none)]
268        pub unsafe fn isEqualNode(&self, other: Option<&DOMNode>) -> bool;
269
270        #[unsafe(method(lookupPrefix:))]
271        #[unsafe(method_family = none)]
272        pub unsafe fn lookupPrefix(
273            &self,
274            namespace_uri: Option<&NSString>,
275        ) -> Option<Retained<NSString>>;
276
277        #[unsafe(method(lookupNamespaceURI:))]
278        #[unsafe(method_family = none)]
279        pub unsafe fn lookupNamespaceURI(
280            &self,
281            prefix: Option<&NSString>,
282        ) -> Option<Retained<NSString>>;
283
284        #[unsafe(method(isDefaultNamespace:))]
285        #[unsafe(method_family = none)]
286        pub unsafe fn isDefaultNamespace(&self, namespace_uri: Option<&NSString>) -> bool;
287
288        #[unsafe(method(compareDocumentPosition:))]
289        #[unsafe(method_family = none)]
290        pub unsafe fn compareDocumentPosition(&self, other: Option<&DOMNode>) -> c_ushort;
291
292        #[unsafe(method(contains:))]
293        #[unsafe(method_family = none)]
294        pub unsafe fn contains(&self, other: Option<&DOMNode>) -> bool;
295    );
296}
297
298/// Methods declared on superclass `DOMObject`.
299#[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
300impl DOMNode {
301    extern_methods!(
302        #[deprecated]
303        #[unsafe(method(init))]
304        #[unsafe(method_family = init)]
305        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
306    );
307}
308
309/// Methods declared on superclass `NSObject`.
310#[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
311impl DOMNode {
312    extern_methods!(
313        #[unsafe(method(new))]
314        #[unsafe(method_family = new)]
315        pub unsafe fn new() -> Retained<Self>;
316    );
317}
318
319/// DOMNodeDeprecated.
320#[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
321impl DOMNode {
322    extern_methods!(
323        #[deprecated]
324        #[unsafe(method(insertBefore::))]
325        #[unsafe(method_family = none)]
326        pub unsafe fn insertBefore(
327            &self,
328            new_child: Option<&DOMNode>,
329            ref_child: Option<&DOMNode>,
330        ) -> Option<Retained<DOMNode>>;
331
332        #[deprecated]
333        #[unsafe(method(replaceChild::))]
334        #[unsafe(method_family = none)]
335        pub unsafe fn replaceChild(
336            &self,
337            new_child: Option<&DOMNode>,
338            old_child: Option<&DOMNode>,
339        ) -> Option<Retained<DOMNode>>;
340
341        #[deprecated]
342        #[unsafe(method(isSupported::))]
343        #[unsafe(method_family = none)]
344        pub unsafe fn isSupported(
345            &self,
346            feature: Option<&NSString>,
347            version: Option<&NSString>,
348        ) -> bool;
349    );
350}