Struct UIPasteboard 

pub struct UIPasteboard { /* private fields */ }

Available on crate feature UIPasteboard only.

Apple’s documentation

Implementations

impl UIPasteboard

pub fn generalPasteboard() -> Retained<UIPasteboard>

pub fn pasteboardWithName_create( pasteboard_name: &UIPasteboardName, create: bool, ) -> Option<Retained<UIPasteboard>>

pub fn pasteboardWithUniqueName() -> Retained<UIPasteboard>

pub unsafe fn name(&self) -> Retained<UIPasteboardName>

This property is not atomic.

Safety

This might not be thread-safe.

pub fn removePasteboardWithName(pasteboard_name: &UIPasteboardName)

pub unsafe fn isPersistent(&self) -> bool

This property is not atomic.

Safety

This might not be thread-safe.

pub fn setPersistent(&self, persistent: bool)

👎Deprecated: Do not set persistence on pasteboards. This property is set automatically.

pub unsafe fn changeCount(&self) -> NSInteger

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn itemProviders(&self) -> Retained<NSArray<NSItemProvider>>

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn setItemProviders(&self, item_providers: &NSArray<NSItemProvider>)

Setter for itemProviders.

This is copied when set.

Safety

This might not be thread-safe.

pub fn setItemProviders_localOnly_expirationDate( &self, item_providers: &NSArray<NSItemProvider>, local_only: bool, expiration_date: Option<&NSDate>, )

pub fn setObjects( &self, objects: &NSArray<ProtocolObject<dyn NSItemProviderWriting>>, )

pub fn setObjects_localOnly_expirationDate( &self, objects: &NSArray<ProtocolObject<dyn NSItemProviderWriting>>, local_only: bool, expiration_date: Option<&NSDate>, )

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

This property is not atomic.

Safety

This might not be thread-safe.

pub fn containsPasteboardTypes( &self, pasteboard_types: &NSArray<NSString>, ) -> bool

pub fn dataForPasteboardType( &self, pasteboard_type: &NSString, ) -> Option<Retained<NSData>>

pub fn valueForPasteboardType( &self, pasteboard_type: &NSString, ) -> Option<Retained<AnyObject>>

pub unsafe fn setValue_forPasteboardType( &self, value: &AnyObject, pasteboard_type: &NSString, )

Safety

value should be of the correct type.

pub fn setData_forPasteboardType( &self, data: &NSData, pasteboard_type: &NSString, )

pub unsafe fn numberOfItems(&self) -> NSInteger

This property is not atomic.

Safety

This might not be thread-safe.

pub fn pasteboardTypesForItemSet( &self, item_set: Option<&NSIndexSet>, ) -> Option<Retained<NSArray<NSArray<NSString>>>>

pub fn containsPasteboardTypes_inItemSet( &self, pasteboard_types: &NSArray<NSString>, item_set: Option<&NSIndexSet>, ) -> bool

pub fn itemSetWithPasteboardTypes( &self, pasteboard_types: &NSArray<NSString>, ) -> Option<Retained<NSIndexSet>>

pub fn valuesForPasteboardType_inItemSet( &self, pasteboard_type: &NSString, item_set: Option<&NSIndexSet>, ) -> Option<Retained<NSArray>>

pub fn dataForPasteboardType_inItemSet( &self, pasteboard_type: &NSString, item_set: Option<&NSIndexSet>, ) -> Option<Retained<NSArray<NSData>>>

pub unsafe fn items( &self, ) -> Retained<NSArray<NSDictionary<NSString, AnyObject>>>

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn setItems( &self, items: &NSArray<NSDictionary<NSString, AnyObject>>, )

Setter for items.

This is copied when set.

Safety

• items generic generic should be of the correct type.
• This might not be thread-safe.

pub unsafe fn addItems( &self, items: &NSArray<NSDictionary<NSString, AnyObject>>, )

Safety

items generic generic should be of the correct type.

pub unsafe fn setItems_options( &self, items: &NSArray<NSDictionary<NSString, AnyObject>>, options: &NSDictionary<UIPasteboardOption, AnyObject>, )

Safety

• items generic generic should be of the correct type.
• options generic should be of the correct type.

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

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn setString(&self, string: Option<&NSString>)

Setter for string.

This is copied when set.

Safety

This might not be thread-safe.

pub unsafe fn strings(&self) -> Option<Retained<NSArray<NSString>>>

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn setStrings(&self, strings: Option<&NSArray<NSString>>)

Setter for strings.

This is copied when set.

Safety

This might not be thread-safe.

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

This property is not atomic.

Safety

This might not be thread-safe.

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

Setter for URL.

This is copied when set.

Safety

This might not be thread-safe.

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

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn setURLs(&self, ur_ls: Option<&NSArray<NSURL>>)

Setter for URLs.

This is copied when set.

Safety

This might not be thread-safe.

pub unsafe fn image(&self) -> Option<Retained<UIImage>>

Available on crate feature UIImage only.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn setImage(&self, image: Option<&UIImage>)

Available on crate feature UIImage only.

Setter for image.

This is copied when set.

Safety

This might not be thread-safe.

pub unsafe fn images(&self) -> Option<Retained<NSArray<UIImage>>>

Available on crate feature UIImage only.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn setImages(&self, images: Option<&NSArray<UIImage>>)

Available on crate feature UIImage only.

Setter for images.

This is copied when set.

Safety

This might not be thread-safe.

pub unsafe fn color(&self) -> Option<Retained<UIColor>>

Available on crate feature UIColor only.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn setColor(&self, color: Option<&UIColor>)

Available on crate feature UIColor only.

Setter for color.

This is copied when set.

Safety

This might not be thread-safe.

pub unsafe fn colors(&self) -> Option<Retained<NSArray<UIColor>>>

Available on crate feature UIColor only.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn setColors(&self, colors: Option<&NSArray<UIColor>>)

Available on crate feature UIColor only.

Setter for colors.

This is copied when set.

Safety

This might not be thread-safe.

pub unsafe fn hasStrings(&self) -> bool

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn hasURLs(&self) -> bool

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn hasImages(&self) -> bool

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn hasColors(&self) -> bool

This property is not atomic.

Safety

This might not be thread-safe.

pub fn detectPatternsForPatterns_completionHandler( &self, patterns: &NSSet<UIPasteboardDetectionPattern>, completion_handler: &DynBlock<dyn Fn(*mut NSSet<UIPasteboardDetectionPattern>, *mut NSError)>, )

Available on crate feature block2 only.

Detects patterns in the first pasteboard item.

Parameter patterns: Detect only these patterns.

Parameter completionHandler: Receives which patterns were detected, or an error.

pub fn detectPatternsForPatterns_inItemSet_completionHandler( &self, patterns: &NSSet<UIPasteboardDetectionPattern>, item_set: Option<&NSIndexSet>, completion_handler: &DynBlock<dyn Fn(*mut NSArray<NSSet<UIPasteboardDetectionPattern>>, *mut NSError)>, )

Available on crate feature block2 only.

Detects patterns in the specified pasteboard items.

Parameter patterns: Detect only these patterns.

Parameter itemSet: Specifies which pasteboard items by their position. Nil means all items.

Parameter completionHandler: Receives which patterns were detected per item specified, or an error.

pub fn detectValuesForPatterns_completionHandler( &self, patterns: &NSSet<UIPasteboardDetectionPattern>, completion_handler: &DynBlock<dyn Fn(*mut NSDictionary<UIPasteboardDetectionPattern, AnyObject>, *mut NSError)>, )

Available on crate feature block2 only.

Detects patterns and corresponding values in the first pasteboard item.

Parameter patterns: Detect only these patterns.

Parameter completionHandler: Receives which patterns and values were detected, or an error.

pub fn detectValuesForPatterns_inItemSet_completionHandler( &self, patterns: &NSSet<UIPasteboardDetectionPattern>, item_set: Option<&NSIndexSet>, completion_handler: &DynBlock<dyn Fn(*mut NSArray<NSDictionary<UIPasteboardDetectionPattern, AnyObject>>, *mut NSError)>, )

Available on crate feature block2 only.

Detects patterns and corresponding values in the specified pasteboard items.

Parameter patterns: Detect only these patterns.

Parameter itemSet: Specifies which pasteboard items by their position. Nil means all items.

Parameter completionHandler: Receives which patterns and values were detected per item specified, or an error.

impl UIPasteboard

Methods declared on superclass NSObject.

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

pub 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

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 UIPasteboard

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UIPasteboard

fn as_ref(&self) -> &NSObject

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

impl AsRef<UIPasteboard> for UIPasteboard

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for UIPasteboard

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for UIPasteboard

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for UIPasteboard

const NAME: &'static str = "UIPasteboard"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl DefaultRetained for UIPasteboard

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for UIPasteboard

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for UIPasteboard

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 UIPasteboard

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for UIPasteboard

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 UIPasteboard

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 UIPasteboard

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

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

impl DowncastTarget for UIPasteboard

impl Eq for UIPasteboard

impl Send for UIPasteboard

impl Sync for UIPasteboard