Struct STWebpageController 

pub struct STWebpageController { /* private fields */ }

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

Apple’s documentation

Implementations

impl STWebpageController

pub unsafe fn suppressUsageRecording(&self) -> bool

A Boolean that indicates whether the webpage controller is not recording web usage.

Set to <doc ://com.apple.documentation/documentation/objectivec/yes> to stop recording and reporting web-usage data.

pub unsafe fn setSuppressUsageRecording(&self, suppress_usage_recording: bool)

Setter for suppressUsageRecording.

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

The URL for the webpage.

Set this value to the webpage’s URL when the user navigates to a new URL.

pub unsafe fn setURL(&self, url: Option<&NSURL>)

Setter for URL.

This is copied when set.

pub unsafe fn URLIsPlayingVideo(&self) -> bool

A Boolean that indicates whether there are one or more videos currently playing in the webpage.

The default value is <doc ://com.apple.documentation/documentation/objectivec/no>. Set this value when the webpage starts or stops playing video.

• Important: Set this value to <doc ://com.apple.documentation/documentation/objectivec/no> prior to changing ScreenTime/STWebpageController/URL if the new webpage at that URL stops currently playing media and won’t immediately start playing new media.

pub unsafe fn setURLIsPlayingVideo(&self, url_is_playing_video: bool)

Setter for URLIsPlayingVideo.

pub unsafe fn URLIsPictureInPicture(&self) -> bool

A Boolean that indicates whether the webpage is currently displaying a floating picture in picture window.

The default value is <doc ://com.apple.documentation/documentation/objectivec/no>. Set this value when the webpage starts or stops displaying a Picture in Picture window.

• Important: Set this value to <doc ://com.apple.documentation/documentation/objectivec/no> prior to changing ScreenTime/STWebpageController/URL if the new webpage at that URL ends all currently displayed Picture in Picture windows, and won’t immediately display a new one.

pub unsafe fn setURLIsPictureInPicture(&self, url_is_picture_in_picture: bool)

Setter for URLIsPictureInPicture.

pub unsafe fn URLIsBlocked(&self) -> bool

A Boolean that indicates whether a parent or guardian has blocked the URL.

When a parent or guardian blocks the webpage’s URL, the webpage controller displays a blocking UI and then sets this property to <doc ://com.apple.documentation/documentation/objectivec/yes>.

pub unsafe fn profileIdentifier( &self, ) -> Option<Retained<STWebHistoryProfileIdentifier>>

Available on crate feature STWebHistory only.

An optional identifier for the current browsing profile.

The default value is nil. This identifier represents a profile and allows you to keep your browsing separate for topics like work, personal, or school. Using nil will report web history without a profile identifier. Web browsers with a “default” profile may want to use nil in order to match any web history reported prior to this API.

pub unsafe fn setProfileIdentifier( &self, profile_identifier: Option<&STWebHistoryProfileIdentifier>, )

Available on crate feature STWebHistory only.

Setter for profileIdentifier.

This is copied when set.

pub unsafe fn setBundleIdentifier_error( &self, bundle_identifier: &NSString, ) -> Result<(), Retained<NSError>>

Changes the bundle identifier used to report web usage.

This is only supported for web browsers that have been properly registered with Screen Time.

• Parameters:
• bundleIdentifier: The bundle identifier that can be changed to facilitate web usage reporting for a parent web browser from one of its helper processes or extensions.
• error: Any error that occurred while changing the bundle identifier.

pub unsafe fn initWithNibName_bundle( this: Allocated<Self>, nib_name_or_nil: Option<&NSString>, nib_bundle_or_nil: Option<&NSBundle>, ) -> Retained<Self>

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

Safety

a_decoder possibly has further requirements.

impl STWebpageController

Methods declared on superclass NSResponder.

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

impl STWebpageController

Methods declared on superclass NSObject.

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

Methods from Deref<Target = NSViewController>

pub fn nibBundle(&self) -> Option<Retained<NSBundle>>

pub fn representedObject(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setRepresentedObject( &self, represented_object: Option<&AnyObject>, )

Setter for representedObject.

Safety

represented_object should be of the correct type.

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

pub fn setTitle(&self, title: Option<&NSString>)

Setter for title.

This is copied when set.

pub fn loadView(&self)

pub fn loadViewIfNeeded(&self)

pub unsafe fn commitEditingWithDelegate_didCommitSelector_contextInfo( &self, delegate: Option<&AnyObject>, did_commit_selector: Option<Sel>, context_info: *mut c_void, )

Safety

• delegate should be of the correct type.
• did_commit_selector must be a valid selector.
• context_info must be a valid pointer or null.

pub fn commitEditing(&self) -> bool

pub fn discardEditing(&self)

pub fn viewDidLoad(&self)

pub fn isViewLoaded(&self) -> bool

pub fn viewWillAppear(&self)

pub fn viewDidAppear(&self)

pub fn viewWillDisappear(&self)

pub fn viewDidDisappear(&self)

pub fn preferredContentSize(&self) -> CGSize

pub fn setPreferredContentSize(&self, preferred_content_size: CGSize)

Setter for preferredContentSize.

pub fn updateViewConstraints(&self)

pub fn viewWillLayout(&self)

pub fn viewDidLayout(&self)

pub fn presentViewController_animator( &self, view_controller: &NSViewController, animator: &ProtocolObject<dyn NSViewControllerPresentationAnimator>, )

pub fn dismissViewController(&self, view_controller: &NSViewController)

pub unsafe fn dismissController(&self, sender: Option<&AnyObject>)

Safety

sender should be of the correct type.

pub fn presentedViewControllers( &self, ) -> Option<Retained<NSArray<NSViewController>>>

pub unsafe fn presentingViewController( &self, ) -> Option<Retained<NSViewController>>

Safety

This is not retained internally, you must ensure the object is still alive.

pub fn presentViewControllerAsSheet(&self, view_controller: &NSViewController)

pub fn presentViewControllerAsModalWindow( &self, view_controller: &NSViewController, )

pub fn parentViewController(&self) -> Option<Retained<NSViewController>>

pub fn childViewControllers(&self) -> Retained<NSArray<NSViewController>>

pub fn setChildViewControllers( &self, child_view_controllers: &NSArray<NSViewController>, )

Setter for childViewControllers.

This is copied when set.

pub fn addChildViewController(&self, child_view_controller: &NSViewController)

pub fn removeFromParentViewController(&self)

pub fn insertChildViewController_atIndex( &self, child_view_controller: &NSViewController, index: isize, )

pub fn removeChildViewControllerAtIndex(&self, index: isize)

pub fn preferredContentSizeDidChangeForViewController( &self, view_controller: &NSViewController, )

pub fn viewWillTransitionToSize(&self, new_size: CGSize)

pub fn extensionContext(&self) -> Option<Retained<NSExtensionContext>>

pub fn preferredScreenOrigin(&self) -> CGPoint

pub fn setPreferredScreenOrigin(&self, preferred_screen_origin: CGPoint)

Setter for preferredScreenOrigin.

pub fn preferredMinimumSize(&self) -> CGSize

pub fn preferredMaximumSize(&self) -> CGSize

Methods from Deref<Target = NSResponder>

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

Safety

This is not retained internally, you must ensure the object is still alive.

pub unsafe fn setNextResponder(&self, next_responder: Option<&NSResponder>)

Setter for nextResponder.

Safety

This is unretained, you must ensure the object is kept alive while in use.

pub unsafe fn tryToPerform_with( &self, action: Sel, object: Option<&AnyObject>, ) -> bool

Safety

• action must be a valid selector.
• object should be of the correct type.

pub unsafe fn noResponderFor(&self, event_selector: Sel)

Safety

event_selector must be a valid selector.

pub fn acceptsFirstResponder(&self) -> bool

pub fn becomeFirstResponder(&self) -> bool

pub fn resignFirstResponder(&self) -> bool

pub fn flushBufferedKeyEvents(&self)

pub unsafe fn showContextHelp(&self, sender: Option<&AnyObject>)

Safety

sender should be of the correct type.

pub unsafe fn supplementalTargetForAction_sender( &self, action: Sel, sender: Option<&AnyObject>, ) -> Option<Retained<AnyObject>>

Safety

• action must be a valid selector.
• sender should be of the correct type.

pub fn undoManager(&self) -> Option<Retained<NSUndoManager>>

pub fn presentError(&self, error: &NSError) -> bool

pub fn willPresentError(&self, error: &NSError) -> Retained<NSError>

pub unsafe fn performTextFinderAction(&self, sender: Option<&AnyObject>)

Safety

sender should be of the correct type.

pub unsafe fn newWindowForTab(&self, sender: Option<&AnyObject>)

Safety

sender should be of the correct type.

pub unsafe fn showWritingTools(&self, sender: Option<&AnyObject>)

Safety

sender should be of the correct type.

pub fn performMnemonic(&self, string: &NSString) -> bool

👎Deprecated: This has always returned NO and had no effect on macOS

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.

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

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 STWebpageController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for STWebpageController

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSResponder> for STWebpageController

fn as_ref(&self) -> &NSResponder

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

impl AsRef<NSViewController> for STWebpageController

fn as_ref(&self) -> &NSViewController

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

impl AsRef<STWebpageController> for STWebpageController

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for STWebpageController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for STWebpageController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSResponder> for STWebpageController

fn borrow(&self) -> &NSResponder

Immutably borrows from an owned value.

impl Borrow<NSViewController> for STWebpageController

fn borrow(&self) -> &NSViewController

Immutably borrows from an owned value.

impl ClassType for STWebpageController

const NAME: &'static str = "STWebpageController"

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

type Super = NSViewController

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for STWebpageController

type Target = NSViewController

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for STWebpageController

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 STWebpageController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for STWebpageController

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

impl NSEditor for STWebpageController

fn discardEditing(&self)

where Self: Sized + Message,

fn commitEditing(&self) -> bool

where Self: Sized + Message,

unsafe fn commitEditingWithDelegate_didCommitSelector_contextInfo( &self, delegate: Option<&AnyObject>, did_commit_selector: Option<Sel>, context_info: *mut c_void, )

where Self: Sized + Message,

Safety

fn commitEditingAndReturnError(&self) -> Result<(), Retained<NSError>>

where Self: Sized + Message,

impl NSObjectProtocol for STWebpageController

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 NSSeguePerforming for STWebpageController

unsafe fn prepareForSegue_sender( &self, segue: &NSStoryboardSegue, sender: Option<&AnyObject>, )

where Self: Sized + Message,

Safety

unsafe fn performSegueWithIdentifier_sender( &self, identifier: &NSString, sender: Option<&AnyObject>, )

where Self: Sized + Message,

Safety

unsafe fn shouldPerformSegueWithIdentifier_sender( &self, identifier: &NSString, sender: Option<&AnyObject>, ) -> bool

where Self: Sized + Message,

Safety

impl NSUserInterfaceItemIdentification for STWebpageController

fn identifier(&self) -> Option<Retained<NSString>>

where Self: Sized + Message,

fn setIdentifier(&self, identifier: Option<&NSString>)

where Self: Sized + Message,

Setter for identifier.

impl PartialEq for STWebpageController

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 STWebpageController

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

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

impl DowncastTarget for STWebpageController

impl Eq for STWebpageController