Struct DOMHTMLInputElement 

pub struct DOMHTMLInputElement { /* private fields */ }

👎Deprecated

Available on crate features DOMElement and DOMHTMLElement and DOMHTMLInputElement and DOMNode and DOMObject and WebScriptObject only.

Apple’s documentation

Implementations

impl DOMHTMLInputElement

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

👎Deprecated

pub unsafe fn setAccept(&self, accept: Option<&NSString>)

👎Deprecated

Setter for accept.

This is copied when set.

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

👎Deprecated

pub unsafe fn setAlt(&self, alt: Option<&NSString>)

👎Deprecated

Setter for alt.

This is copied when set.

pub unsafe fn autofocus(&self) -> bool

pub unsafe fn setAutofocus(&self, autofocus: bool)

Setter for autofocus.

pub unsafe fn defaultChecked(&self) -> bool

👎Deprecated

pub unsafe fn setDefaultChecked(&self, default_checked: bool)

👎Deprecated

Setter for defaultChecked.

pub unsafe fn checked(&self) -> bool

👎Deprecated

pub unsafe fn setChecked(&self, checked: bool)

👎Deprecated

Setter for checked.

pub unsafe fn disabled(&self) -> bool

👎Deprecated

pub unsafe fn setDisabled(&self, disabled: bool)

👎Deprecated

Setter for disabled.

pub unsafe fn form(&self) -> Option<Retained<DOMHTMLFormElement>>

👎Deprecated

Available on crate feature DOMHTMLFormElement only.

pub unsafe fn files(&self) -> Option<Retained<DOMFileList>>

Available on crate feature DOMFileList only.

pub unsafe fn setFiles(&self, files: Option<&DOMFileList>)

Available on crate feature DOMFileList only.

Setter for files.

Safety

files might not allow None.

pub unsafe fn indeterminate(&self) -> bool

pub unsafe fn setIndeterminate(&self, indeterminate: bool)

Setter for indeterminate.

pub unsafe fn maxLength(&self) -> c_int

👎Deprecated

pub unsafe fn setMaxLength(&self, max_length: c_int)

👎Deprecated

Setter for maxLength.

pub unsafe fn multiple(&self) -> bool

pub unsafe fn setMultiple(&self, multiple: bool)

Setter for multiple.

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

👎Deprecated

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

👎Deprecated

Setter for name.

This is copied when set.

pub unsafe fn readOnly(&self) -> bool

👎Deprecated

pub unsafe fn setReadOnly(&self, read_only: bool)

👎Deprecated

Setter for readOnly.

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

👎Deprecated

pub unsafe fn setSize(&self, size: Option<&NSString>)

👎Deprecated

Setter for size.

This is copied when set.

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

👎Deprecated

pub unsafe fn setSrc(&self, src: Option<&NSString>)

👎Deprecated

Setter for src.

This is copied when set.

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

👎Deprecated

pub unsafe fn setType(&self, type: Option<&NSString>)

👎Deprecated

Setter for type.

This is copied when set.

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

👎Deprecated

pub unsafe fn setDefaultValue(&self, default_value: Option<&NSString>)

👎Deprecated

Setter for defaultValue.

This is copied when set.

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

👎Deprecated

pub unsafe fn setValue(&self, value: Option<&NSString>)

👎Deprecated

Setter for value.

This is copied when set.

pub unsafe fn willValidate(&self) -> bool

pub unsafe fn selectionStart(&self) -> c_int

pub unsafe fn setSelectionStart(&self, selection_start: c_int)

Setter for selectionStart.

pub unsafe fn selectionEnd(&self) -> c_int

pub unsafe fn setSelectionEnd(&self, selection_end: c_int)

Setter for selectionEnd.

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

👎Deprecated

pub unsafe fn setAlign(&self, align: Option<&NSString>)

👎Deprecated

Setter for align.

This is copied when set.

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

👎Deprecated

pub unsafe fn setUseMap(&self, use_map: Option<&NSString>)

👎Deprecated

Setter for useMap.

This is copied when set.

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

👎Deprecated

pub unsafe fn setAccessKey(&self, access_key: Option<&NSString>)

👎Deprecated

Setter for accessKey.

This is copied when set.

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

pub unsafe fn absoluteImageURL(&self) -> Retained<NSURL>

pub unsafe fn select(&self)

👎Deprecated

pub unsafe fn setSelectionRange_end(&self, start: c_int, end: c_int)

pub unsafe fn click(&self)

👎Deprecated

impl DOMHTMLInputElement

Methods declared on superclass DOMObject.

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

👎Deprecated

impl DOMHTMLInputElement

Methods declared on superclass NSObject.

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

Methods from Deref<Target = DOMHTMLElement>

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

👎Deprecated

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

👎Deprecated

Setter for title.

This is copied when set.

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

👎Deprecated

pub unsafe fn setLang(&self, lang: Option<&NSString>)

👎Deprecated

Setter for lang.

This is copied when set.

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

👎Deprecated

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

👎Deprecated

Setter for dir.

This is copied when set.

pub unsafe fn tabIndex(&self) -> c_int

👎Deprecated

pub unsafe fn setTabIndex(&self, tab_index: c_int)

👎Deprecated

Setter for tabIndex.

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

pub unsafe fn setAccessKey(&self, access_key: Option<&NSString>)

Setter for accessKey.

This is copied when set.

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

👎Deprecated

pub unsafe fn setInnerText(&self, inner_text: Option<&NSString>)

👎Deprecated

Setter for innerText.

This is copied when set.

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

👎Deprecated

pub unsafe fn setOuterText(&self, outer_text: Option<&NSString>)

👎Deprecated

Setter for outerText.

This is copied when set.

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

👎Deprecated

pub unsafe fn setContentEditable(&self, content_editable: Option<&NSString>)

👎Deprecated

Setter for contentEditable.

This is copied when set.

pub unsafe fn isContentEditable(&self) -> bool

👎Deprecated

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

👎Deprecated

pub unsafe fn setIdName(&self, id_name: Option<&NSString>)

👎Deprecated

Setter for idName.

This is copied when set.

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

👎Deprecated

Available on crate feature DOMHTMLCollection only.

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

pub unsafe fn click(&self)

Methods from Deref<Target = DOMElement>

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

👎Deprecated

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

👎Deprecated

Available on crate feature DOMCSSStyleDeclaration only.

pub unsafe fn offsetLeft(&self) -> c_int

👎Deprecated

pub unsafe fn offsetTop(&self) -> c_int

👎Deprecated

pub unsafe fn offsetWidth(&self) -> c_int

👎Deprecated

pub unsafe fn offsetHeight(&self) -> c_int

👎Deprecated

pub unsafe fn clientLeft(&self) -> c_int

pub unsafe fn clientTop(&self) -> c_int

pub unsafe fn clientWidth(&self) -> c_int

👎Deprecated

pub unsafe fn clientHeight(&self) -> c_int

👎Deprecated

pub unsafe fn scrollLeft(&self) -> c_int

👎Deprecated

pub unsafe fn setScrollLeft(&self, scroll_left: c_int)

👎Deprecated

Setter for scrollLeft.

pub unsafe fn scrollTop(&self) -> c_int

👎Deprecated

pub unsafe fn setScrollTop(&self, scroll_top: c_int)

👎Deprecated

Setter for scrollTop.

pub unsafe fn scrollWidth(&self) -> c_int

👎Deprecated

pub unsafe fn scrollHeight(&self) -> c_int

👎Deprecated

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

👎Deprecated

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

👎Deprecated

pub unsafe fn setInnerHTML(&self, inner_html: Option<&NSString>)

👎Deprecated

Setter for innerHTML.

This is copied when set.

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

👎Deprecated

pub unsafe fn setOuterHTML(&self, outer_html: Option<&NSString>)

👎Deprecated

Setter for outerHTML.

This is copied when set.

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

👎Deprecated

pub unsafe fn setClassName(&self, class_name: Option<&NSString>)

👎Deprecated

Setter for className.

This is copied when set.

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

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

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

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

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

pub unsafe fn childElementCount(&self) -> c_uint

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

👎Deprecated

Safety

name might not allow None.

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

Safety

• name might not allow None.
• value might not allow None.

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

👎Deprecated

Safety

name might not allow None.

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

👎Deprecated

Available on crate feature DOMAttr only.

Safety

name might not allow None.

pub unsafe fn setAttributeNode( &self, new_attr: Option<&DOMAttr>, ) -> Option<Retained<DOMAttr>>

👎Deprecated

Available on crate feature DOMAttr only.

Safety

new_attr might not allow None.

pub unsafe fn removeAttributeNode( &self, old_attr: Option<&DOMAttr>, ) -> Option<Retained<DOMAttr>>

👎Deprecated

Available on crate feature DOMAttr only.

Safety

old_attr might not allow None.

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

👎Deprecated

Available on crate feature DOMNodeList only.

Safety

name might not allow None.

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

Safety

• namespace_uri might not allow None.
• local_name might not allow None.

pub unsafe fn setAttributeNS_qualifiedName_value( &self, namespace_uri: Option<&NSString>, qualified_name: Option<&NSString>, value: Option<&NSString>, )

Safety

• namespace_uri might not allow None.
• qualified_name might not allow None.
• value might not allow None.

pub unsafe fn removeAttributeNS_localName( &self, namespace_uri: Option<&NSString>, local_name: Option<&NSString>, )

Safety

• namespace_uri might not allow None.
• local_name might not allow None.

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

Available on crate feature DOMNodeList only.

Safety

• namespace_uri might not allow None.
• local_name might not allow None.

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

Available on crate feature DOMAttr only.

Safety

• namespace_uri might not allow None.
• local_name might not allow None.

pub unsafe fn setAttributeNodeNS( &self, new_attr: Option<&DOMAttr>, ) -> Option<Retained<DOMAttr>>

👎Deprecated

Available on crate feature DOMAttr only.

Safety

new_attr might not allow None.

pub unsafe fn hasAttribute(&self, name: Option<&NSString>) -> bool

👎Deprecated

Safety

name might not allow None.

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

Safety

• namespace_uri might not allow None.
• local_name might not allow None.

pub unsafe fn focus(&self)

pub unsafe fn blur(&self)

pub unsafe fn scrollIntoView(&self, align_with_top: bool)

pub unsafe fn scrollIntoViewIfNeeded(&self, center_if_needed: bool)

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

Available on crate feature DOMNodeList only.

Safety

name might not allow None.

pub unsafe fn webkitRequestFullScreen(&self, flags: c_ushort)

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

Safety

selectors might not allow None.

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

Available on crate feature DOMNodeList only.

Safety

selectors might not allow None.

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

👎Deprecated

Safety

• name might not allow None.
• value might not allow None.

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

👎Deprecated

Safety

• namespace_uri might not allow None.
• local_name might not allow None.

pub unsafe fn setAttributeNS( &self, namespace_uri: Option<&NSString>, qualified_name: Option<&NSString>, value: Option<&NSString>, )

👎Deprecated

Safety

• namespace_uri might not allow None.
• qualified_name might not allow None.
• value might not allow None.

pub unsafe fn removeAttributeNS( &self, namespace_uri: Option<&NSString>, local_name: Option<&NSString>, )

👎Deprecated

Safety

• namespace_uri might not allow None.
• local_name might not allow None.

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

👎Deprecated

Available on crate feature DOMNodeList only.

Safety

• namespace_uri might not allow None.
• local_name might not allow None.

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

👎Deprecated

Available on crate feature DOMAttr only.

Safety

• namespace_uri might not allow None.
• local_name might not allow None.

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

👎Deprecated

Safety

• namespace_uri might not allow None.
• local_name might not allow None.

pub unsafe fn scrollByLines(&self, lines: c_int)

👎Deprecated

pub unsafe fn scrollByPages(&self, pages: c_int)

👎Deprecated

Methods from Deref<Target = DOMNode>

pub unsafe fn boundingBox(&self) -> NSRect

👎Deprecated

Available on crate feature DOMExtensions only.

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

👎Deprecated

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.

This is copied when set.

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

Available on crate feature DOMDocument only.

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.

This is copied when set.

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.

This is copied when set.

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

pub unsafe fn isContentEditable(&self) -> bool

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

Safety

• new_child might not allow None.
• ref_child might not allow None.

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

Safety

• new_child might not allow None.
• old_child might not allow None.

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

👎Deprecated

Safety

old_child might not allow None.

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

👎Deprecated

Safety

new_child might not allow None.

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

Safety

• feature might not allow None.
• version might not allow None.

pub unsafe fn hasAttributes(&self) -> bool

👎Deprecated

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

Safety

other might not allow None.

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

Safety

other might not allow None.

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

Safety

namespace_uri might not allow None.

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

Safety

prefix might not allow None.

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

Safety

namespace_uri might not allow None.

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

Safety

other might not allow None.

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

Safety

other might not allow None.

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

👎Deprecated

Safety

• new_child might not allow None.
• ref_child might not allow None.

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

👎Deprecated

Safety

• new_child might not allow None.
• old_child might not allow None.

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

👎Deprecated

Safety

• feature might not allow None.
• version might not allow None.

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>>

👎Deprecated

Available on crate feature DOMStyleSheet only.

Methods from Deref<Target = WebScriptObject>

pub unsafe fn JSObject(&self) -> JSObjectRef

Available on crate feature objc2-javascript-core only.

Returns: The equivalent JSObjectRef for this WebScriptObject.

Use this method to bridge between the WebScriptObject and JavaScriptCore APIs.

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.

Safety

• name might not allow None.
• arguments generic should be of the correct type.
• arguments might not allow None.

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.

Safety

script might not allow None.

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.

Safety

name might not allow None.

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.

Safety

• value should be of the correct type.
• value might not allow None.

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.

Safety

description might not allow None.

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

👎Deprecated

Available on crate feature objc2-javascript-core only.

Returns: The equivalent Objective-C JSValue for this WebScriptObject.

Use this method to bridge between the WebScriptObject and JavaScriptCore Objective-C APIs.

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.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

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 DOMHTMLInputElement

fn as_ref(&self) -> &AnyObject

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

impl AsRef<DOMElement> for DOMHTMLInputElement

fn as_ref(&self) -> &DOMElement

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

impl AsRef<DOMHTMLElement> for DOMHTMLInputElement

fn as_ref(&self) -> &DOMHTMLElement

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

impl AsRef<DOMHTMLInputElement> for DOMHTMLInputElement

fn as_ref(&self) -> &Self

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

impl AsRef<DOMNode> for DOMHTMLInputElement

fn as_ref(&self) -> &DOMNode

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

impl AsRef<DOMObject> for DOMHTMLInputElement

fn as_ref(&self) -> &DOMObject

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

impl AsRef<NSObject> for DOMHTMLInputElement

fn as_ref(&self) -> &NSObject

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

impl AsRef<WebScriptObject> for DOMHTMLInputElement

fn as_ref(&self) -> &WebScriptObject

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

impl Borrow<AnyObject> for DOMHTMLInputElement

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<DOMElement> for DOMHTMLInputElement

fn borrow(&self) -> &DOMElement

Immutably borrows from an owned value.

impl Borrow<DOMHTMLElement> for DOMHTMLInputElement

fn borrow(&self) -> &DOMHTMLElement

Immutably borrows from an owned value.

impl Borrow<DOMNode> for DOMHTMLInputElement

fn borrow(&self) -> &DOMNode

Immutably borrows from an owned value.

impl Borrow<DOMObject> for DOMHTMLInputElement

fn borrow(&self) -> &DOMObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for DOMHTMLInputElement

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<WebScriptObject> for DOMHTMLInputElement

fn borrow(&self) -> &WebScriptObject

Immutably borrows from an owned value.

impl ClassType for DOMHTMLInputElement

const NAME: &'static str = "DOMHTMLInputElement"

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

type Super = DOMHTMLElement

The superclass of this class.

type ThreadKind = <<DOMHTMLInputElement 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 DOMHTMLInputElement

type Result = DOMHTMLInputElement

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

impl DOMEventTarget for DOMHTMLInputElement

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 features DOMEventTarget and DOMEventListener only.

Safety

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 features DOMEventTarget and DOMEventListener only.

Safety

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

where Self: Sized + Message,

👎Deprecated

Available on crate features DOMEvent and DOMObject and WebScriptObject and DOMEventTarget only.

Safety

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

where Self: Sized + Message,

👎Deprecated

Available on crate features DOMEventTarget and DOMEventListener only.

Safety

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

where Self: Sized + Message,

👎Deprecated

Available on crate features DOMEventTarget and DOMEventListener only.

Safety

impl Debug for DOMHTMLInputElement

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

Formats the value using the given formatter.

impl Deref for DOMHTMLInputElement

type Target = DOMHTMLElement

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for DOMHTMLInputElement

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 DOMHTMLInputElement

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for DOMHTMLInputElement

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 DOMHTMLInputElement

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 DOMHTMLInputElement

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 DOMHTMLInputElement

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

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

impl DowncastTarget for DOMHTMLInputElement

impl Eq for DOMHTMLInputElement