Struct SCContentSharingPicker

Source

pub struct SCContentSharingPicker { /* private fields */ }

Available on crate feature SCContentSharingPicker only.

Expand description

SCContentSharingPicker

SCContentSharingPicker is an object created by client applications to opt-in to Control Center’s content picker

Implementations§

Source §

pub unsafe fn sharedPicker() -> Retained<SCContentSharingPicker>

sharedPicker the singleton shared picker for the application

Source

pub unsafe fn defaultConfiguration( &self, ) -> Retained<SCContentSharingPickerConfiguration>

defaultConfiguration for the content sharing picker. If a stream does not have a configuration, the default configuration will be used.

Source

pub unsafe fn setDefaultConfiguration( &self, default_configuration: &SCContentSharingPickerConfiguration, )

Setter for defaultConfiguration.

This is copied when set.

§Safety

default_configuration generic should be of the correct type.

Source

pub unsafe fn maximumStreamCount(&self) -> Option<Retained<NSNumber>>

maximumStreamCount An integer value that, if set, limits when Control Center will show the UI to present a picker with no associated stream. If set to 0, Control Center will never ever show UI to present a picker without an associated stream.

Source

pub unsafe fn setMaximumStreamCount( &self, maximum_stream_count: Option<&NSNumber>, )

Setter for maximumStreamCount.

Source

pub unsafe fn isActive(&self) -> bool

active A picker needs to be marked as active for its UI to appear. If startPickingContent is called and the picker is not marked as active, the picker will not appear.

Source

pub unsafe fn setActive(&self, active: bool)

Setter for isActive.

Source

pub unsafe fn addObserver( &self, observer: &ProtocolObject<dyn SCContentSharingPickerObserver>, )

addObserver:

Parameter observer: the observer object that adheres to SCContentSharingPickerObserver protocol

Adds an observer object that will receive the results of user interaction with a displayed picker

Source

pub unsafe fn removeObserver( &self, observer: &ProtocolObject<dyn SCContentSharingPickerObserver>, )

removeObserver:

Parameter observer: the observer object that adheres to SCContentSharingPickerObserver protocol

Removes an observer object that will receive the results of user interaction with a displayed picker

Source

pub unsafe fn setConfiguration_forStream( &self, picker_config: Option<&SCContentSharingPickerConfiguration>, stream: &SCStream, )

Available on crate feature SCStream only.

setConfiguration:forStream:

Parameter pickerConfig: configuration for the picker

Parameter stream: stream for optional picking configuration

Sets optional configuration for the picker for a specific stream. If this is not set, the stream will use the defaultConfiguration instead

§Safety

picker_config generic should be of the correct type.

Source

pub unsafe fn present(&self)

present

show content sharing picker to get content for updating a new stream

Source

pub unsafe fn presentPickerUsingContentStyle( &self, content_style: SCShareableContentStyle, )

Available on crate feature SCShareableContent only.

presentPickerUsingContentStyle:

Parameter contentStyle: the mode in which picking should start

Takes a person straight into picking particular windows or displays

Source

pub unsafe fn presentPickerForStream(&self, stream: &SCStream)

Available on crate feature SCStream only.

presentPickerForStream:

Parameter stream: the stream to update

show content sharing picker with an existing stream

Source

pub unsafe fn presentPickerForStream_usingContentStyle( &self, stream: &SCStream, content_style: SCShareableContentStyle, )

Available on crate features SCShareableContent and SCStream only.

presentPickerForStream:usingContentStyle:

Parameter stream: the stream that the picker will display

Parameter contentStyle: the mode in which picking should start

Takes a person straight into picking particular windows or displays

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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

Source

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.

Source

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`
    }
}