pub struct DOMHTMLMenuElement { /* private fields */ }
DOMElement
and DOMHTMLElement
and DOMHTMLMenuElement
and DOMNode
and DOMObject
and WebScriptObject
only.Expand description
Implementations§
Source§impl DOMHTMLMenuElement
Methods declared on superclass DOMObject
.
impl DOMHTMLMenuElement
Methods declared on superclass DOMObject
.
Methods from Deref<Target = DOMHTMLElement>§
pub unsafe fn title(&self) -> Retained<NSString>
pub unsafe fn lang(&self) -> Retained<NSString>
pub unsafe fn dir(&self) -> Retained<NSString>
pub unsafe fn tabIndex(&self) -> c_int
Sourcepub unsafe fn setTabIndex(&self, tab_index: c_int)
👎Deprecated
pub unsafe fn setTabIndex(&self, tab_index: c_int)
Setter for tabIndex
.
pub unsafe fn accessKey(&self) -> Retained<NSString>
Sourcepub unsafe fn setAccessKey(&self, access_key: Option<&NSString>)
pub unsafe fn setAccessKey(&self, access_key: Option<&NSString>)
pub unsafe fn innerText(&self) -> Retained<NSString>
Sourcepub unsafe fn setInnerText(&self, inner_text: Option<&NSString>)
👎Deprecated
pub unsafe fn setInnerText(&self, inner_text: Option<&NSString>)
pub unsafe fn outerText(&self) -> Retained<NSString>
Sourcepub unsafe fn setOuterText(&self, outer_text: Option<&NSString>)
👎Deprecated
pub unsafe fn setOuterText(&self, outer_text: Option<&NSString>)
pub unsafe fn contentEditable(&self) -> Retained<NSString>
Sourcepub unsafe fn setContentEditable(&self, content_editable: Option<&NSString>)
👎Deprecated
pub unsafe fn setContentEditable(&self, content_editable: Option<&NSString>)
Setter for contentEditable
.
This is copied when set.
pub unsafe fn isContentEditable(&self) -> bool
pub unsafe fn idName(&self) -> Retained<NSString>
pub unsafe fn children(&self) -> Option<Retained<DOMHTMLCollection>>
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>
pub unsafe fn style(&self) -> Option<Retained<DOMCSSStyleDeclaration>>
DOMCSSStyleDeclaration
only.pub unsafe fn offsetLeft(&self) -> c_int
pub unsafe fn offsetTop(&self) -> c_int
pub unsafe fn offsetWidth(&self) -> c_int
pub unsafe fn offsetHeight(&self) -> c_int
pub unsafe fn clientLeft(&self) -> c_int
pub unsafe fn clientTop(&self) -> c_int
pub unsafe fn clientWidth(&self) -> c_int
pub unsafe fn clientHeight(&self) -> c_int
pub unsafe fn scrollLeft(&self) -> c_int
Sourcepub unsafe fn setScrollLeft(&self, scroll_left: c_int)
👎Deprecated
pub unsafe fn setScrollLeft(&self, scroll_left: c_int)
Setter for scrollLeft
.
pub unsafe fn scrollTop(&self) -> c_int
Sourcepub unsafe fn setScrollTop(&self, scroll_top: c_int)
👎Deprecated
pub unsafe fn setScrollTop(&self, scroll_top: c_int)
Setter for scrollTop
.
pub unsafe fn scrollWidth(&self) -> c_int
pub unsafe fn scrollHeight(&self) -> c_int
pub unsafe fn offsetParent(&self) -> Option<Retained<DOMElement>>
pub unsafe fn innerHTML(&self) -> Retained<NSString>
Sourcepub unsafe fn setInnerHTML(&self, inner_html: Option<&NSString>)
👎Deprecated
pub unsafe fn setInnerHTML(&self, inner_html: Option<&NSString>)
pub unsafe fn outerHTML(&self) -> Retained<NSString>
Sourcepub unsafe fn setOuterHTML(&self, outer_html: Option<&NSString>)
👎Deprecated
pub unsafe fn setOuterHTML(&self, outer_html: Option<&NSString>)
pub unsafe fn className(&self) -> Retained<NSString>
Sourcepub unsafe fn setClassName(&self, class_name: Option<&NSString>)
👎Deprecated
pub unsafe fn setClassName(&self, class_name: Option<&NSString>)
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
Sourcepub unsafe fn getAttribute(
&self,
name: Option<&NSString>,
) -> Option<Retained<NSString>>
👎Deprecated
pub unsafe fn getAttribute( &self, name: Option<&NSString>, ) -> Option<Retained<NSString>>
§Safety
name
might not allow None
.
Sourcepub unsafe fn setAttribute_value(
&self,
name: Option<&NSString>,
value: Option<&NSString>,
)
pub unsafe fn setAttribute_value( &self, name: Option<&NSString>, value: Option<&NSString>, )
§Safety
name
might not allowNone
.value
might not allowNone
.
Sourcepub unsafe fn removeAttribute(&self, name: Option<&NSString>)
👎Deprecated
pub unsafe fn removeAttribute(&self, name: Option<&NSString>)
§Safety
name
might not allow None
.
Sourcepub unsafe fn getAttributeNode(
&self,
name: Option<&NSString>,
) -> Option<Retained<DOMAttr>>
👎DeprecatedAvailable on crate feature DOMAttr
only.
pub unsafe fn getAttributeNode( &self, name: Option<&NSString>, ) -> Option<Retained<DOMAttr>>
DOMAttr
only.§Safety
name
might not allow None
.
Sourcepub unsafe fn setAttributeNode(
&self,
new_attr: Option<&DOMAttr>,
) -> Option<Retained<DOMAttr>>
👎DeprecatedAvailable on crate feature DOMAttr
only.
pub unsafe fn setAttributeNode( &self, new_attr: Option<&DOMAttr>, ) -> Option<Retained<DOMAttr>>
DOMAttr
only.§Safety
new_attr
might not allow None
.
Sourcepub unsafe fn removeAttributeNode(
&self,
old_attr: Option<&DOMAttr>,
) -> Option<Retained<DOMAttr>>
👎DeprecatedAvailable on crate feature DOMAttr
only.
pub unsafe fn removeAttributeNode( &self, old_attr: Option<&DOMAttr>, ) -> Option<Retained<DOMAttr>>
DOMAttr
only.§Safety
old_attr
might not allow None
.
Sourcepub unsafe fn getElementsByTagName(
&self,
name: Option<&NSString>,
) -> Option<Retained<DOMNodeList>>
👎DeprecatedAvailable on crate feature DOMNodeList
only.
pub unsafe fn getElementsByTagName( &self, name: Option<&NSString>, ) -> Option<Retained<DOMNodeList>>
DOMNodeList
only.§Safety
name
might not allow None
.
Sourcepub unsafe fn getAttributeNS_localName(
&self,
namespace_uri: Option<&NSString>,
local_name: Option<&NSString>,
) -> Option<Retained<NSString>>
pub unsafe fn getAttributeNS_localName( &self, namespace_uri: Option<&NSString>, local_name: Option<&NSString>, ) -> Option<Retained<NSString>>
§Safety
namespace_uri
might not allowNone
.local_name
might not allowNone
.
Sourcepub unsafe fn setAttributeNS_qualifiedName_value(
&self,
namespace_uri: Option<&NSString>,
qualified_name: Option<&NSString>,
value: Option<&NSString>,
)
pub unsafe fn setAttributeNS_qualifiedName_value( &self, namespace_uri: Option<&NSString>, qualified_name: Option<&NSString>, value: Option<&NSString>, )
§Safety
namespace_uri
might not allowNone
.qualified_name
might not allowNone
.value
might not allowNone
.
Sourcepub unsafe fn removeAttributeNS_localName(
&self,
namespace_uri: Option<&NSString>,
local_name: Option<&NSString>,
)
pub unsafe fn removeAttributeNS_localName( &self, namespace_uri: Option<&NSString>, local_name: Option<&NSString>, )
§Safety
namespace_uri
might not allowNone
.local_name
might not allowNone
.
Sourcepub 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 getElementsByTagNameNS_localName( &self, namespace_uri: Option<&NSString>, local_name: Option<&NSString>, ) -> Option<Retained<DOMNodeList>>
DOMNodeList
only.§Safety
namespace_uri
might not allowNone
.local_name
might not allowNone
.
Sourcepub unsafe fn getAttributeNodeNS_localName(
&self,
namespace_uri: Option<&NSString>,
local_name: Option<&NSString>,
) -> Option<Retained<DOMAttr>>
Available on crate feature DOMAttr
only.
pub unsafe fn getAttributeNodeNS_localName( &self, namespace_uri: Option<&NSString>, local_name: Option<&NSString>, ) -> Option<Retained<DOMAttr>>
DOMAttr
only.§Safety
namespace_uri
might not allowNone
.local_name
might not allowNone
.
Sourcepub unsafe fn setAttributeNodeNS(
&self,
new_attr: Option<&DOMAttr>,
) -> Option<Retained<DOMAttr>>
👎DeprecatedAvailable on crate feature DOMAttr
only.
pub unsafe fn setAttributeNodeNS( &self, new_attr: Option<&DOMAttr>, ) -> Option<Retained<DOMAttr>>
DOMAttr
only.§Safety
new_attr
might not allow None
.
Sourcepub unsafe fn hasAttribute(&self, name: Option<&NSString>) -> bool
👎Deprecated
pub unsafe fn hasAttribute(&self, name: Option<&NSString>) -> bool
§Safety
name
might not allow None
.
Sourcepub unsafe fn hasAttributeNS_localName(
&self,
namespace_uri: Option<&NSString>,
local_name: Option<&NSString>,
) -> bool
pub unsafe fn hasAttributeNS_localName( &self, namespace_uri: Option<&NSString>, local_name: Option<&NSString>, ) -> bool
§Safety
namespace_uri
might not allowNone
.local_name
might not allowNone
.
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)
Sourcepub unsafe fn getElementsByClassName(
&self,
name: Option<&NSString>,
) -> Option<Retained<DOMNodeList>>
Available on crate feature DOMNodeList
only.
pub unsafe fn getElementsByClassName( &self, name: Option<&NSString>, ) -> Option<Retained<DOMNodeList>>
DOMNodeList
only.§Safety
name
might not allow None
.
pub unsafe fn webkitRequestFullScreen(&self, flags: c_ushort)
Sourcepub unsafe fn querySelector(
&self,
selectors: Option<&NSString>,
) -> Option<Retained<DOMElement>>
pub unsafe fn querySelector( &self, selectors: Option<&NSString>, ) -> Option<Retained<DOMElement>>
§Safety
selectors
might not allow None
.
Sourcepub unsafe fn querySelectorAll(
&self,
selectors: Option<&NSString>,
) -> Option<Retained<DOMNodeList>>
Available on crate feature DOMNodeList
only.
pub unsafe fn querySelectorAll( &self, selectors: Option<&NSString>, ) -> Option<Retained<DOMNodeList>>
DOMNodeList
only.§Safety
selectors
might not allow None
.
Sourcepub unsafe fn setAttribute(
&self,
name: Option<&NSString>,
value: Option<&NSString>,
)
👎Deprecated
pub unsafe fn setAttribute( &self, name: Option<&NSString>, value: Option<&NSString>, )
§Safety
name
might not allowNone
.value
might not allowNone
.
Sourcepub unsafe fn getAttributeNS(
&self,
namespace_uri: Option<&NSString>,
local_name: Option<&NSString>,
) -> Option<Retained<NSString>>
👎Deprecated
pub unsafe fn getAttributeNS( &self, namespace_uri: Option<&NSString>, local_name: Option<&NSString>, ) -> Option<Retained<NSString>>
§Safety
namespace_uri
might not allowNone
.local_name
might not allowNone
.
Sourcepub unsafe fn setAttributeNS(
&self,
namespace_uri: Option<&NSString>,
qualified_name: Option<&NSString>,
value: Option<&NSString>,
)
👎Deprecated
pub unsafe fn setAttributeNS( &self, namespace_uri: Option<&NSString>, qualified_name: Option<&NSString>, value: Option<&NSString>, )
§Safety
namespace_uri
might not allowNone
.qualified_name
might not allowNone
.value
might not allowNone
.
Sourcepub unsafe fn removeAttributeNS(
&self,
namespace_uri: Option<&NSString>,
local_name: Option<&NSString>,
)
👎Deprecated
pub unsafe fn removeAttributeNS( &self, namespace_uri: Option<&NSString>, local_name: Option<&NSString>, )
§Safety
namespace_uri
might not allowNone
.local_name
might not allowNone
.
Sourcepub unsafe fn getElementsByTagNameNS(
&self,
namespace_uri: Option<&NSString>,
local_name: Option<&NSString>,
) -> Option<Retained<DOMNodeList>>
👎DeprecatedAvailable on crate feature DOMNodeList
only.
pub unsafe fn getElementsByTagNameNS( &self, namespace_uri: Option<&NSString>, local_name: Option<&NSString>, ) -> Option<Retained<DOMNodeList>>
DOMNodeList
only.§Safety
namespace_uri
might not allowNone
.local_name
might not allowNone
.
Sourcepub unsafe fn getAttributeNodeNS(
&self,
namespace_uri: Option<&NSString>,
local_name: Option<&NSString>,
) -> Option<Retained<DOMAttr>>
👎DeprecatedAvailable on crate feature DOMAttr
only.
pub unsafe fn getAttributeNodeNS( &self, namespace_uri: Option<&NSString>, local_name: Option<&NSString>, ) -> Option<Retained<DOMAttr>>
DOMAttr
only.§Safety
namespace_uri
might not allowNone
.local_name
might not allowNone
.
Sourcepub unsafe fn hasAttributeNS(
&self,
namespace_uri: Option<&NSString>,
local_name: Option<&NSString>,
) -> bool
👎Deprecated
pub unsafe fn hasAttributeNS( &self, namespace_uri: Option<&NSString>, local_name: Option<&NSString>, ) -> bool
§Safety
namespace_uri
might not allowNone
.local_name
might not allowNone
.
pub unsafe fn scrollByLines(&self, lines: c_int)
pub unsafe fn scrollByPages(&self, pages: c_int)
Methods from Deref<Target = DOMNode>§
pub unsafe fn boundingBox(&self) -> NSRect
DOMExtensions
only.pub unsafe fn lineBoxRects(&self) -> Option<Retained<NSArray>>
DOMExtensions
only.pub unsafe fn nodeName(&self) -> Retained<NSString>
pub unsafe fn nodeValue(&self) -> Retained<NSString>
Sourcepub unsafe fn setNodeValue(&self, node_value: Option<&NSString>)
👎Deprecated
pub unsafe fn setNodeValue(&self, node_value: Option<&NSString>)
pub unsafe fn nodeType(&self) -> c_ushort
pub unsafe fn parentNode(&self) -> Option<Retained<DOMNode>>
pub unsafe fn childNodes(&self) -> Option<Retained<DOMNodeList>>
DOMNodeList
only.pub unsafe fn firstChild(&self) -> Option<Retained<DOMNode>>
pub unsafe fn lastChild(&self) -> Option<Retained<DOMNode>>
pub unsafe fn previousSibling(&self) -> Option<Retained<DOMNode>>
pub unsafe fn nextSibling(&self) -> Option<Retained<DOMNode>>
pub unsafe fn ownerDocument(&self) -> Option<Retained<DOMDocument>>
DOMDocument
only.pub unsafe fn namespaceURI(&self) -> Retained<NSString>
pub unsafe fn prefix(&self) -> Retained<NSString>
pub unsafe fn localName(&self) -> Retained<NSString>
pub unsafe fn attributes(&self) -> Option<Retained<DOMNamedNodeMap>>
DOMNamedNodeMap
only.pub unsafe fn baseURI(&self) -> Retained<NSString>
pub unsafe fn textContent(&self) -> Retained<NSString>
Sourcepub unsafe fn setTextContent(&self, text_content: Option<&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
Sourcepub unsafe fn insertBefore_refChild(
&self,
new_child: Option<&DOMNode>,
ref_child: Option<&DOMNode>,
) -> Option<Retained<DOMNode>>
pub unsafe fn insertBefore_refChild( &self, new_child: Option<&DOMNode>, ref_child: Option<&DOMNode>, ) -> Option<Retained<DOMNode>>
§Safety
new_child
might not allowNone
.ref_child
might not allowNone
.
Sourcepub unsafe fn replaceChild_oldChild(
&self,
new_child: Option<&DOMNode>,
old_child: Option<&DOMNode>,
) -> Option<Retained<DOMNode>>
pub unsafe fn replaceChild_oldChild( &self, new_child: Option<&DOMNode>, old_child: Option<&DOMNode>, ) -> Option<Retained<DOMNode>>
§Safety
new_child
might not allowNone
.old_child
might not allowNone
.
Sourcepub unsafe fn removeChild(
&self,
old_child: Option<&DOMNode>,
) -> Option<Retained<DOMNode>>
👎Deprecated
pub unsafe fn removeChild( &self, old_child: Option<&DOMNode>, ) -> Option<Retained<DOMNode>>
§Safety
old_child
might not allow None
.
Sourcepub unsafe fn appendChild(
&self,
new_child: Option<&DOMNode>,
) -> Option<Retained<DOMNode>>
👎Deprecated
pub unsafe fn appendChild( &self, new_child: Option<&DOMNode>, ) -> Option<Retained<DOMNode>>
§Safety
new_child
might not allow None
.
pub unsafe fn hasChildNodes(&self) -> bool
pub unsafe fn cloneNode(&self, deep: bool) -> Option<Retained<DOMNode>>
pub unsafe fn normalize(&self)
Sourcepub unsafe fn isSupported_version(
&self,
feature: Option<&NSString>,
version: Option<&NSString>,
) -> bool
pub unsafe fn isSupported_version( &self, feature: Option<&NSString>, version: Option<&NSString>, ) -> bool
§Safety
feature
might not allowNone
.version
might not allowNone
.
pub unsafe fn hasAttributes(&self) -> bool
Sourcepub unsafe fn isSameNode(&self, other: Option<&DOMNode>) -> bool
pub unsafe fn isSameNode(&self, other: Option<&DOMNode>) -> bool
§Safety
other
might not allow None
.
Sourcepub unsafe fn isEqualNode(&self, other: Option<&DOMNode>) -> bool
pub unsafe fn isEqualNode(&self, other: Option<&DOMNode>) -> bool
§Safety
other
might not allow None
.
Sourcepub unsafe fn lookupPrefix(
&self,
namespace_uri: Option<&NSString>,
) -> Option<Retained<NSString>>
pub unsafe fn lookupPrefix( &self, namespace_uri: Option<&NSString>, ) -> Option<Retained<NSString>>
§Safety
namespace_uri
might not allow None
.
Sourcepub unsafe fn lookupNamespaceURI(
&self,
prefix: Option<&NSString>,
) -> Option<Retained<NSString>>
pub unsafe fn lookupNamespaceURI( &self, prefix: Option<&NSString>, ) -> Option<Retained<NSString>>
§Safety
prefix
might not allow None
.
Sourcepub unsafe fn isDefaultNamespace(
&self,
namespace_uri: Option<&NSString>,
) -> bool
pub unsafe fn isDefaultNamespace( &self, namespace_uri: Option<&NSString>, ) -> bool
§Safety
namespace_uri
might not allow None
.
Sourcepub unsafe fn compareDocumentPosition(
&self,
other: Option<&DOMNode>,
) -> c_ushort
pub unsafe fn compareDocumentPosition( &self, other: Option<&DOMNode>, ) -> c_ushort
§Safety
other
might not allow None
.
Sourcepub unsafe fn contains(&self, other: Option<&DOMNode>) -> bool
pub unsafe fn contains(&self, other: Option<&DOMNode>) -> bool
§Safety
other
might not allow None
.
Sourcepub unsafe fn insertBefore(
&self,
new_child: Option<&DOMNode>,
ref_child: Option<&DOMNode>,
) -> Option<Retained<DOMNode>>
👎Deprecated
pub unsafe fn insertBefore( &self, new_child: Option<&DOMNode>, ref_child: Option<&DOMNode>, ) -> Option<Retained<DOMNode>>
§Safety
new_child
might not allowNone
.ref_child
might not allowNone
.
Sourcepub unsafe fn replaceChild(
&self,
new_child: Option<&DOMNode>,
old_child: Option<&DOMNode>,
) -> Option<Retained<DOMNode>>
👎Deprecated
pub unsafe fn replaceChild( &self, new_child: Option<&DOMNode>, old_child: Option<&DOMNode>, ) -> Option<Retained<DOMNode>>
§Safety
new_child
might not allowNone
.old_child
might not allowNone
.
Sourcepub unsafe fn isSupported(
&self,
feature: Option<&NSString>,
version: Option<&NSString>,
) -> bool
👎Deprecated
pub unsafe fn isSupported( &self, feature: Option<&NSString>, version: Option<&NSString>, ) -> bool
§Safety
feature
might not allowNone
.version
might not allowNone
.
Sourcepub unsafe fn webArchive(&self) -> Option<Retained<WebArchive>>
👎DeprecatedAvailable on crate features WebDOMOperations
and WebArchive
only.
pub unsafe fn webArchive(&self) -> Option<Retained<WebArchive>>
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>>
DOMStyleSheet
only.Methods from Deref<Target = WebScriptObject>§
Sourcepub unsafe fn JSObject(&self) -> JSObjectRef
Available on crate feature objc2-javascript-core
only.
pub unsafe fn JSObject(&self) -> JSObjectRef
objc2-javascript-core
only.Returns: The equivalent JSObjectRef for this WebScriptObject.
Use this method to bridge between the WebScriptObject and JavaScriptCore APIs.
Sourcepub unsafe fn callWebScriptMethod_withArguments(
&self,
name: Option<&NSString>,
arguments: Option<&NSArray>,
) -> Option<Retained<AnyObject>>
👎Deprecated
pub unsafe fn callWebScriptMethod_withArguments( &self, name: Option<&NSString>, arguments: Option<&NSArray>, ) -> Option<Retained<AnyObject>>
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 allowNone
.arguments
generic should be of the correct type.arguments
might not allowNone
.
Sourcepub unsafe fn evaluateWebScript(
&self,
script: Option<&NSString>,
) -> Option<Retained<AnyObject>>
👎Deprecated
pub unsafe fn evaluateWebScript( &self, script: Option<&NSString>, ) -> Option<Retained<AnyObject>>
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
.
Sourcepub unsafe fn removeWebScriptKey(&self, name: Option<&NSString>)
👎Deprecated
pub unsafe fn removeWebScriptKey(&self, name: Option<&NSString>)
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
.
Sourcepub unsafe fn stringRepresentation(&self) -> Option<Retained<NSString>>
👎Deprecated
pub unsafe fn stringRepresentation(&self) -> Option<Retained<NSString>>
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.
Sourcepub unsafe fn webScriptValueAtIndex(
&self,
index: c_uint,
) -> Option<Retained<AnyObject>>
👎Deprecated
pub unsafe fn webScriptValueAtIndex( &self, index: c_uint, ) -> Option<Retained<AnyObject>>
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.
Sourcepub unsafe fn setWebScriptValueAtIndex_value(
&self,
index: c_uint,
value: Option<&AnyObject>,
)
👎Deprecated
pub unsafe fn setWebScriptValueAtIndex_value( &self, index: c_uint, value: Option<&AnyObject>, )
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 allowNone
.
Sourcepub unsafe fn setException(&self, description: Option<&NSString>)
👎Deprecated
pub unsafe fn setException(&self, description: Option<&NSString>)
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
.
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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§
Source§impl AsRef<AnyObject> for DOMHTMLMenuElement
impl AsRef<AnyObject> for DOMHTMLMenuElement
Source§impl AsRef<DOMElement> for DOMHTMLMenuElement
impl AsRef<DOMElement> for DOMHTMLMenuElement
Source§fn as_ref(&self) -> &DOMElement
fn as_ref(&self) -> &DOMElement
Source§impl AsRef<DOMHTMLElement> for DOMHTMLMenuElement
impl AsRef<DOMHTMLElement> for DOMHTMLMenuElement
Source§fn as_ref(&self) -> &DOMHTMLElement
fn as_ref(&self) -> &DOMHTMLElement
Source§impl AsRef<DOMHTMLMenuElement> for DOMHTMLMenuElement
impl AsRef<DOMHTMLMenuElement> for DOMHTMLMenuElement
Source§impl AsRef<DOMNode> for DOMHTMLMenuElement
impl AsRef<DOMNode> for DOMHTMLMenuElement
Source§impl AsRef<DOMObject> for DOMHTMLMenuElement
impl AsRef<DOMObject> for DOMHTMLMenuElement
Source§impl AsRef<NSObject> for DOMHTMLMenuElement
impl AsRef<NSObject> for DOMHTMLMenuElement
Source§impl AsRef<WebScriptObject> for DOMHTMLMenuElement
impl AsRef<WebScriptObject> for DOMHTMLMenuElement
Source§fn as_ref(&self) -> &WebScriptObject
fn as_ref(&self) -> &WebScriptObject
Source§impl Borrow<AnyObject> for DOMHTMLMenuElement
impl Borrow<AnyObject> for DOMHTMLMenuElement
Source§impl Borrow<DOMElement> for DOMHTMLMenuElement
impl Borrow<DOMElement> for DOMHTMLMenuElement
Source§fn borrow(&self) -> &DOMElement
fn borrow(&self) -> &DOMElement
Source§impl Borrow<DOMHTMLElement> for DOMHTMLMenuElement
impl Borrow<DOMHTMLElement> for DOMHTMLMenuElement
Source§fn borrow(&self) -> &DOMHTMLElement
fn borrow(&self) -> &DOMHTMLElement
Source§impl Borrow<DOMNode> for DOMHTMLMenuElement
impl Borrow<DOMNode> for DOMHTMLMenuElement
Source§impl Borrow<DOMObject> for DOMHTMLMenuElement
impl Borrow<DOMObject> for DOMHTMLMenuElement
Source§impl Borrow<NSObject> for DOMHTMLMenuElement
impl Borrow<NSObject> for DOMHTMLMenuElement
Source§impl Borrow<WebScriptObject> for DOMHTMLMenuElement
impl Borrow<WebScriptObject> for DOMHTMLMenuElement
Source§fn borrow(&self) -> &WebScriptObject
fn borrow(&self) -> &WebScriptObject
Source§impl ClassType for DOMHTMLMenuElement
impl ClassType for DOMHTMLMenuElement
Source§const NAME: &'static str = "DOMHTMLMenuElement"
const NAME: &'static str = "DOMHTMLMenuElement"
Source§type Super = DOMHTMLElement
type Super = DOMHTMLElement
Source§type ThreadKind = <<DOMHTMLMenuElement as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<DOMHTMLMenuElement as ClassType>::Super as ClassType>::ThreadKind
Source§impl CopyingHelper for DOMHTMLMenuElement
impl CopyingHelper for DOMHTMLMenuElement
Source§type Result = DOMHTMLMenuElement
type Result = DOMHTMLMenuElement
Self
if the type has no
immutable counterpart. Read moreSource§impl DOMEventTarget for DOMHTMLMenuElement
impl DOMEventTarget for DOMHTMLMenuElement
Source§unsafe fn addEventListener_listener_useCapture(
&self,
type: Option<&NSString>,
listener: Option<&ProtocolObject<dyn DOMEventListener>>,
use_capture: bool,
)
unsafe fn addEventListener_listener_useCapture( &self, type: Option<&NSString>, listener: Option<&ProtocolObject<dyn DOMEventListener>>, use_capture: bool, )
DOMEventTarget
and DOMEventListener
only.Source§unsafe fn removeEventListener_listener_useCapture(
&self,
type: Option<&NSString>,
listener: Option<&ProtocolObject<dyn DOMEventListener>>,
use_capture: bool,
)
unsafe fn removeEventListener_listener_useCapture( &self, type: Option<&NSString>, listener: Option<&ProtocolObject<dyn DOMEventListener>>, use_capture: bool, )
DOMEventTarget
and DOMEventListener
only.Source§unsafe fn dispatchEvent(&self, event: Option<&DOMEvent>) -> bool
unsafe fn dispatchEvent(&self, event: Option<&DOMEvent>) -> bool
DOMEvent
and DOMObject
and WebScriptObject
and DOMEventTarget
only.Source§unsafe fn addEventListener(
&self,
type: Option<&NSString>,
listener: Option<&ProtocolObject<dyn DOMEventListener>>,
use_capture: bool,
)
unsafe fn addEventListener( &self, type: Option<&NSString>, listener: Option<&ProtocolObject<dyn DOMEventListener>>, use_capture: bool, )
DOMEventTarget
and DOMEventListener
only.Source§unsafe fn removeEventListener(
&self,
type: Option<&NSString>,
listener: Option<&ProtocolObject<dyn DOMEventListener>>,
use_capture: bool,
)
unsafe fn removeEventListener( &self, type: Option<&NSString>, listener: Option<&ProtocolObject<dyn DOMEventListener>>, use_capture: bool, )
DOMEventTarget
and DOMEventListener
only.Source§impl Debug for DOMHTMLMenuElement
impl Debug for DOMHTMLMenuElement
Source§impl Deref for DOMHTMLMenuElement
impl Deref for DOMHTMLMenuElement
Source§impl Hash for DOMHTMLMenuElement
impl Hash for DOMHTMLMenuElement
Source§impl Message for DOMHTMLMenuElement
impl Message for DOMHTMLMenuElement
Source§impl NSCopying for DOMHTMLMenuElement
impl NSCopying for DOMHTMLMenuElement
Source§impl NSObjectProtocol for DOMHTMLMenuElement
impl NSObjectProtocol for DOMHTMLMenuElement
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref