Struct WebPreferences

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

👎Deprecated

Available on crate feature WebPreferences only.

Apple’s documentation

Implementations

impl WebPreferences

pub unsafe fn standardPreferences() -> Option<Retained<WebPreferences>>

👎Deprecated

pub unsafe fn initWithIdentifier( this: Allocated<Self>, an_identifier: Option<&NSString>, ) -> Option<Retained<Self>>

👎Deprecated

Parameter anIdentifier: A string used to identify the WebPreferences.

WebViews can share instances of WebPreferences by using an instance of WebPreferences with the same identifier. Typically, instance are not created directly. Instead you set the preferences identifier on a WebView. The identifier is used as a prefix that is added to the user defaults keys for the WebPreferences.

Returns: Returns a new instance of WebPreferences or a previously allocated instance with the same identifier.

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

👎Deprecated

Returns: Returns the identifier for this WebPreferences.

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

👎Deprecated

pub unsafe fn setStandardFontFamily( &self, standard_font_family: Option<&NSString>, )

👎Deprecated

Setter for standardFontFamily.

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

👎Deprecated

pub unsafe fn setFixedFontFamily(&self, fixed_font_family: Option<&NSString>)

👎Deprecated

Setter for fixedFontFamily.

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

👎Deprecated

pub unsafe fn setSerifFontFamily(&self, serif_font_family: Option<&NSString>)

👎Deprecated

Setter for serifFontFamily.

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

👎Deprecated

pub unsafe fn setSansSerifFontFamily( &self, sans_serif_font_family: Option<&NSString>, )

👎Deprecated

Setter for sansSerifFontFamily.

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

👎Deprecated

pub unsafe fn setCursiveFontFamily( &self, cursive_font_family: Option<&NSString>, )

👎Deprecated

Setter for cursiveFontFamily.

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

👎Deprecated

pub unsafe fn setFantasyFontFamily( &self, fantasy_font_family: Option<&NSString>, )

👎Deprecated

Setter for fantasyFontFamily.

pub unsafe fn defaultFontSize(&self) -> c_int

👎Deprecated

pub unsafe fn setDefaultFontSize(&self, default_font_size: c_int)

👎Deprecated

Setter for defaultFontSize.

pub unsafe fn defaultFixedFontSize(&self) -> c_int

👎Deprecated

pub unsafe fn setDefaultFixedFontSize(&self, default_fixed_font_size: c_int)

👎Deprecated

Setter for defaultFixedFontSize.

pub unsafe fn minimumFontSize(&self) -> c_int

👎Deprecated

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

👎Deprecated

Setter for minimumFontSize.

pub unsafe fn minimumLogicalFontSize(&self) -> c_int

👎Deprecated

pub unsafe fn setMinimumLogicalFontSize(&self, minimum_logical_font_size: c_int)

👎Deprecated

Setter for minimumLogicalFontSize.

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

👎Deprecated

pub unsafe fn setDefaultTextEncodingName( &self, default_text_encoding_name: Option<&NSString>, )

👎Deprecated

Setter for defaultTextEncodingName.

pub unsafe fn userStyleSheetEnabled(&self) -> bool

👎Deprecated

pub unsafe fn setUserStyleSheetEnabled(&self, user_style_sheet_enabled: bool)

👎Deprecated

Setter for userStyleSheetEnabled.

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

👎Deprecated

The location of the user style sheet.

pub unsafe fn setUserStyleSheetLocation( &self, user_style_sheet_location: Option<&NSURL>, )

👎Deprecated

Setter for userStyleSheetLocation.

pub unsafe fn isJavaEnabled(&self) -> bool

👎Deprecated

Deprecated function that does nothing and always returns false.

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

👎Deprecated

Setter for isJavaEnabled.

pub unsafe fn isJavaScriptEnabled(&self) -> bool

👎Deprecated

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

👎Deprecated

Setter for isJavaScriptEnabled.

pub unsafe fn javaScriptCanOpenWindowsAutomatically(&self) -> bool

👎Deprecated

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

👎Deprecated

Setter for javaScriptCanOpenWindowsAutomatically.

pub unsafe fn arePlugInsEnabled(&self) -> bool

👎Deprecated

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

👎Deprecated

Setter for arePlugInsEnabled.

pub unsafe fn allowsAnimatedImages(&self) -> bool

👎Deprecated

pub unsafe fn setAllowsAnimatedImages(&self, allows_animated_images: bool)

👎Deprecated

Setter for allowsAnimatedImages.

pub unsafe fn allowsAnimatedImageLooping(&self) -> bool

👎Deprecated

pub unsafe fn setAllowsAnimatedImageLooping( &self, allows_animated_image_looping: bool, )

👎Deprecated

Setter for allowsAnimatedImageLooping.

pub unsafe fn loadsImagesAutomatically(&self) -> bool

👎Deprecated

pub unsafe fn setLoadsImagesAutomatically( &self, loads_images_automatically: bool, )

👎Deprecated

Setter for loadsImagesAutomatically.

pub unsafe fn autosaves(&self) -> bool

👎Deprecated

If autosaves is YES the settings represented by WebPreferences will be stored in the user defaults database.

pub unsafe fn setAutosaves(&self, autosaves: bool)

👎Deprecated

Setter for autosaves.

pub unsafe fn shouldPrintBackgrounds(&self) -> bool

👎Deprecated

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

👎Deprecated

Setter for shouldPrintBackgrounds.

pub unsafe fn privateBrowsingEnabled(&self) -> bool

👎Deprecated

If private browsing is enabled, WebKit will not store information about sites the user visits.

pub unsafe fn setPrivateBrowsingEnabled(&self, private_browsing_enabled: bool)

👎Deprecated

Setter for privateBrowsingEnabled.

pub unsafe fn tabsToLinks(&self) -> bool

👎Deprecated

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

pub unsafe fn setTabsToLinks(&self, tabs_to_links: bool)

👎Deprecated

Setter for tabsToLinks.

pub unsafe fn usesPageCache(&self) -> bool

👎Deprecated

Whether the receiver’s associated WebViews use the shared page cache.

Pages are cached as they are added to a WebBackForwardList, and removed from the cache as they are removed from a WebBackForwardList. Because the page cache is global, caching a page in one WebBackForwardList may cause a page in another WebBackForwardList to be evicted from the cache.

pub unsafe fn setUsesPageCache(&self, uses_page_cache: bool)

👎Deprecated

Setter for usesPageCache.

pub unsafe fn cacheModel(&self) -> WebCacheModel

👎Deprecated

Specifies a usage model for a WebView, which WebKit will use to determine its caching behavior. If necessary, WebKit will prune its caches to match cacheModel when set.

Research indicates that users tend to browse within clusters of documents that hold resources in common, and to revisit previously visited documents. WebKit and the frameworks below it include built-in caches that take advantage of these patterns, substantially improving document load speed in browsing situations. The WebKit cache model controls the behaviors of all of these caches, including NSURLCache and the various WebCore caches.

Applications with a browsing interface can improve document load speed substantially by specifying WebCacheModelDocumentBrowser. Applications without a browsing interface can reduce memory usage substantially by specifying WebCacheModelDocumentViewer.

If cacheModel is not set, WebKit will select a cache model automatically.

pub unsafe fn setCacheModel(&self, cache_model: WebCacheModel)

👎Deprecated

Setter for cacheModel.

pub unsafe fn suppressesIncrementalRendering(&self) -> bool

👎Deprecated

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

👎Deprecated

Setter for suppressesIncrementalRendering.

pub unsafe fn allowsAirPlayForMediaPlayback(&self) -> bool

👎Deprecated

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

👎Deprecated

Setter for allowsAirPlayForMediaPlayback.

impl WebPreferences

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 WebPreferences

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for WebPreferences

fn as_ref(&self) -> &NSObject

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

impl AsRef<WebPreferences> for WebPreferences

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for WebPreferences

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for WebPreferences

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for WebPreferences

const NAME: &'static str = "WebPreferences"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<WebPreferences 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 WebPreferences

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

Formats the value using the given formatter.

impl Deref for WebPreferences

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for WebPreferences

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 WebPreferences

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for WebPreferences

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 WebPreferences

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 WebPreferences

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 WebPreferences

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

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

impl DowncastTarget for WebPreferences

impl Eq for WebPreferences