Struct NSPasteboard 

pub struct NSPasteboard { /* private fields */ }

Available on crate feature NSPasteboard only.

Apple’s documentation

Implementations

impl NSPasteboard

pub fn generalPasteboard() -> Retained<NSPasteboard>

pub fn pasteboardWithName(name: &NSPasteboardName) -> Retained<NSPasteboard>

pub fn pasteboardWithUniqueName() -> Retained<NSPasteboard>

pub fn name(&self) -> Retained<NSPasteboardName>

pub fn changeCount(&self) -> NSInteger

pub fn accessBehavior(&self) -> NSPasteboardAccessBehavior

The current pasteboard access behavior. The user can customize this behavior per-app in System Settings for any app that has triggered a pasteboard access alert in the past.

pub fn prepareForNewContentsWithOptions( &self, options: NSPasteboardContentsOptions, ) -> NSInteger

pub fn clearContents(&self) -> NSInteger

pub fn writeObjects( &self, objects: &NSArray<ProtocolObject<dyn NSPasteboardWriting>>, ) -> bool

pub unsafe fn readObjectsForClasses_options( &self, class_array: &NSArray<AnyClass>, options: Option<&NSDictionary<NSPasteboardReadingOptionKey, AnyObject>>, ) -> Option<Retained<NSArray>>

Safety

• class_array generic probably has further requirements.
• options generic should be of the correct type.

pub fn pasteboardItems(&self) -> Option<Retained<NSArray<NSPasteboardItem>>>

Available on crate feature NSPasteboardItem only.

pub fn indexOfPasteboardItem( &self, pasteboard_item: &NSPasteboardItem, ) -> NSUInteger

Available on crate feature NSPasteboardItem only.

pub fn canReadItemWithDataConformingToTypes( &self, types: &NSArray<NSString>, ) -> bool

pub unsafe fn canReadObjectForClasses_options( &self, class_array: &NSArray<AnyClass>, options: Option<&NSDictionary<NSPasteboardReadingOptionKey, AnyObject>>, ) -> bool

Safety

• class_array generic probably has further requirements.
• options generic should be of the correct type.

pub unsafe fn declareTypes_owner( &self, new_types: &NSArray<NSPasteboardType>, new_owner: Option<&AnyObject>, ) -> NSInteger

Safety

new_owner should be of the correct type.

pub unsafe fn addTypes_owner( &self, new_types: &NSArray<NSPasteboardType>, new_owner: Option<&AnyObject>, ) -> NSInteger

Safety

new_owner should be of the correct type.

pub fn types(&self) -> Option<Retained<NSArray<NSPasteboardType>>>

pub fn availableTypeFromArray( &self, types: &NSArray<NSPasteboardType>, ) -> Option<Retained<NSPasteboardType>>

pub fn setData_forType( &self, data: Option<&NSData>, data_type: &NSPasteboardType, ) -> bool

pub unsafe fn setPropertyList_forType( &self, plist: &AnyObject, data_type: &NSPasteboardType, ) -> bool

Safety

plist should be of the correct type.

pub fn setString_forType( &self, string: &NSString, data_type: &NSPasteboardType, ) -> bool

pub fn dataForType( &self, data_type: &NSPasteboardType, ) -> Option<Retained<NSData>>

pub fn propertyListForType( &self, data_type: &NSPasteboardType, ) -> Option<Retained<AnyObject>>

pub fn stringForType( &self, data_type: &NSPasteboardType, ) -> Option<Retained<NSString>>

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

Available on crate feature block2 only.

Determines whether the first pasteboard item matches the specified patterns, without notifying the person using the app.

This method only gives an indication of whether the first pasteboard item matches a particular pattern, and doesn’t allow the app to access the item’s contents. As a result, the system doesn’t notify the person using the app about reading the contents of the pasteboard.

The following example shows how to use this method to find email and postal addresses in the first pasteboard item:

[NSPasteboard.generalPasteboard
detectPatternsForPatterns:[NSSet setWithArray:
@
[NSPasteboardDetectionPatternEmailAddress,
NSPasteboardDetectionPatternPostalAddress]]
completionHandler:^(NSSet
<NSPasteboardDetectionPattern
> *matchedPatterns, NSError *error) {
if (error) {
NSLog(
"
Error: %
"
, error);
return;
}
BOOL matchedEmail = [matchedPatterns containsObject:NSPasteboardDetectionPatternEmailAddress];
BOOL matchedPostal = [matchedPatterns containsObject: NSPasteboardDetectionPatternPostalAddress];
if (matchedEmail) {
NSLog(
"
Email address(es) detected");
}
if (matchedPostal) {
NSLog(
"
Postal address(es) detected");
}
if (!matchedEmail
&
&
!matchedPostal) {
NSLog(
"
Matched neither email nor postal addresses.");
}
}];

• Parameters:
• patterns: The patterns to detect on the pasteboard.
• completionHandler: A block the system invokes after detecting patterns on the pasteboard. The block receives either a set with the patterns the system finds on the pasteboard or an error if detection fails.

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

Available on crate feature block2 only.

Determines whether the first pasteboard item matches the specified patterns, reading the contents if it finds a match.

For details about the types returned for each pattern, see NSPasteboardDetectionPattern.

The following example shows how to use this method to find web URLs and web search terms in the first pasteboard item:

[NSPasteboard.generalPasteboard
detectValuesForPatterns:[NSSet setWithArray:
@
[NSPasteboardDetectionPatternProbableWebSearch,
NSPasteboardDetectionPatternProbableWebURL]]
completionHandler:^(NSDictionary
<NSPasteboardDetectionPattern
, id> *patternValues, NSError *error) {
if (error) {
NSLog(
"
Error: %
"
, error);
return;
}
NSString *searchString = (NSString*)patternValues[NSPasteboardDetectionPatternProbableWebSearch];
NSString *urlString = (NSString*)patternValues[NSPasteboardDetectionPatternProbableWebURL] ;
if (searchString != nil) {
NSLog(
"
Web search retrieved: %
"
, searchString);
}
if (urlString != nil) {
NSLog(
"
Web URL retrieved: %
"
, urlString);
}
if (searchString == nil
&
&
urlString == nil) {
NSLog(
"
No web patterns retrieved.");
}
}];

Important: If the system finds a match when calling this method, the system informs the person using the app that the app is trying to read the contents of the pasteboard. If the person denies access to the pasteboard, the completion handler receives an error.

• Parameters:
• patterns: The patterns to detect on the pasteboard.
• completionHandler: A block the system invokes after detecting patterns on the pasteboard. The block returns either a dictionary with the patterns the system finds on the pasteboard or an error if detection fails. The dictionary keys specify the matched patterns and the values specify the corresponding content of the pasteboard.

pub fn detectMetadataForTypes_completionHandler( &self, types: &NSSet<NSPasteboardMetadataType>, completion_handler: &DynBlock<dyn Fn(*mut NSDictionary<NSPasteboardMetadataType, AnyObject>, *mut NSError)>, )

Available on crate feature block2 only.

Determines available metadata from the specified metadata types for the first pasteboard item, without notifying the person using the app.

This method only gives access to limited types of metadata and doesn’t allow the app to access the contents. As a result, the system doesn’t notify the person using the app about reading the contents of the pasteboard.

For details about the metadata returned for each type, see NSPasteboardMetadataType.

The following example shows how to use this method to find the content type of a file reference in the first item on the pasteboard:

[NSPasteboard.generalPasteboard
detectMetadataForTypes:[NSSet setWithArray:
@
[NSPasteboardMetadataTypeContentType]]
completionHandler:^(NSDictionary
<NSPasteboardMetadataType
, id> *metadata, NSError *error) {
if (error) {
NSLog(
"
Error: %
"
, error);
return;
}
UTType *contentType = (UTType*)metadata[NSPasteboardMetadataTypeContentType];
if (contentType) {
NSLog(
"
Content type is: %
"
, contentType.identifier);
} else {
NSLog(
"
Couldn't get content type");
}
}];

• Parameters:
• types: The metadata types to detect on the pasteboard.
• completionHandler: A block the system invokes after detecting metadata on the pasteboard. The block receives either a dictionary with the metadata types the system finds on the pasteboard or an error if detection fails. The dictionary keys specify the matched metadata types and the values specify the corresponding metadata.

impl NSPasteboard

Methods declared on superclass NSObject.

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

pub fn new() -> Retained<Self>

impl NSPasteboard

FilterServices.

pub fn typesFilterableTo( type: &NSPasteboardType, ) -> Retained<NSArray<NSPasteboardType>>

pub fn pasteboardByFilteringFile(filename: &NSString) -> Retained<NSPasteboard>

pub fn pasteboardByFilteringData_ofType( data: &NSData, type: &NSPasteboardType, ) -> Retained<NSPasteboard>

pub fn pasteboardByFilteringTypesInPasteboard( pboard: &NSPasteboard, ) -> Retained<NSPasteboard>

impl NSPasteboard

NSFileContents.

• File Contents **

pub fn writeFileContents(&self, filename: &NSString) -> bool

pub fn readFileContentsType_toFile( &self, type: Option<&NSPasteboardType>, filename: &NSString, ) -> Option<Retained<NSString>>

pub fn writeFileWrapper(&self, wrapper: &NSFileWrapper) -> bool

pub fn readFileWrapper(&self) -> Option<Retained<NSFileWrapper>>

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 NSAccessibilityConstants 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 NSAccessibilityConstants 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 NSAccessibilityConstants 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 NSPasteboard

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSPasteboard

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSPasteboard> for NSPasteboard

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSPasteboard

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSPasteboard

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSPasteboard

const NAME: &'static str = "NSPasteboard"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl DefaultRetained for NSPasteboard

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for NSPasteboard

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSPasteboard

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 NSPasteboard

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NSPasteboard

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 NSPasteboard

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 NSPasteboard

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

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

impl DowncastTarget for NSPasteboard

impl Eq for NSPasteboard