objc2-web-kit 0.3.0

Bindings to the WebKit framework
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
use objc2_foundation::*;

use crate::*;

/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_element_node?language=objc)
#[deprecated]
pub const DOM_ELEMENT_NODE: c_uint = 1;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_attribute_node?language=objc)
#[deprecated]
pub const DOM_ATTRIBUTE_NODE: c_uint = 2;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_text_node?language=objc)
#[deprecated]
pub const DOM_TEXT_NODE: c_uint = 3;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_cdata_section_node?language=objc)
#[deprecated]
pub const DOM_CDATA_SECTION_NODE: c_uint = 4;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_entity_reference_node?language=objc)
#[deprecated]
pub const DOM_ENTITY_REFERENCE_NODE: c_uint = 5;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_entity_node?language=objc)
#[deprecated]
pub const DOM_ENTITY_NODE: c_uint = 6;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_processing_instruction_node?language=objc)
#[deprecated]
pub const DOM_PROCESSING_INSTRUCTION_NODE: c_uint = 7;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_comment_node?language=objc)
#[deprecated]
pub const DOM_COMMENT_NODE: c_uint = 8;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_node?language=objc)
#[deprecated]
pub const DOM_DOCUMENT_NODE: c_uint = 9;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_type_node?language=objc)
#[deprecated]
pub const DOM_DOCUMENT_TYPE_NODE: c_uint = 10;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_fragment_node?language=objc)
#[deprecated]
pub const DOM_DOCUMENT_FRAGMENT_NODE: c_uint = 11;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_notation_node?language=objc)
#[deprecated]
pub const DOM_NOTATION_NODE: c_uint = 12;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_position_disconnected?language=objc)
#[deprecated]
pub const DOM_DOCUMENT_POSITION_DISCONNECTED: c_uint = 0x01;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_position_preceding?language=objc)
#[deprecated]
pub const DOM_DOCUMENT_POSITION_PRECEDING: c_uint = 0x02;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_position_following?language=objc)
#[deprecated]
pub const DOM_DOCUMENT_POSITION_FOLLOWING: c_uint = 0x04;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_position_contains?language=objc)
#[deprecated]
pub const DOM_DOCUMENT_POSITION_CONTAINS: c_uint = 0x08;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_position_contained_by?language=objc)
#[deprecated]
pub const DOM_DOCUMENT_POSITION_CONTAINED_BY: c_uint = 0x10;
/// [Apple's documentation](https://developer.apple.com/documentation/webkit/dom_document_position_implementation_specific?language=objc)
#[deprecated]
pub const DOM_DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: c_uint = 0x20;

extern_class!(
    /// [Apple's documentation](https://developer.apple.com/documentation/webkit/domnode?language=objc)
    #[unsafe(super(DOMObject, WebScriptObject, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
    #[deprecated]
    pub struct DOMNode;
);

#[cfg(all(
    feature = "DOMEventTarget",
    feature = "DOMObject",
    feature = "WebScriptObject"
))]
unsafe impl DOMEventTarget for DOMNode {}

#[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
unsafe impl NSCopying for DOMNode {}

#[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
unsafe impl CopyingHelper for DOMNode {
    type Result = Self;
}

#[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
unsafe impl NSObjectProtocol for DOMNode {}

#[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
impl DOMNode {
    extern_methods!(
        #[deprecated]
        #[unsafe(method(nodeName))]
        #[unsafe(method_family = none)]
        pub unsafe fn nodeName(&self) -> Retained<NSString>;

        #[deprecated]
        #[unsafe(method(nodeValue))]
        #[unsafe(method_family = none)]
        pub unsafe fn nodeValue(&self) -> Retained<NSString>;

        /// Setter for [`nodeValue`][Self::nodeValue].
        #[deprecated]
        #[unsafe(method(setNodeValue:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setNodeValue(&self, node_value: Option<&NSString>);

        #[deprecated]
        #[unsafe(method(nodeType))]
        #[unsafe(method_family = none)]
        pub unsafe fn nodeType(&self) -> c_ushort;

        #[deprecated]
        #[unsafe(method(parentNode))]
        #[unsafe(method_family = none)]
        pub unsafe fn parentNode(&self) -> Option<Retained<DOMNode>>;

        #[cfg(feature = "DOMNodeList")]
        #[deprecated]
        #[unsafe(method(childNodes))]
        #[unsafe(method_family = none)]
        pub unsafe fn childNodes(&self) -> Option<Retained<DOMNodeList>>;

        #[deprecated]
        #[unsafe(method(firstChild))]
        #[unsafe(method_family = none)]
        pub unsafe fn firstChild(&self) -> Option<Retained<DOMNode>>;

        #[deprecated]
        #[unsafe(method(lastChild))]
        #[unsafe(method_family = none)]
        pub unsafe fn lastChild(&self) -> Option<Retained<DOMNode>>;

        #[deprecated]
        #[unsafe(method(previousSibling))]
        #[unsafe(method_family = none)]
        pub unsafe fn previousSibling(&self) -> Option<Retained<DOMNode>>;

        #[deprecated]
        #[unsafe(method(nextSibling))]
        #[unsafe(method_family = none)]
        pub unsafe fn nextSibling(&self) -> Option<Retained<DOMNode>>;

        #[cfg(feature = "DOMDocument")]
        #[deprecated]
        #[unsafe(method(ownerDocument))]
        #[unsafe(method_family = none)]
        pub unsafe fn ownerDocument(&self) -> Option<Retained<DOMDocument>>;

        #[deprecated]
        #[unsafe(method(namespaceURI))]
        #[unsafe(method_family = none)]
        pub unsafe fn namespaceURI(&self) -> Retained<NSString>;

        #[deprecated]
        #[unsafe(method(prefix))]
        #[unsafe(method_family = none)]
        pub unsafe fn prefix(&self) -> Retained<NSString>;

        /// Setter for [`prefix`][Self::prefix].
        #[deprecated]
        #[unsafe(method(setPrefix:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setPrefix(&self, prefix: Option<&NSString>);

        #[deprecated]
        #[unsafe(method(localName))]
        #[unsafe(method_family = none)]
        pub unsafe fn localName(&self) -> Retained<NSString>;

        #[cfg(feature = "DOMNamedNodeMap")]
        #[deprecated]
        #[unsafe(method(attributes))]
        #[unsafe(method_family = none)]
        pub unsafe fn attributes(&self) -> Option<Retained<DOMNamedNodeMap>>;

        #[unsafe(method(baseURI))]
        #[unsafe(method_family = none)]
        pub unsafe fn baseURI(&self) -> Retained<NSString>;

        #[unsafe(method(textContent))]
        #[unsafe(method_family = none)]
        pub unsafe fn textContent(&self) -> Retained<NSString>;

        /// Setter for [`textContent`][Self::textContent].
        #[unsafe(method(setTextContent:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setTextContent(&self, text_content: Option<&NSString>);

        #[cfg(feature = "DOMElement")]
        #[unsafe(method(parentElement))]
        #[unsafe(method_family = none)]
        pub unsafe fn parentElement(&self) -> Option<Retained<DOMElement>>;

        #[unsafe(method(isContentEditable))]
        #[unsafe(method_family = none)]
        pub unsafe fn isContentEditable(&self) -> bool;

        #[unsafe(method(insertBefore:refChild:))]
        #[unsafe(method_family = none)]
        pub unsafe fn insertBefore_refChild(
            &self,
            new_child: Option<&DOMNode>,
            ref_child: Option<&DOMNode>,
        ) -> Option<Retained<DOMNode>>;

        #[unsafe(method(replaceChild:oldChild:))]
        #[unsafe(method_family = none)]
        pub unsafe fn replaceChild_oldChild(
            &self,
            new_child: Option<&DOMNode>,
            old_child: Option<&DOMNode>,
        ) -> Option<Retained<DOMNode>>;

        #[deprecated]
        #[unsafe(method(removeChild:))]
        #[unsafe(method_family = none)]
        pub unsafe fn removeChild(&self, old_child: Option<&DOMNode>) -> Option<Retained<DOMNode>>;

        #[deprecated]
        #[unsafe(method(appendChild:))]
        #[unsafe(method_family = none)]
        pub unsafe fn appendChild(&self, new_child: Option<&DOMNode>) -> Option<Retained<DOMNode>>;

        #[deprecated]
        #[unsafe(method(hasChildNodes))]
        #[unsafe(method_family = none)]
        pub unsafe fn hasChildNodes(&self) -> bool;

        #[deprecated]
        #[unsafe(method(cloneNode:))]
        #[unsafe(method_family = none)]
        pub unsafe fn cloneNode(&self, deep: bool) -> Option<Retained<DOMNode>>;

        #[deprecated]
        #[unsafe(method(normalize))]
        #[unsafe(method_family = none)]
        pub unsafe fn normalize(&self);

        #[unsafe(method(isSupported:version:))]
        #[unsafe(method_family = none)]
        pub unsafe fn isSupported_version(
            &self,
            feature: Option<&NSString>,
            version: Option<&NSString>,
        ) -> bool;

        #[deprecated]
        #[unsafe(method(hasAttributes))]
        #[unsafe(method_family = none)]
        pub unsafe fn hasAttributes(&self) -> bool;

        #[unsafe(method(isSameNode:))]
        #[unsafe(method_family = none)]
        pub unsafe fn isSameNode(&self, other: Option<&DOMNode>) -> bool;

        #[unsafe(method(isEqualNode:))]
        #[unsafe(method_family = none)]
        pub unsafe fn isEqualNode(&self, other: Option<&DOMNode>) -> bool;

        #[unsafe(method(lookupPrefix:))]
        #[unsafe(method_family = none)]
        pub unsafe fn lookupPrefix(
            &self,
            namespace_uri: Option<&NSString>,
        ) -> Option<Retained<NSString>>;

        #[unsafe(method(lookupNamespaceURI:))]
        #[unsafe(method_family = none)]
        pub unsafe fn lookupNamespaceURI(
            &self,
            prefix: Option<&NSString>,
        ) -> Option<Retained<NSString>>;

        #[unsafe(method(isDefaultNamespace:))]
        #[unsafe(method_family = none)]
        pub unsafe fn isDefaultNamespace(&self, namespace_uri: Option<&NSString>) -> bool;

        #[unsafe(method(compareDocumentPosition:))]
        #[unsafe(method_family = none)]
        pub unsafe fn compareDocumentPosition(&self, other: Option<&DOMNode>) -> c_ushort;

        #[unsafe(method(contains:))]
        #[unsafe(method_family = none)]
        pub unsafe fn contains(&self, other: Option<&DOMNode>) -> bool;
    );
}

/// Methods declared on superclass `DOMObject`.
#[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
impl DOMNode {
    extern_methods!(
        #[deprecated]
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
    );
}

/// Methods declared on superclass `NSObject`.
#[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
impl DOMNode {
    extern_methods!(
        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}

/// DOMNodeDeprecated.
#[cfg(all(feature = "DOMObject", feature = "WebScriptObject"))]
impl DOMNode {
    extern_methods!(
        #[deprecated]
        #[unsafe(method(insertBefore::))]
        #[unsafe(method_family = none)]
        pub unsafe fn insertBefore(
            &self,
            new_child: Option<&DOMNode>,
            ref_child: Option<&DOMNode>,
        ) -> Option<Retained<DOMNode>>;

        #[deprecated]
        #[unsafe(method(replaceChild::))]
        #[unsafe(method_family = none)]
        pub unsafe fn replaceChild(
            &self,
            new_child: Option<&DOMNode>,
            old_child: Option<&DOMNode>,
        ) -> Option<Retained<DOMNode>>;

        #[deprecated]
        #[unsafe(method(isSupported::))]
        #[unsafe(method_family = none)]
        pub unsafe fn isSupported(
            &self,
            feature: Option<&NSString>,
            version: Option<&NSString>,
        ) -> bool;
    );
}