Struct WebFrame

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

👎Deprecated

Available on crate feature WebFrame only.

Every web page is represented by at least one WebFrame. A WebFrame has a WebFrameView and a WebDataSource.

See also Apple’s documentation

Implementations

impl WebFrame

pub unsafe fn initWithName_webFrameView_webView( this: Allocated<Self>, name: Option<&NSString>, view: Option<&WebFrameView>, web_view: Option<&WebView>, ) -> Option<Retained<Self>>

👎Deprecated

Available on crate feature WebFrameView and crate feature WebView and crate feature objc2-app-kit and macOS only.

The designated initializer of WebFrame.

WebFrames are normally created for you by the WebView. You should not need to invoke this method directly.

Parameter name: The name of the frame.

Parameter view: The WebFrameView for the frame.

Parameter webView: The WebView that manages the frame.

Returns: Returns an initialized WebFrame.

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

👎Deprecated

The frame name.

pub unsafe fn webView(&self, mtm: MainThreadMarker) -> Option<Retained<WebView>>

👎Deprecated

Available on crate feature WebView and crate feature objc2-app-kit and macOS only.

The WebView for the document that includes this frame.

pub unsafe fn frameView( &self, mtm: MainThreadMarker, ) -> Option<Retained<WebFrameView>>

👎Deprecated

Available on crate feature WebFrameView and crate feature objc2-app-kit and macOS only.

The WebFrameView for this frame.

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

👎Deprecated

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

The DOM document of the frame. Returns nil if the frame does not contain a DOM document such as a standalone image.

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

👎Deprecated

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

The frame element of the frame. The class of the result is either DOMHTMLFrameElement, DOMHTMLIFrameElement or DOMHTMLObjectElement. Returns nil if the frame is the main frame since there is no frame element for the frame in this case.

pub unsafe fn loadRequest(&self, request: Option<&NSURLRequest>)

👎Deprecated

Parameter request: The web request to load.

pub unsafe fn loadData_MIMEType_textEncodingName_baseURL( &self, data: Option<&NSData>, mime_type: Option<&NSString>, encoding_name: Option<&NSString>, url: Option<&NSURL>, )

👎Deprecated

Parameter data: The data to use for the main page of the document.

Parameter MIMEType: The MIME type of the data.

Parameter encodingName: The encoding of the data.

Parameter URL: The base URL to apply to relative URLs within the document.

pub unsafe fn loadHTMLString_baseURL( &self, string: Option<&NSString>, url: Option<&NSURL>, )

👎Deprecated

Parameter string: The string to use for the main page of the document.

Parameter URL: The base URL to apply to relative URLs within the document.

pub unsafe fn loadAlternateHTMLString_baseURL_forUnreachableURL( &self, string: Option<&NSString>, base_url: Option<&NSURL>, unreachable_url: Option<&NSURL>, )

👎Deprecated

Loads a page to display as a substitute for a URL that could not be reached.

This allows clients to display page-loading errors in the webview itself. This is typically called while processing the WebFrameLoadDelegate method -webView:didFailProvisionalLoadWithError:forFrame: or one of the WebPolicyDelegate methods -webView:decidePolicyForMIMEType:request:frame:decisionListener: or -webView:unableToImplementPolicyWithError:frame:. If it is called from within one of those three delegate methods then the back/forward list will be maintained appropriately.

Parameter string: The string to use for the main page of the document.

Parameter baseURL: The baseURL to apply to relative URLs within the document.

Parameter unreachableURL: The URL for which this page will serve as alternate content.

pub unsafe fn loadArchive(&self, archive: Option<&WebArchive>)

👎Deprecated

Available on crate feature WebArchive only.

Causes WebFrame to load a WebArchive.

Parameter archive: The archive to be loaded.

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

👎Deprecated

Available on crate feature WebDataSource only.

The datasource for this frame.

Returns the committed data source. Will return nil if the provisional data source hasn’t yet been loaded.

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

👎Deprecated

Available on crate feature WebDataSource only.

The provisional datasource of this frame.

Will return the provisional data source. The provisional data source will be nil if no data source has been set on the frame, or the data source has successfully transitioned to the committed data source.

pub unsafe fn stopLoading(&self)

👎Deprecated

Stop any pending loads on the frame’s data source, and its children.

pub unsafe fn reload(&self)

👎Deprecated

Performs HTTP/1.1 end-to-end revalidation using cache-validating conditionals if possible.

pub unsafe fn reloadFromOrigin(&self)

👎Deprecated

Performs HTTP/1.1 end-to-end reload.

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

👎Deprecated

This method returns a frame with the given name. findFrameNamed returns self for _self and _current, the parent frame for _parent and the main frame for _top. findFrameNamed returns self for _parent and _top if the receiver is the mainFrame. findFrameNamed first searches from the current frame to all descending frames then the rest of the frames in the WebView. If still not found, findFrameNamed searches the frames of the other WebViews.

Parameter name: The name of the frame to find.

Returns: The frame matching the provided name. nil if the frame is not found.

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

👎Deprecated

The frame containing this frame, or nil if this is a top level frame.

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

👎Deprecated

An array of WebFrame.

The frames in the array are associated with a frame set or iframe.

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

👎Deprecated

Available on crate feature WebScriptObject only.

The WebScriptObject representing the frame’s JavaScript window object.

impl WebFrame

Methods declared on superclass NSObject.

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

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

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 WebFrame

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for WebFrame

fn as_ref(&self) -> &NSObject

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

impl AsRef<WebFrame> for WebFrame

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for WebFrame

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for WebFrame

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for WebFrame

const NAME: &'static str = "WebFrame"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<WebFrame 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 Debug for WebFrame

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

Formats the value using the given formatter.

impl Deref for WebFrame

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for WebFrame

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 WebFrame

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for WebFrame

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 WebFrame

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 WebFrame

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

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

impl DowncastTarget for WebFrame

impl Eq for WebFrame