Struct WKWebExtensionTabConfiguration

Source

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

Available on crate feature WKWebExtensionTabConfiguration only.

Expand description

A WKWebExtensionTabConfiguration object encapsulates configuration options for a tab in an extension.

This class holds various options that influence the behavior and initial state of a tab. The app retains the discretion to disregard any or all of these options, or even opt not to create a tab.

Implementations§

Source §

pub unsafe fn window( &self, ) -> Option<Retained<ProtocolObject<dyn WKWebExtensionWindow>>>

Available on crate feature WKWebExtensionWindow only.

Indicates the window where the tab should be opened.

If this property is nil, no window was specified.

Source

pub unsafe fn index(&self) -> NSUInteger

Indicates the position where the tab should be opened within the window.

Source

pub unsafe fn parentTab( &self, ) -> Option<Retained<ProtocolObject<dyn WKWebExtensionTab>>>

Available on crate feature WKWebExtensionTab only.

Indicates the parent tab with which the tab should be related.

If this property is nil, no parent tab was specified.

Source

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

Indicates the initial URL for the tab.

If this property is nil, the app’s default “start page” should appear in the tab.

Source

pub unsafe fn shouldBeActive(&self) -> bool

Indicates whether the tab should be the active tab.

If this property is YES, the tab should be made active in the window, ensuring it is the frontmost tab. Being active implies the tab is also selected. If this property is NO, the tab shouldn’t affect the currently active tab.

Source

pub unsafe fn shouldAddToSelection(&self) -> bool

Indicates whether the tab should be added to the current tab selection.

If this property is YES, the tab should be part of the current selection, but not necessarily become the active tab unless shouldBeActive is also YES. If this property is NO, the tab shouldn’t be part of the current selection.

Source

pub unsafe fn shouldBePinned(&self) -> bool

Indicates whether the tab should be pinned.

Source

pub unsafe fn shouldBeMuted(&self) -> bool

Indicates whether the tab should be muted.

Source

pub unsafe fn shouldReaderModeBeActive(&self) -> bool

Indicates whether reader mode in the tab should be active.

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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