#[repr(C)]pub struct NSPasteboardItem { /* private fields */ }
NSPasteboardItem
only.Expand description
Implementations§
Source§impl NSPasteboardItem
impl NSPasteboardItem
pub unsafe fn types(&self) -> Retained<NSArray<NSPasteboardType>>
NSPasteboard
only.pub unsafe fn availableTypeFromArray( &self, types: &NSArray<NSPasteboardType>, ) -> Option<Retained<NSPasteboardType>>
NSPasteboard
only.pub unsafe fn setDataProvider_forTypes( &self, data_provider: &ProtocolObject<dyn NSPasteboardItemDataProvider>, types: &NSArray<NSPasteboardType>, ) -> bool
NSPasteboard
only.pub unsafe fn setData_forType( &self, data: &NSData, type: &NSPasteboardType, ) -> bool
NSPasteboard
only.pub unsafe fn setString_forType( &self, string: &NSString, type: &NSPasteboardType, ) -> bool
NSPasteboard
only.pub unsafe fn setPropertyList_forType( &self, property_list: &AnyObject, type: &NSPasteboardType, ) -> bool
NSPasteboard
only.pub unsafe fn dataForType( &self, type: &NSPasteboardType, ) -> Option<Retained<NSData>>
NSPasteboard
only.pub unsafe fn stringForType( &self, type: &NSPasteboardType, ) -> Option<Retained<NSString>>
NSPasteboard
only.pub unsafe fn propertyListForType( &self, type: &NSPasteboardType, ) -> Option<Retained<AnyObject>>
NSPasteboard
only.Sourcepub unsafe fn detectPatternsForPatterns_completionHandler(
&self,
patterns: &NSSet<NSPasteboardDetectionPattern>,
completion_handler: &DynBlock<dyn Fn(*mut NSSet<NSPasteboardDetectionPattern>, *mut NSError)>,
)
Available on crate features NSPasteboard
and block2
only.
pub unsafe fn detectPatternsForPatterns_completionHandler( &self, patterns: &NSSet<NSPasteboardDetectionPattern>, completion_handler: &DynBlock<dyn Fn(*mut NSSet<NSPasteboardDetectionPattern>, *mut NSError)>, )
NSPasteboard
and block2
only.Determines whether this pasteboard item matches the specified patterns, without notifying the user.
Because this method only gives an indication of whether a pasteboard item matches a particular pattern and doesn’t allow the app to access the contents, the system doesn’t notify the user about reading the contents of the pasteboard.
Parameter patterns
: The patterns to detect on the pasteboard item.
Parameter completionHandler
: A block that the system invokes after detecting patterns on the pasteboard item. The block receives either a set with the patterns found on the pasteboard item or an error if detection failed.
Sourcepub unsafe fn detectValuesForPatterns_completionHandler(
&self,
patterns: &NSSet<NSPasteboardDetectionPattern>,
completion_handler: &DynBlock<dyn Fn(*mut NSDictionary<NSPasteboardDetectionPattern, AnyObject>, *mut NSError)>,
)
Available on crate features NSPasteboard
and block2
only.
pub unsafe fn detectValuesForPatterns_completionHandler( &self, patterns: &NSSet<NSPasteboardDetectionPattern>, completion_handler: &DynBlock<dyn Fn(*mut NSDictionary<NSPasteboardDetectionPattern, AnyObject>, *mut NSError)>, )
NSPasteboard
and block2
only.Determines whether this pasteboard item matches the specified patterns, reading the contents if it finds a match.
- Important: Calling this method notifies the user that the app has read the contents of the pasteboard, if a match is found.
For details about the types returned for each pattern, see NSPasteboardDetectionPattern
.
Parameter patterns
: The patterns to detect on the pasteboard item.
Parameter completionHandler
: A block that the system invokes after detecting patterns on the pasteboard item. The block returns either dictionary with the patterns found on the pasteboard item or an error if detection failed. The dictionary keys specify the matched patterns, and the values specify the corresponding content of the pasteboard.
Sourcepub unsafe fn detectMetadataForTypes_completionHandler(
&self,
types: &NSSet<NSPasteboardMetadataType>,
completion_handler: &DynBlock<dyn Fn(*mut NSDictionary<NSPasteboardMetadataType, AnyObject>, *mut NSError)>,
)
Available on crate features NSPasteboard
and block2
only.
pub unsafe fn detectMetadataForTypes_completionHandler( &self, types: &NSSet<NSPasteboardMetadataType>, completion_handler: &DynBlock<dyn Fn(*mut NSDictionary<NSPasteboardMetadataType, AnyObject>, *mut NSError)>, )
NSPasteboard
and block2
only.Determines available metadata from the specified metadata types for this pasteboard item, without notifying the user.
Because this method only gives access to limited types of metadata and doesn’t allow the app to access the contents, the system doesn’t notify the user about reading the contents of the pasteboard.
For details about the metadata returned for each type, see NSPasteboardMetadataType
.
Parameter types
: The metadata types to detect on the pasteboard item.
Parameter completionHandler
: A block that the system invokes after detecting metadata on the pasteboard item. The block receives either a dictionary with the metadata types found on the pasteboard item or an error if detection failed. The dictionary keys specify the matched metadata types, and the values specify the corresponding metadata.
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
Available on crate feature NSAccessibilityConstants
only.
pub fn class(&self) -> &'static AnyClass
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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.Available on crate feature NSAccessibilityConstants
only.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
Available on crate feature NSAccessibilityConstants
only.
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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§
Source§impl AsRef<AnyObject> for NSPasteboardItem
impl AsRef<AnyObject> for NSPasteboardItem
Source§impl AsRef<NSObject> for NSPasteboardItem
impl AsRef<NSObject> for NSPasteboardItem
Source§impl AsRef<NSPasteboardItem> for NSPasteboardItem
impl AsRef<NSPasteboardItem> for NSPasteboardItem
Source§impl Borrow<AnyObject> for NSPasteboardItem
impl Borrow<AnyObject> for NSPasteboardItem
Source§impl Borrow<NSObject> for NSPasteboardItem
impl Borrow<NSObject> for NSPasteboardItem
Source§impl ClassType for NSPasteboardItem
impl ClassType for NSPasteboardItem
Source§const NAME: &'static str = "NSPasteboardItem"
const NAME: &'static str = "NSPasteboardItem"
Source§type ThreadKind = <<NSPasteboardItem as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<NSPasteboardItem as ClassType>::Super as ClassType>::ThreadKind
Source§impl Debug for NSPasteboardItem
impl Debug for NSPasteboardItem
Source§impl Deref for NSPasteboardItem
impl Deref for NSPasteboardItem
Source§impl Hash for NSPasteboardItem
impl Hash for NSPasteboardItem
Source§impl Message for NSPasteboardItem
impl Message for NSPasteboardItem
Source§impl NSObjectProtocol for NSPasteboardItem
impl NSObjectProtocol for NSPasteboardItem
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref
Source§fn isMemberOfClass(&self, cls: &AnyClass) -> bool
fn isMemberOfClass(&self, cls: &AnyClass) -> bool
Source§fn respondsToSelector(&self, aSelector: Sel) -> bool
fn respondsToSelector(&self, aSelector: Sel) -> bool
Source§fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
Source§fn debugDescription(&self) -> Retained<NSObject>
fn debugDescription(&self) -> Retained<NSObject>
Source§impl NSPasteboardReading for NSPasteboardItem
impl NSPasteboardReading for NSPasteboardItem
Source§unsafe fn readableTypesForPasteboard(
pasteboard: &NSPasteboard,
) -> Retained<NSArray<NSPasteboardType>>
unsafe fn readableTypesForPasteboard( pasteboard: &NSPasteboard, ) -> Retained<NSArray<NSPasteboardType>>
NSPasteboard
only.Source§unsafe fn readingOptionsForType_pasteboard(
type: &NSPasteboardType,
pasteboard: &NSPasteboard,
) -> NSPasteboardReadingOptions
unsafe fn readingOptionsForType_pasteboard( type: &NSPasteboardType, pasteboard: &NSPasteboard, ) -> NSPasteboardReadingOptions
NSPasteboard
only.Source§unsafe fn initWithPasteboardPropertyList_ofType(
this: Allocated<Self>,
property_list: &AnyObject,
type: &NSPasteboardType,
) -> Option<Retained<Self>>
unsafe fn initWithPasteboardPropertyList_ofType( this: Allocated<Self>, property_list: &AnyObject, type: &NSPasteboardType, ) -> Option<Retained<Self>>
NSPasteboard
only.Source§impl NSPasteboardWriting for NSPasteboardItem
impl NSPasteboardWriting for NSPasteboardItem
Source§unsafe fn writableTypesForPasteboard(
&self,
pasteboard: &NSPasteboard,
) -> Retained<NSArray<NSPasteboardType>>
unsafe fn writableTypesForPasteboard( &self, pasteboard: &NSPasteboard, ) -> Retained<NSArray<NSPasteboardType>>
NSPasteboard
only.Source§unsafe fn writingOptionsForType_pasteboard(
&self,
type: &NSPasteboardType,
pasteboard: &NSPasteboard,
) -> NSPasteboardWritingOptions
unsafe fn writingOptionsForType_pasteboard( &self, type: &NSPasteboardType, pasteboard: &NSPasteboard, ) -> NSPasteboardWritingOptions
NSPasteboard
only.Source§unsafe fn pasteboardPropertyListForType(
&self,
type: &NSPasteboardType,
) -> Option<Retained<AnyObject>>
unsafe fn pasteboardPropertyListForType( &self, type: &NSPasteboardType, ) -> Option<Retained<AnyObject>>
NSPasteboard
only.