Struct UISheetPresentationController

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

Available on crate features UIPresentationController and UISheetPresentationController only.

Apple’s documentation

Implementations

impl UISheetPresentationController

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn UISheetPresentationControllerDelegate>>>

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn UISheetPresentationControllerDelegate>>, )

This is a weak property. Setter for delegate.

pub unsafe fn sourceView(&self) -> Option<Retained<UIView>>

Available on crate features UIResponder and UIView only.

pub unsafe fn setSourceView(&self, source_view: Option<&UIView>)

Available on crate features UIResponder and UIView only.

Setter for sourceView.

pub unsafe fn prefersPageSizing(&self) -> bool

pub unsafe fn setPrefersPageSizing(&self, prefers_page_sizing: bool)

Setter for prefersPageSizing.

pub unsafe fn prefersEdgeAttachedInCompactHeight(&self) -> bool

pub unsafe fn setPrefersEdgeAttachedInCompactHeight( &self, prefers_edge_attached_in_compact_height: bool, )

Setter for prefersEdgeAttachedInCompactHeight.

pub unsafe fn widthFollowsPreferredContentSizeWhenEdgeAttached(&self) -> bool

pub unsafe fn setWidthFollowsPreferredContentSizeWhenEdgeAttached( &self, width_follows_preferred_content_size_when_edge_attached: bool, )

Setter for widthFollowsPreferredContentSizeWhenEdgeAttached.

pub unsafe fn prefersGrabberVisible(&self) -> bool

pub unsafe fn setPrefersGrabberVisible(&self, prefers_grabber_visible: bool)

Setter for prefersGrabberVisible.

pub unsafe fn preferredCornerRadius(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setPreferredCornerRadius(&self, preferred_corner_radius: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for preferredCornerRadius.

pub unsafe fn detents( &self, ) -> Retained<NSArray<UISheetPresentationControllerDetent>>

pub unsafe fn setDetents( &self, detents: &NSArray<UISheetPresentationControllerDetent>, )

Setter for detents.

pub unsafe fn invalidateDetents(&self)

pub unsafe fn selectedDetentIdentifier( &self, ) -> Option<Retained<UISheetPresentationControllerDetentIdentifier>>

pub unsafe fn setSelectedDetentIdentifier( &self, selected_detent_identifier: Option<&UISheetPresentationControllerDetentIdentifier>, )

Setter for selectedDetentIdentifier.

pub unsafe fn largestUndimmedDetentIdentifier( &self, ) -> Option<Retained<UISheetPresentationControllerDetentIdentifier>>

pub unsafe fn setLargestUndimmedDetentIdentifier( &self, largest_undimmed_detent_identifier: Option<&UISheetPresentationControllerDetentIdentifier>, )

Setter for largestUndimmedDetentIdentifier.

pub unsafe fn prefersScrollingExpandsWhenScrolledToEdge(&self) -> bool

pub unsafe fn setPrefersScrollingExpandsWhenScrolledToEdge( &self, prefers_scrolling_expands_when_scrolled_to_edge: bool, )

Setter for prefersScrollingExpandsWhenScrolledToEdge.

pub unsafe fn animateChanges(&self, changes: &DynBlock<dyn Fn() + '_>)

Available on crate feature block2 only.

impl UISheetPresentationController

Methods declared on superclass UIPresentationController.

pub unsafe fn initWithPresentedViewController_presentingViewController( this: Allocated<Self>, presented_view_controller: &UIViewController, presenting_view_controller: Option<&UIViewController>, ) -> Retained<Self>

Available on crate features UIResponder and UIViewController only.

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

impl UISheetPresentationController

Methods declared on superclass NSObject.

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

Methods from Deref<Target = UIPresentationController>

pub unsafe fn presentingViewController(&self) -> Retained<UIViewController>

Available on crate features UIResponder and UIViewController only.

pub unsafe fn presentedViewController(&self) -> Retained<UIViewController>

Available on crate features UIResponder and UIViewController only.

pub unsafe fn presentationStyle(&self) -> UIModalPresentationStyle

Available on crate feature UIViewController only.

pub unsafe fn containerView(&self) -> Option<Retained<UIView>>

Available on crate features UIResponder and UIView only.

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn UIAdaptivePresentationControllerDelegate>>>

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn UIAdaptivePresentationControllerDelegate>>, )

This is a weak property. Setter for delegate.

pub unsafe fn adaptivePresentationStyle(&self) -> UIModalPresentationStyle

Available on crate feature UIViewController only.

pub unsafe fn adaptivePresentationStyleForTraitCollection( &self, trait_collection: &UITraitCollection, ) -> UIModalPresentationStyle

Available on crate features UITraitCollection and UIViewController only.

pub unsafe fn containerViewWillLayoutSubviews(&self)

pub unsafe fn containerViewDidLayoutSubviews(&self)

pub unsafe fn presentedView(&self) -> Option<Retained<UIView>>

Available on crate features UIResponder and UIView only.

pub unsafe fn frameOfPresentedViewInContainerView(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

pub unsafe fn shouldPresentInFullscreen(&self) -> bool

pub unsafe fn shouldRemovePresentersView(&self) -> bool

pub unsafe fn presentationTransitionWillBegin(&self)

pub unsafe fn presentationTransitionDidEnd(&self, completed: bool)

pub unsafe fn dismissalTransitionWillBegin(&self)

pub unsafe fn dismissalTransitionDidEnd(&self, completed: bool)

pub unsafe fn overrideTraitCollection( &self, ) -> Option<Retained<UITraitCollection>>

👎Deprecated: Use the traitOverrides property instead

Available on crate feature UITraitCollection only.

pub unsafe fn setOverrideTraitCollection( &self, override_trait_collection: Option<&UITraitCollection>, )

👎Deprecated: Use the traitOverrides property instead

Available on crate feature UITraitCollection only.

Setter for overrideTraitCollection.

pub unsafe fn traitOverrides( &self, ) -> Retained<ProtocolObject<dyn UITraitOverrides>>

Available on crate feature UITraitCollection only.

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

Available on crate feature UIIndirectScribbleInteraction only.

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.

Available on crate feature UIIndirectScribbleInteraction only.

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,

Available on crate feature UIIndirectScribbleInteraction only.

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 UISheetPresentationController

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UISheetPresentationController

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIPresentationController> for UISheetPresentationController

fn as_ref(&self) -> &UIPresentationController

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

impl AsRef<UISheetPresentationController> for UISheetPresentationController

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UISheetPresentationController

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UISheetPresentationController

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<UIPresentationController> for UISheetPresentationController

fn borrow(&self) -> &UIPresentationController

Immutably borrows from an owned value.

impl ClassType for UISheetPresentationController

const NAME: &'static str = "UISheetPresentationController"

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

type Super = UIPresentationController

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 UISheetPresentationController

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

Formats the value using the given formatter.

impl Deref for UISheetPresentationController

type Target = UIPresentationController

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UISheetPresentationController

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 UISheetPresentationController

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for UISheetPresentationController

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 UISheetPresentationController

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 UISheetPresentationController

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

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

impl UIContentContainer for UISheetPresentationController

unsafe fn preferredContentSize(&self) -> CGSize

where Self: Sized + Message,

Available on crate features UIViewController and objc2-core-foundation only.

unsafe fn preferredContentSizeDidChangeForChildContentContainer( &self, container: &ProtocolObject<dyn UIContentContainer>, )

where Self: Sized + Message,

Available on crate feature UIViewController only.

unsafe fn systemLayoutFittingSizeDidChangeForChildContentContainer( &self, container: &ProtocolObject<dyn UIContentContainer>, )

where Self: Sized + Message,

Available on crate feature UIViewController only.

unsafe fn sizeForChildContentContainer_withParentContainerSize( &self, container: &ProtocolObject<dyn UIContentContainer>, parent_size: CGSize, ) -> CGSize

where Self: Sized + Message,

Available on crate features UIViewController and objc2-core-foundation only.

unsafe fn viewWillTransitionToSize_withTransitionCoordinator( &self, size: CGSize, coordinator: &ProtocolObject<dyn UIViewControllerTransitionCoordinator>, )

where Self: Sized + Message,

Available on crate features UIViewControllerTransitionCoordinator and objc2-core-foundation and UIViewController only.

unsafe fn willTransitionToTraitCollection_withTransitionCoordinator( &self, new_collection: &UITraitCollection, coordinator: &ProtocolObject<dyn UIViewControllerTransitionCoordinator>, )

where Self: Sized + Message,

Available on crate features UITraitCollection and UIViewControllerTransitionCoordinator and UIViewController only.

impl UIFocusEnvironment for UISheetPresentationController

unsafe fn preferredFocusEnvironments( &self, ) -> Retained<NSArray<ProtocolObject<dyn UIFocusEnvironment>>>

where Self: Sized + Message,

Available on crate feature UIFocus only.

The preferred focus environments define where to search for the default focused item in an environment, such as when focus updates programmatically. Starting from the target environment, each preferred focus environment is recursively searched in the order of the array until an eligible, focusable item is found. Preferred focus environments can include focusable and non-focusable items, in addition to non-item environments. Returning an empty array is equivalent to returning an array containing only ‘self’.

unsafe fn parentFocusEnvironment( &self, ) -> Option<Retained<ProtocolObject<dyn UIFocusEnvironment>>>

where Self: Sized + Message,

Available on crate feature UIFocus only.

The parent focus environment of this environment, or nil if no parent exists. NOTE: If you implement this method, you must return a non-nil value for parent focus environment, otherwise your focus environment will not participate in focus interactions.

unsafe fn focusItemContainer( &self, ) -> Option<Retained<ProtocolObject<dyn UIFocusItemContainer>>>

where Self: Sized + Message,

Available on crate feature UIFocus only.

The container of any child focus items in this focus environment, or nil if no container exists.

unsafe fn setNeedsFocusUpdate(&self)

where Self: Sized + Message,

Available on crate feature UIFocus only.

Marks this environment as needing a focus update, which if accepted will attempt to reset focus to this environment, or one of its preferred focus environments, on the next update cycle. If this environment does not currently contain the focused item, then calling this method has no effect. If a parent of this environment is also requesting focus, then this environment’s request is rejected in favor of the parent’s. NOTE: If you provide your own implementation, it must call [[UIFocusSystem focusSystemForEnvironment:self] requestFocusUpdateToEnvironment:self];

unsafe fn updateFocusIfNeeded(&self)

where Self: Sized + Message,

Available on crate feature UIFocus only.

Forces focus to be updated immediately. If there is an environment that has requested a focus update via -setNeedsFocusUpdate, and the request was accepted, then focus will be updated to that environment or one of its preferred focus environments. NOTE: If you provide your own implementation, it must call [[UIFocusSystem focusSystemForEnvironment:self] updateFocusIfNeeded];.

unsafe fn shouldUpdateFocusInContext( &self, context: &UIFocusUpdateContext, ) -> bool

where Self: Sized + Message,

Available on crate feature UIFocus only.

Asks whether the system should allow a focus update to occur.

unsafe fn didUpdateFocusInContext_withAnimationCoordinator( &self, context: &UIFocusUpdateContext, coordinator: &UIFocusAnimationCoordinator, )

where Self: Sized + Message,

Available on crate features UIFocus and UIFocusAnimationCoordinator only.

Called when the screen’s focused item has been updated to a new item. Use the animation coordinator to schedule focus-related animations in response to the update.

unsafe fn soundIdentifierForFocusUpdateInContext( &self, context: &UIFocusUpdateContext, ) -> Option<Retained<UIFocusSoundIdentifier>>

where Self: Sized + Message,

Available on crate feature UIFocus only.

Specifies an identifier corresponding to a sound that should be played for a focus update. Return UIFocusSoundIdentifierNone to opt out of sounds, UIFocusSoundIdentifierDefault for the system default sounds, a previously registered identifier for a custom sound, or nil to defer the decision to the parent.

unsafe fn preferredFocusedView(&self) -> Option<Retained<UIView>>

where Self: Sized + Message,

👎Deprecated

Available on crate features UIResponder and UIView and UIFocus only.

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

where Self: Sized + Message,

Available on crate feature UIFocus only.

The identifier of the focus group that this view belongs to. If this is nil, subviews inherit their superview’s focus group.

impl UITraitEnvironment for UISheetPresentationController

fn traitCollection(&self) -> Retained<UITraitCollection>

where Self: Sized + Message,

Available on crate feature UITraitCollection only.

unsafe fn traitCollectionDidChange( &self, previous_trait_collection: Option<&UITraitCollection>, )

where Self: Sized + Message,

👎Deprecated: Use the trait change registration APIs declared in the UITraitChangeObservable protocol

Available on crate feature UITraitCollection only.

To be overridden as needed to provide custom behavior when the environment’s traits change.

impl DowncastTarget for UISheetPresentationController

impl Eq for UISheetPresentationController

impl UIAppearanceContainer for UISheetPresentationController