Struct DOMHTMLDocument

#[repr(C)]
pub struct DOMHTMLDocument { /* private fields */ }

👎Deprecated

Available on crate features DOMDocument and DOMHTMLDocument and DOMNode and DOMObject and WebScriptObject only.

Apple’s documentation

Implementations

impl DOMHTMLDocument

DOMHTMLDocumentExtensions.

pub unsafe fn createDocumentFragmentWithMarkupString_baseURL( &self, markup_string: Option<&NSString>, base_url: Option<&NSURL>, ) -> Option<Retained<DOMDocumentFragment>>

Available on crate features DOMExtensions and DOMDocumentFragment only.

pub unsafe fn createDocumentFragmentWithText( &self, text: Option<&NSString>, ) -> Option<Retained<DOMDocumentFragment>>

Available on crate features DOMExtensions and DOMDocumentFragment only.

impl DOMHTMLDocument

pub unsafe fn embeds(&self) -> Option<Retained<DOMHTMLCollection>>

Available on crate feature DOMHTMLCollection only.

pub unsafe fn plugins(&self) -> Option<Retained<DOMHTMLCollection>>

Available on crate feature DOMHTMLCollection only.

pub unsafe fn scripts(&self) -> Option<Retained<DOMHTMLCollection>>

Available on crate feature DOMHTMLCollection only.

pub unsafe fn width(&self) -> c_int

pub unsafe fn height(&self) -> c_int

pub unsafe fn dir(&self) -> Retained<NSString>

pub unsafe fn setDir(&self, dir: Option<&NSString>)

Setter for dir.

pub unsafe fn designMode(&self) -> Retained<NSString>

pub unsafe fn setDesignMode(&self, design_mode: Option<&NSString>)

Setter for designMode.

pub unsafe fn compatMode(&self) -> Retained<NSString>

pub unsafe fn bgColor(&self) -> Retained<NSString>

pub unsafe fn setBgColor(&self, bg_color: Option<&NSString>)

Setter for bgColor.

pub unsafe fn fgColor(&self) -> Retained<NSString>

pub unsafe fn setFgColor(&self, fg_color: Option<&NSString>)

Setter for fgColor.

pub unsafe fn alinkColor(&self) -> Retained<NSString>

pub unsafe fn setAlinkColor(&self, alink_color: Option<&NSString>)

Setter for alinkColor.

pub unsafe fn linkColor(&self) -> Retained<NSString>

pub unsafe fn setLinkColor(&self, link_color: Option<&NSString>)

Setter for linkColor.

pub unsafe fn vlinkColor(&self) -> Retained<NSString>

pub unsafe fn setVlinkColor(&self, vlink_color: Option<&NSString>)

Setter for vlinkColor.

pub unsafe fn open(&self)

👎Deprecated

pub unsafe fn close(&self)

👎Deprecated

pub unsafe fn write(&self, text: Option<&NSString>)

👎Deprecated

pub unsafe fn writeln(&self, text: Option<&NSString>)

👎Deprecated

pub unsafe fn clear(&self)

pub unsafe fn captureEvents(&self)

pub unsafe fn releaseEvents(&self)

impl DOMHTMLDocument

Methods declared on superclass DOMObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

👎Deprecated

impl DOMHTMLDocument

Methods declared on superclass NSObject.

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = DOMDocument>

pub unsafe fn doctype(&self) -> Option<Retained<DOMDocumentType>>

👎Deprecated

Available on crate feature DOMDocumentType only.

pub unsafe fn implementation(&self) -> Option<Retained<DOMImplementation>>

👎Deprecated

Available on crate feature DOMImplementation only.

pub unsafe fn documentElement(&self) -> Option<Retained<DOMElement>>

👎Deprecated

Available on crate feature DOMElement only.

pub unsafe fn inputEncoding(&self) -> Retained<NSString>

pub unsafe fn xmlEncoding(&self) -> Retained<NSString>

pub unsafe fn xmlVersion(&self) -> Retained<NSString>

pub unsafe fn setXmlVersion(&self, xml_version: Option<&NSString>)

Setter for xmlVersion.

pub unsafe fn xmlStandalone(&self) -> bool

pub unsafe fn setXmlStandalone(&self, xml_standalone: bool)

Setter for xmlStandalone.

pub unsafe fn documentURI(&self) -> Retained<NSString>

pub unsafe fn setDocumentURI(&self, document_uri: Option<&NSString>)

Setter for documentURI.

pub unsafe fn defaultView(&self) -> Option<Retained<DOMAbstractView>>

👎Deprecated

Available on crate feature DOMAbstractView only.

pub unsafe fn styleSheets(&self) -> Option<Retained<DOMStyleSheetList>>

👎Deprecated

Available on crate feature DOMStyleSheetList only.

pub unsafe fn title(&self) -> Retained<NSString>

👎Deprecated

pub unsafe fn setTitle(&self, title: Option<&NSString>)

👎Deprecated

Setter for title.

pub unsafe fn referrer(&self) -> Retained<NSString>

👎Deprecated

pub unsafe fn domain(&self) -> Retained<NSString>

👎Deprecated

pub unsafe fn URL(&self) -> Retained<NSString>

👎Deprecated

pub unsafe fn cookie(&self) -> Retained<NSString>

👎Deprecated

pub unsafe fn setCookie(&self, cookie: Option<&NSString>)

👎Deprecated

Setter for cookie.

pub unsafe fn body(&self) -> Option<Retained<DOMHTMLElement>>

👎Deprecated

Available on crate features DOMElement and DOMHTMLElement only.

pub unsafe fn setBody(&self, body: Option<&DOMHTMLElement>)

👎Deprecated

Available on crate features DOMElement and DOMHTMLElement only.

Setter for body.

pub unsafe fn images(&self) -> Option<Retained<DOMHTMLCollection>>

👎Deprecated

Available on crate feature DOMHTMLCollection only.

pub unsafe fn applets(&self) -> Option<Retained<DOMHTMLCollection>>

👎Deprecated

Available on crate feature DOMHTMLCollection only.

pub unsafe fn links(&self) -> Option<Retained<DOMHTMLCollection>>

👎Deprecated

Available on crate feature DOMHTMLCollection only.

pub unsafe fn forms(&self) -> Option<Retained<DOMHTMLCollection>>

👎Deprecated

Available on crate feature DOMHTMLCollection only.

pub unsafe fn anchors(&self) -> Option<Retained<DOMHTMLCollection>>

👎Deprecated

Available on crate feature DOMHTMLCollection only.

pub unsafe fn lastModified(&self) -> Retained<NSString>

pub unsafe fn charset(&self) -> Retained<NSString>

pub unsafe fn setCharset(&self, charset: Option<&NSString>)

Setter for charset.

pub unsafe fn defaultCharset(&self) -> Retained<NSString>

pub unsafe fn readyState(&self) -> Retained<NSString>

pub unsafe fn characterSet(&self) -> Retained<NSString>

pub unsafe fn preferredStylesheetSet(&self) -> Retained<NSString>

pub unsafe fn selectedStylesheetSet(&self) -> Retained<NSString>

pub unsafe fn setSelectedStylesheetSet( &self, selected_stylesheet_set: Option<&NSString>, )

Setter for selectedStylesheetSet.

pub unsafe fn activeElement(&self) -> Option<Retained<DOMElement>>

Available on crate feature DOMElement only.

pub unsafe fn createElement( &self, tag_name: Option<&NSString>, ) -> Option<Retained<DOMElement>>

👎Deprecated

Available on crate feature DOMElement only.

pub unsafe fn createDocumentFragment( &self, ) -> Option<Retained<DOMDocumentFragment>>

👎Deprecated

Available on crate feature DOMDocumentFragment only.

pub unsafe fn createTextNode( &self, data: Option<&NSString>, ) -> Option<Retained<DOMText>>

👎Deprecated

Available on crate features DOMCharacterData and DOMText only.

pub unsafe fn createComment( &self, data: Option<&NSString>, ) -> Option<Retained<DOMComment>>

👎Deprecated

Available on crate features DOMCharacterData and DOMComment only.

pub unsafe fn createCDATASection( &self, data: Option<&NSString>, ) -> Option<Retained<DOMCDATASection>>

👎Deprecated

Available on crate features DOMCDATASection and DOMCharacterData and DOMText only.

pub unsafe fn createProcessingInstruction_data( &self, target: Option<&NSString>, data: Option<&NSString>, ) -> Option<Retained<DOMProcessingInstruction>>

Available on crate features DOMCharacterData and DOMProcessingInstruction only.

pub unsafe fn createAttribute( &self, name: Option<&NSString>, ) -> Option<Retained<DOMAttr>>

👎Deprecated

Available on crate feature DOMAttr only.

pub unsafe fn createEntityReference( &self, name: Option<&NSString>, ) -> Option<Retained<DOMEntityReference>>

👎Deprecated

Available on crate feature DOMEntityReference only.

pub unsafe fn getElementsByTagName( &self, tagname: Option<&NSString>, ) -> Option<Retained<DOMNodeList>>

👎Deprecated

Available on crate feature DOMNodeList only.

pub unsafe fn importNode_deep( &self, imported_node: Option<&DOMNode>, deep: bool, ) -> Option<Retained<DOMNode>>

pub unsafe fn createElementNS_qualifiedName( &self, namespace_uri: Option<&NSString>, qualified_name: Option<&NSString>, ) -> Option<Retained<DOMElement>>

Available on crate feature DOMElement only.

pub unsafe fn createAttributeNS_qualifiedName( &self, namespace_uri: Option<&NSString>, qualified_name: Option<&NSString>, ) -> Option<Retained<DOMAttr>>

Available on crate feature DOMAttr only.

pub unsafe fn getElementsByTagNameNS_localName( &self, namespace_uri: Option<&NSString>, local_name: Option<&NSString>, ) -> Option<Retained<DOMNodeList>>

Available on crate feature DOMNodeList only.

pub unsafe fn adoptNode( &self, source: Option<&DOMNode>, ) -> Option<Retained<DOMNode>>

pub unsafe fn createEvent( &self, event_type: Option<&NSString>, ) -> Option<Retained<DOMEvent>>

👎Deprecated

Available on crate feature DOMEvent only.

pub unsafe fn createRange(&self) -> Option<Retained<DOMRange>>

👎Deprecated

Available on crate feature DOMRange only.

pub unsafe fn createNodeIterator_whatToShow_filter_expandEntityReferences( &self, root: Option<&DOMNode>, what_to_show: c_uint, filter: Option<&ProtocolObject<dyn DOMNodeFilter>>, expand_entity_references: bool, ) -> Option<Retained<DOMNodeIterator>>

Available on crate features DOMNodeFilter and DOMNodeIterator only.

pub unsafe fn createTreeWalker_whatToShow_filter_expandEntityReferences( &self, root: Option<&DOMNode>, what_to_show: c_uint, filter: Option<&ProtocolObject<dyn DOMNodeFilter>>, expand_entity_references: bool, ) -> Option<Retained<DOMTreeWalker>>

Available on crate features DOMNodeFilter and DOMTreeWalker only.

pub unsafe fn getOverrideStyle_pseudoElement( &self, element: Option<&DOMElement>, pseudo_element: Option<&NSString>, ) -> Option<Retained<DOMCSSStyleDeclaration>>

Available on crate features DOMCSSStyleDeclaration and DOMElement only.

pub unsafe fn createExpression_resolver( &self, expression: Option<&NSString>, resolver: Option<&ProtocolObject<dyn DOMXPathNSResolver>>, ) -> Option<Retained<DOMXPathExpression>>

Available on crate features DOMXPathExpression and DOMXPathNSResolver only.

pub unsafe fn createNSResolver( &self, node_resolver: Option<&DOMNode>, ) -> Option<Retained<ProtocolObject<dyn DOMXPathNSResolver>>>

Available on crate feature DOMXPathNSResolver only.

pub unsafe fn evaluate_contextNode_resolver_type_inResult( &self, expression: Option<&NSString>, context_node: Option<&DOMNode>, resolver: Option<&ProtocolObject<dyn DOMXPathNSResolver>>, type: c_ushort, in_result: Option<&DOMXPathResult>, ) -> Option<Retained<DOMXPathResult>>

Available on crate features DOMXPathNSResolver and DOMXPathResult only.

pub unsafe fn execCommand_userInterface_value( &self, command: Option<&NSString>, user_interface: bool, value: Option<&NSString>, ) -> bool

pub unsafe fn execCommand_userInterface( &self, command: Option<&NSString>, user_interface: bool, ) -> bool

pub unsafe fn execCommand(&self, command: Option<&NSString>) -> bool

pub unsafe fn queryCommandEnabled(&self, command: Option<&NSString>) -> bool

pub unsafe fn queryCommandIndeterm(&self, command: Option<&NSString>) -> bool

pub unsafe fn queryCommandState(&self, command: Option<&NSString>) -> bool

pub unsafe fn queryCommandSupported(&self, command: Option<&NSString>) -> bool

pub unsafe fn queryCommandValue( &self, command: Option<&NSString>, ) -> Option<Retained<NSString>>

pub unsafe fn getElementsByName( &self, element_name: Option<&NSString>, ) -> Option<Retained<DOMNodeList>>

👎Deprecated

Available on crate feature DOMNodeList only.

pub unsafe fn elementFromPoint_y( &self, x: c_int, y: c_int, ) -> Option<Retained<DOMElement>>

Available on crate feature DOMElement only.

pub unsafe fn createCSSStyleDeclaration( &self, ) -> Option<Retained<DOMCSSStyleDeclaration>>

Available on crate feature DOMCSSStyleDeclaration only.

pub unsafe fn getComputedStyle_pseudoElement( &self, element: Option<&DOMElement>, pseudo_element: Option<&NSString>, ) -> Option<Retained<DOMCSSStyleDeclaration>>

Available on crate features DOMCSSStyleDeclaration and DOMElement only.

pub unsafe fn getMatchedCSSRules_pseudoElement( &self, element: Option<&DOMElement>, pseudo_element: Option<&NSString>, ) -> Option<Retained<DOMCSSRuleList>>

Available on crate features DOMCSSRuleList and DOMElement only.

pub unsafe fn getMatchedCSSRules_pseudoElement_authorOnly( &self, element: Option<&DOMElement>, pseudo_element: Option<&NSString>, author_only: bool, ) -> Option<Retained<DOMCSSRuleList>>

Available on crate features DOMCSSRuleList and DOMElement only.

pub unsafe fn getElementsByClassName( &self, class_names: Option<&NSString>, ) -> Option<Retained<DOMNodeList>>

Available on crate feature DOMNodeList only.

pub unsafe fn hasFocus(&self) -> bool

pub unsafe fn webkitCancelFullScreen(&self)

pub unsafe fn getElementById( &self, element_id: Option<&NSString>, ) -> Option<Retained<DOMElement>>

👎Deprecated

Available on crate feature DOMElement only.

pub unsafe fn querySelector( &self, selectors: Option<&NSString>, ) -> Option<Retained<DOMElement>>

Available on crate feature DOMElement only.

pub unsafe fn querySelectorAll( &self, selectors: Option<&NSString>, ) -> Option<Retained<DOMNodeList>>

Available on crate feature DOMNodeList only.

pub unsafe fn createProcessingInstruction( &self, target: Option<&NSString>, data: Option<&NSString>, ) -> Option<Retained<DOMProcessingInstruction>>

👎Deprecated

Available on crate features DOMCharacterData and DOMProcessingInstruction only.

pub unsafe fn importNode( &self, imported_node: Option<&DOMNode>, deep: bool, ) -> Option<Retained<DOMNode>>

👎Deprecated

pub unsafe fn createElementNS( &self, namespace_uri: Option<&NSString>, qualified_name: Option<&NSString>, ) -> Option<Retained<DOMElement>>

👎Deprecated

Available on crate feature DOMElement only.

pub unsafe fn createAttributeNS( &self, namespace_uri: Option<&NSString>, qualified_name: Option<&NSString>, ) -> Option<Retained<DOMAttr>>

👎Deprecated

Available on crate feature DOMAttr only.

pub unsafe fn getElementsByTagNameNS( &self, namespace_uri: Option<&NSString>, local_name: Option<&NSString>, ) -> Option<Retained<DOMNodeList>>

👎Deprecated

Available on crate feature DOMNodeList only.

pub unsafe fn createNodeIterator( &self, root: Option<&DOMNode>, what_to_show: c_uint, filter: Option<&ProtocolObject<dyn DOMNodeFilter>>, expand_entity_references: bool, ) -> Option<Retained<DOMNodeIterator>>

👎Deprecated

Available on crate features DOMNodeFilter and DOMNodeIterator only.

pub unsafe fn createTreeWalker( &self, root: Option<&DOMNode>, what_to_show: c_uint, filter: Option<&ProtocolObject<dyn DOMNodeFilter>>, expand_entity_references: bool, ) -> Option<Retained<DOMTreeWalker>>

👎Deprecated

Available on crate features DOMNodeFilter and DOMTreeWalker only.

pub unsafe fn getOverrideStyle( &self, element: Option<&DOMElement>, pseudo_element: Option<&NSString>, ) -> Option<Retained<DOMCSSStyleDeclaration>>

👎Deprecated

Available on crate features DOMCSSStyleDeclaration and DOMElement only.

pub unsafe fn createExpression( &self, expression: Option<&NSString>, resolver: Option<&ProtocolObject<dyn DOMXPathNSResolver>>, ) -> Option<Retained<DOMXPathExpression>>

👎Deprecated

Available on crate features DOMXPathExpression and DOMXPathNSResolver only.

pub unsafe fn evaluate( &self, expression: Option<&NSString>, context_node: Option<&DOMNode>, resolver: Option<&ProtocolObject<dyn DOMXPathNSResolver>>, type: c_ushort, in_result: Option<&DOMXPathResult>, ) -> Option<Retained<DOMXPathResult>>

👎Deprecated

Available on crate features DOMXPathNSResolver and DOMXPathResult only.

pub unsafe fn getComputedStyle( &self, element: Option<&DOMElement>, pseudo_element: Option<&NSString>, ) -> Option<Retained<DOMCSSStyleDeclaration>>

👎Deprecated

Available on crate features DOMCSSStyleDeclaration and DOMElement only.

pub unsafe fn webFrame(&self) -> Option<Retained<WebFrame>>

👎Deprecated

Available on crate features WebDOMOperations and WebFrame only.

The frame of the DOM document.

pub unsafe fn URLWithAttributeString( &self, string: Option<&NSString>, ) -> Option<Retained<NSURL>>

👎Deprecated

Available on crate feature WebDOMOperations only.

Constructs a URL given an attribute string.

This method constructs a URL given an attribute string just as WebKit does. An attribute string is the value of an attribute of an element such as the href attribute on the DOMHTMLAnchorElement class. This method is only applicable to attributes that refer to URLs.

Methods from Deref<Target = DOMNode>

pub unsafe fn boundingBox(&self) -> NSRect

Available on crate feature DOMExtensions only.

pub unsafe fn lineBoxRects(&self) -> Option<Retained<NSArray>>

Available on crate feature DOMExtensions only.

pub unsafe fn nodeName(&self) -> Retained<NSString>

👎Deprecated

pub unsafe fn nodeValue(&self) -> Retained<NSString>

👎Deprecated

pub unsafe fn setNodeValue(&self, node_value: Option<&NSString>)

👎Deprecated

Setter for nodeValue.

pub unsafe fn nodeType(&self) -> c_ushort

👎Deprecated

pub unsafe fn parentNode(&self) -> Option<Retained<DOMNode>>

👎Deprecated

pub unsafe fn childNodes(&self) -> Option<Retained<DOMNodeList>>

👎Deprecated

Available on crate feature DOMNodeList only.

pub unsafe fn firstChild(&self) -> Option<Retained<DOMNode>>

👎Deprecated

pub unsafe fn lastChild(&self) -> Option<Retained<DOMNode>>

👎Deprecated

pub unsafe fn previousSibling(&self) -> Option<Retained<DOMNode>>

👎Deprecated

pub unsafe fn nextSibling(&self) -> Option<Retained<DOMNode>>

👎Deprecated

pub unsafe fn ownerDocument(&self) -> Option<Retained<DOMDocument>>

👎Deprecated

pub unsafe fn namespaceURI(&self) -> Retained<NSString>

👎Deprecated

pub unsafe fn prefix(&self) -> Retained<NSString>

👎Deprecated

pub unsafe fn setPrefix(&self, prefix: Option<&NSString>)

👎Deprecated

Setter for prefix.

pub unsafe fn localName(&self) -> Retained<NSString>

👎Deprecated

pub unsafe fn attributes(&self) -> Option<Retained<DOMNamedNodeMap>>

👎Deprecated

Available on crate feature DOMNamedNodeMap only.

pub unsafe fn baseURI(&self) -> Retained<NSString>

pub unsafe fn textContent(&self) -> Retained<NSString>

pub unsafe fn setTextContent(&self, text_content: Option<&NSString>)

Setter for textContent.

pub unsafe fn parentElement(&self) -> Option<Retained<DOMElement>>

Available on crate feature DOMElement only.

pub unsafe fn isContentEditable(&self) -> bool

pub unsafe fn insertBefore_refChild( &self, new_child: Option<&DOMNode>, ref_child: Option<&DOMNode>, ) -> Option<Retained<DOMNode>>

pub unsafe fn replaceChild_oldChild( &self, new_child: Option<&DOMNode>, old_child: Option<&DOMNode>, ) -> Option<Retained<DOMNode>>

pub unsafe fn removeChild( &self, old_child: Option<&DOMNode>, ) -> Option<Retained<DOMNode>>

👎Deprecated

pub unsafe fn appendChild( &self, new_child: Option<&DOMNode>, ) -> Option<Retained<DOMNode>>

👎Deprecated

pub unsafe fn hasChildNodes(&self) -> bool

👎Deprecated

pub unsafe fn cloneNode(&self, deep: bool) -> Option<Retained<DOMNode>>

👎Deprecated

pub unsafe fn normalize(&self)

👎Deprecated

pub unsafe fn isSupported_version( &self, feature: Option<&NSString>, version: Option<&NSString>, ) -> bool

pub unsafe fn hasAttributes(&self) -> bool

👎Deprecated

pub unsafe fn isSameNode(&self, other: Option<&DOMNode>) -> bool

pub unsafe fn isEqualNode(&self, other: Option<&DOMNode>) -> bool

pub unsafe fn lookupPrefix( &self, namespace_uri: Option<&NSString>, ) -> Option<Retained<NSString>>

pub unsafe fn lookupNamespaceURI( &self, prefix: Option<&NSString>, ) -> Option<Retained<NSString>>

pub unsafe fn isDefaultNamespace( &self, namespace_uri: Option<&NSString>, ) -> bool

pub unsafe fn compareDocumentPosition( &self, other: Option<&DOMNode>, ) -> c_ushort

pub unsafe fn contains(&self, other: Option<&DOMNode>) -> bool

pub unsafe fn insertBefore( &self, new_child: Option<&DOMNode>, ref_child: Option<&DOMNode>, ) -> Option<Retained<DOMNode>>

👎Deprecated

pub unsafe fn replaceChild( &self, new_child: Option<&DOMNode>, old_child: Option<&DOMNode>, ) -> Option<Retained<DOMNode>>

👎Deprecated

pub unsafe fn isSupported( &self, feature: Option<&NSString>, version: Option<&NSString>, ) -> bool

👎Deprecated

pub unsafe fn webArchive(&self) -> Option<Retained<WebArchive>>

👎Deprecated

Available on crate features WebDOMOperations and WebArchive only.

A WebArchive representing the node and the children of the node.

Methods from Deref<Target = DOMObject>

pub unsafe fn sheet(&self) -> Option<Retained<DOMStyleSheet>>

Available on crate feature DOMStyleSheet only.

Methods from Deref<Target = WebScriptObject>

pub unsafe fn callWebScriptMethod_withArguments( &self, name: Option<&NSString>, arguments: Option<&NSArray>, ) -> Option<Retained<AnyObject>>

👎Deprecated

Parameter name: The name of the method to call in the script environment.

Parameter arguments: The arguments to pass to the script environment.

Calls the specified method in the script environment using the specified arguments.

Returns: Returns the result of calling the script method. Returns WebUndefined when an exception is thrown in the script environment.

pub unsafe fn evaluateWebScript( &self, script: Option<&NSString>, ) -> Option<Retained<AnyObject>>

👎Deprecated

Parameter script: The script to execute in the target script environment.

The script will be executed in the target script environment. The format of the script is dependent of the target script environment.

Returns: Returns the result of evaluating the script in the script environment. Returns WebUndefined when an exception is thrown in the script environment.

pub unsafe fn removeWebScriptKey(&self, name: Option<&NSString>)

👎Deprecated

Parameter name: The name of the property to remove.

Removes the property from the object in the script environment.

pub unsafe fn stringRepresentation(&self) -> Option<Retained<NSString>>

👎Deprecated

Converts the target object to a string representation. The coercion of non string objects type is dependent on the script environment.

Returns: Returns the string representation of the object.

pub unsafe fn webScriptValueAtIndex( &self, index: c_uint, ) -> Option<Retained<AnyObject>>

👎Deprecated

Parameter index: The index of the property to return.

Gets the value of the property at the specified index.

Returns: The value of the property. Returns WebUndefined when an exception is thrown in the script environment.

pub unsafe fn setWebScriptValueAtIndex_value( &self, index: c_uint, value: Option<&AnyObject>, )

👎Deprecated

Parameter index: The index of the property to set.

Parameter value: The value of the property to set.

Sets the property value at the specified index.

pub unsafe fn setException(&self, description: Option<&NSString>)

👎Deprecated

Parameter description: The description of the exception.

Raises an exception in the script environment in the context of the current object.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for DOMHTMLDocument

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<DOMDocument> for DOMHTMLDocument

fn as_ref(&self) -> &DOMDocument

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<DOMHTMLDocument> for DOMHTMLDocument

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<DOMNode> for DOMHTMLDocument

fn as_ref(&self) -> &DOMNode

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<DOMObject> for DOMHTMLDocument

fn as_ref(&self) -> &DOMObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for DOMHTMLDocument

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<WebScriptObject> for DOMHTMLDocument

fn as_ref(&self) -> &WebScriptObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for DOMHTMLDocument

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<DOMDocument> for DOMHTMLDocument

fn borrow(&self) -> &DOMDocument

Immutably borrows from an owned value.

impl Borrow<DOMNode> for DOMHTMLDocument

fn borrow(&self) -> &DOMNode

Immutably borrows from an owned value.

impl Borrow<DOMObject> for DOMHTMLDocument

fn borrow(&self) -> &DOMObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for DOMHTMLDocument

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<WebScriptObject> for DOMHTMLDocument

fn borrow(&self) -> &WebScriptObject

Immutably borrows from an owned value.

impl ClassType for DOMHTMLDocument

const NAME: &'static str = "DOMHTMLDocument"

The name of the Objective-C class that this type represents.

type Super = DOMDocument

The superclass of this class.

type ThreadKind = <<DOMHTMLDocument as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for DOMHTMLDocument

type Result = DOMHTMLDocument

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl DOMEventTarget for DOMHTMLDocument

Available on crate feature DOMEventTarget only.

unsafe fn addEventListener_listener_useCapture( &self, type: Option<&NSString>, listener: Option<&ProtocolObject<dyn DOMEventListener>>, use_capture: bool, )

where Self: Sized + Message,

👎Deprecated

Available on crate feature DOMEventListener only.

unsafe fn removeEventListener_listener_useCapture( &self, type: Option<&NSString>, listener: Option<&ProtocolObject<dyn DOMEventListener>>, use_capture: bool, )

where Self: Sized + Message,

👎Deprecated

Available on crate feature DOMEventListener only.

unsafe fn dispatchEvent(&self, event: Option<&DOMEvent>) -> bool

where Self: Sized + Message,

👎Deprecated

Available on crate feature DOMEvent only.

unsafe fn addEventListener( &self, type: Option<&NSString>, listener: Option<&ProtocolObject<dyn DOMEventListener>>, use_capture: bool, )

where Self: Sized + Message,

👎Deprecated

Available on crate feature DOMEventListener only.

unsafe fn removeEventListener( &self, type: Option<&NSString>, listener: Option<&ProtocolObject<dyn DOMEventListener>>, use_capture: bool, )

where Self: Sized + Message,

👎Deprecated

Available on crate feature DOMEventListener only.

impl Debug for DOMHTMLDocument

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

Formats the value using the given formatter.

impl Deref for DOMHTMLDocument

type Target = DOMDocument

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for DOMHTMLDocument

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for DOMHTMLDocument

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for DOMHTMLDocument

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for DOMHTMLDocument

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for DOMHTMLDocument

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for DOMHTMLDocument

const ENCODING_REF: Encoding = <DOMDocument as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for DOMHTMLDocument

impl Eq for DOMHTMLDocument