Struct WKPreferences

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

Available on crate feature WKPreferences only.

A WKPreferences object encapsulates the preference settings for a web view. The preferences object associated with a web view is specified by its web view configuration.

See also Apple’s documentation

Implementations

impl WKPreferences

pub unsafe fn minimumFontSize(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The minimum font size in points.

The default value is 0.

pub unsafe fn setMinimumFontSize(&self, minimum_font_size: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for minimumFontSize.

pub unsafe fn javaScriptCanOpenWindowsAutomatically(&self) -> bool

A Boolean value indicating whether JavaScript can open windows without user interaction.

The default value is NO in iOS and YES in OS X.

pub unsafe fn setJavaScriptCanOpenWindowsAutomatically( &self, java_script_can_open_windows_automatically: bool, )

Setter for javaScriptCanOpenWindowsAutomatically.

pub unsafe fn isFraudulentWebsiteWarningEnabled(&self) -> bool

A Boolean value indicating whether warnings should be shown for suspected fraudulent content such as phishing or malware.

The default value is YES.

pub unsafe fn setFraudulentWebsiteWarningEnabled( &self, fraudulent_website_warning_enabled: bool, )

Setter for isFraudulentWebsiteWarningEnabled.

pub unsafe fn shouldPrintBackgrounds(&self) -> bool

A Boolean value indicating whether the web view should include backgrounds when printing.

The default value is NO.

pub unsafe fn setShouldPrintBackgrounds(&self, should_print_backgrounds: bool)

Setter for shouldPrintBackgrounds.

pub unsafe fn tabFocusesLinks(&self) -> bool

If tabFocusesLinks is YES, the tab key will focus links and form controls. The Option key temporarily reverses this preference.

pub unsafe fn setTabFocusesLinks(&self, tab_focuses_links: bool)

Setter for tabFocusesLinks.

pub unsafe fn isTextInteractionEnabled(&self) -> bool

A Boolean value indicating whether text interaction is disabled.

pub unsafe fn setTextInteractionEnabled(&self, text_interaction_enabled: bool)

Setter for isTextInteractionEnabled.

pub unsafe fn isSiteSpecificQuirksModeEnabled(&self) -> bool

A Boolean value indicating whether WebKit will apply built-in workarounds (quirks) to improve compatibility with certain known websites. You can disable site-specific quirks to help test your website without these workarounds. Enabled by default.

pub unsafe fn setSiteSpecificQuirksModeEnabled( &self, site_specific_quirks_mode_enabled: bool, )

Setter for isSiteSpecificQuirksModeEnabled.

pub unsafe fn isElementFullscreenEnabled(&self) -> bool

A Boolean value indicating whether Fullscreen API is enabled.

The default value is NO. We can set it to YES to enable support for the fullscreen API.

pub unsafe fn setElementFullscreenEnabled( &self, element_fullscreen_enabled: bool, )

Setter for isElementFullscreenEnabled.

pub unsafe fn inactiveSchedulingPolicy(&self) -> WKInactiveSchedulingPolicy

Specify the scheduling policy for the web view when it is inactive and detached from the view hierarchy. Web views are not considered idle when playing media or loading web pages. A suspended web view will pause JavaScript execution and page layout.

pub unsafe fn setInactiveSchedulingPolicy( &self, inactive_scheduling_policy: WKInactiveSchedulingPolicy, )

Setter for inactiveSchedulingPolicy.

impl WKPreferences

Methods declared on superclass NSObject.

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

pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>

impl WKPreferences

WKDeprecated.

pub unsafe fn javaEnabled(&self) -> bool

👎Deprecated: Java is no longer supported

pub unsafe fn setJavaEnabled(&self, java_enabled: bool)

👎Deprecated: Java is no longer supported

Setter for javaEnabled.

pub unsafe fn plugInsEnabled(&self) -> bool

👎Deprecated: Plug-ins are no longer supported

pub unsafe fn setPlugInsEnabled(&self, plug_ins_enabled: bool)

👎Deprecated: Plug-ins are no longer supported

Setter for plugInsEnabled.

pub unsafe fn javaScriptEnabled(&self) -> bool

👎Deprecated: Use WKWebpagePreferences.allowsContentJavaScript to disable content JavaScript on a per-navigation basis

pub unsafe fn setJavaScriptEnabled(&self, java_script_enabled: bool)

👎Deprecated: Use WKWebpagePreferences.allowsContentJavaScript to disable content JavaScript on a per-navigation basis

Setter for javaScriptEnabled.

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 WKPreferences

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for WKPreferences

fn as_ref(&self) -> &NSObject

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

impl AsRef<WKPreferences> for WKPreferences

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for WKPreferences

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for WKPreferences

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for WKPreferences

const NAME: &'static str = "WKPreferences"

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 Debug for WKPreferences

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

Formats the value using the given formatter.

impl Deref for WKPreferences

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for WKPreferences

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 WKPreferences

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for WKPreferences

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 NSObjectProtocol for WKPreferences

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 WKPreferences

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for WKPreferences

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 WKPreferences

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

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

impl DowncastTarget for WKPreferences

impl Eq for WKPreferences