Struct WKWebViewConfiguration

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

Available on crate feature WKWebViewConfiguration only.

A WKWebViewConfiguration object is a collection of properties with which to initialize a web view.

Contains properties used to configure a

 WKWebView

.

See also Apple’s documentation

Implementations

impl WKWebViewConfiguration

pub unsafe fn processPool(&self) -> Retained<WKProcessPool>

Available on crate feature WKProcessPool only.

The process pool from which to obtain the view’s web content process.

When a web view is initialized, a new web content process will be created for it from the specified pool, or an existing process in that pool will be used.

pub unsafe fn setProcessPool(&self, process_pool: &WKProcessPool)

Available on crate feature WKProcessPool only.

Setter for processPool.

pub unsafe fn preferences(&self) -> Retained<WKPreferences>

Available on crate feature WKPreferences only.

The preference settings to be used by the web view.

pub unsafe fn setPreferences(&self, preferences: &WKPreferences)

Available on crate feature WKPreferences only.

Setter for preferences.

pub unsafe fn userContentController(&self) -> Retained<WKUserContentController>

Available on crate feature WKUserContentController only.

The user content controller to associate with the web view.

pub unsafe fn setUserContentController( &self, user_content_controller: &WKUserContentController, )

Available on crate feature WKUserContentController only.

Setter for userContentController.

pub unsafe fn websiteDataStore(&self) -> Retained<WKWebsiteDataStore>

Available on crate feature WKWebsiteDataStore only.

The website data store to be used by the web view.

pub unsafe fn setWebsiteDataStore( &self, website_data_store: &WKWebsiteDataStore, )

Available on crate feature WKWebsiteDataStore only.

Setter for websiteDataStore.

pub unsafe fn suppressesIncrementalRendering(&self) -> bool

A Boolean value indicating whether the web view suppresses content rendering until it is fully loaded into memory.

The default value is NO.

pub unsafe fn setSuppressesIncrementalRendering( &self, suppresses_incremental_rendering: bool, )

Setter for suppressesIncrementalRendering.

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

The name of the application as used in the user agent string.

pub unsafe fn setApplicationNameForUserAgent( &self, application_name_for_user_agent: Option<&NSString>, )

Setter for applicationNameForUserAgent.

pub unsafe fn allowsAirPlayForMediaPlayback(&self) -> bool

A Boolean value indicating whether AirPlay is allowed.

The default value is YES.

pub unsafe fn setAllowsAirPlayForMediaPlayback( &self, allows_air_play_for_media_playback: bool, )

Setter for allowsAirPlayForMediaPlayback.

pub unsafe fn upgradeKnownHostsToHTTPS(&self) -> bool

A Boolean value indicating whether HTTP requests to servers known to support HTTPS should be automatically upgraded to HTTPS requests.

The default value is YES.

pub unsafe fn setUpgradeKnownHostsToHTTPS( &self, upgrade_known_hosts_to_https: bool, )

Setter for upgradeKnownHostsToHTTPS.

pub unsafe fn mediaTypesRequiringUserActionForPlayback( &self, ) -> WKAudiovisualMediaTypes

pub unsafe fn setMediaTypesRequiringUserActionForPlayback( &self, media_types_requiring_user_action_for_playback: WKAudiovisualMediaTypes, )

Setter for mediaTypesRequiringUserActionForPlayback.

pub unsafe fn defaultWebpagePreferences(&self) -> Retained<WKWebpagePreferences>

Available on crate feature WKWebpagePreferences only.

The set of default webpage preferences to use when loading and rendering content.

These default webpage preferences are additionally passed to the navigation delegate in -webView:decidePolicyForNavigationAction:preferences:decisionHandler:.

pub unsafe fn setDefaultWebpagePreferences( &self, default_webpage_preferences: Option<&WKWebpagePreferences>, )

Available on crate feature WKWebpagePreferences only.

Setter for defaultWebpagePreferences.

pub unsafe fn limitsNavigationsToAppBoundDomains(&self) -> bool

pub unsafe fn setLimitsNavigationsToAppBoundDomains( &self, limits_navigations_to_app_bound_domains: bool, )

Setter for limitsNavigationsToAppBoundDomains.

pub unsafe fn allowsInlinePredictions(&self) -> bool

A Boolean value indicating whether inline predictions are allowed.

The default value is NO. If false, inline predictions are disabled regardless of the system setting. If true, they are enabled based on the system setting.

pub unsafe fn setAllowsInlinePredictions(&self, allows_inline_predictions: bool)

Setter for allowsInlinePredictions.

pub unsafe fn userInterfaceDirectionPolicy( &self, ) -> WKUserInterfaceDirectionPolicy

The directionality of user interface elements.

Possible values are described in WKUserInterfaceDirectionPolicy. The default value is WKUserInterfaceDirectionPolicyContent.

pub unsafe fn setUserInterfaceDirectionPolicy( &self, user_interface_direction_policy: WKUserInterfaceDirectionPolicy, )

Setter for userInterfaceDirectionPolicy.

pub unsafe fn setURLSchemeHandler_forURLScheme( &self, url_scheme_handler: Option<&ProtocolObject<dyn WKURLSchemeHandler>>, url_scheme: &NSString, )

Available on crate feature WKURLSchemeHandler only.

pub unsafe fn urlSchemeHandlerForURLScheme( &self, url_scheme: &NSString, ) -> Option<Retained<ProtocolObject<dyn WKURLSchemeHandler>>>

Available on crate feature WKURLSchemeHandler only.

pub unsafe fn supportsAdaptiveImageGlyph(&self) -> bool

A Boolean value indicating whether insertion of adaptive image glyphs is allowed.

The default value is NO. If NO, adaptive image glyphs are inserted as regular images. If YES, they are inserted with the full adaptive sizing behavior.

pub unsafe fn setSupportsAdaptiveImageGlyph( &self, supports_adaptive_image_glyph: bool, )

Setter for supportsAdaptiveImageGlyph.

pub unsafe fn writingToolsBehavior(&self) -> NSWritingToolsBehavior

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

The preferred behavior of Writing Tools.

The default behavior is equivalent to NSWritingToolsBehaviorLimited.

pub unsafe fn setWritingToolsBehavior( &self, writing_tools_behavior: NSWritingToolsBehavior, )

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

Setter for writingToolsBehavior.

impl WKWebViewConfiguration

Methods declared on superclass NSObject.

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

pub unsafe fn new(mtm: MainThreadMarker) -> 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 WKWebViewConfiguration

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for WKWebViewConfiguration

fn as_ref(&self) -> &NSObject

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

impl AsRef<WKWebViewConfiguration> for WKWebViewConfiguration

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for WKWebViewConfiguration

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for WKWebViewConfiguration

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for WKWebViewConfiguration

const NAME: &'static str = "WKWebViewConfiguration"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = dyn MainThreadOnly

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 WKWebViewConfiguration

type Result = WKWebViewConfiguration

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

impl Debug for WKWebViewConfiguration

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

Formats the value using the given formatter.

impl Deref for WKWebViewConfiguration

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for WKWebViewConfiguration

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 WKWebViewConfiguration

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for WKWebViewConfiguration

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Available on crate feature NSCoder only.

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSCopying for WKWebViewConfiguration

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 WKWebViewConfiguration

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 NSSecureCoding for WKWebViewConfiguration

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for WKWebViewConfiguration

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 WKWebViewConfiguration

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

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

impl DowncastTarget for WKWebViewConfiguration

impl Eq for WKWebViewConfiguration