Struct objc2_app_kit::NSPasteboard

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

Available on crate feature NSPasteboard only.

Implementations

impl NSPasteboard

pub unsafe fn generalPasteboard() -> Retained<NSPasteboard>

Examples found in repository

examples/nspasteboard.rs (line 53)

fn main() {
    let pasteboard = unsafe { NSPasteboard::generalPasteboard() };
    let impl_1 = get_text_1(&pasteboard);
    let impl_2 = get_text_2(&pasteboard);
    println!("Pasteboard text from implementation 1 was: {impl_1:?}");
    println!("Pasteboard text from implementation 2 was: {impl_2:?}");
    assert_eq!(impl_1, impl_2);

    let s = NSString::from_str("Hello, world!");
    set_text(&pasteboard, &s);
    println!("Now the pasteboard text should be: {s:?}");
    assert_eq!(Some(s), get_text_1(&pasteboard));
}

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

pub unsafe fn pasteboardWithUniqueName() -> Retained<NSPasteboard>

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

pub unsafe fn changeCount(&self) -> NSInteger

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

pub unsafe fn clearContents(&self) -> NSInteger

Examples found in repository

examples/nspasteboard.rs (line 43)

pub fn set_text(pasteboard: &NSPasteboard, text: &NSString) {
    let _ = unsafe { pasteboard.clearContents() };
    let obj = ProtocolObject::from_retained(text.copy());
    let objects = NSArray::from_vec(vec![obj]);
    let res = unsafe { pasteboard.writeObjects(&objects) };
    if !res {
        panic!("Failed writing to pasteboard");
    }
}

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

Examples found in repository

examples/nspasteboard.rs (line 46)

pub fn set_text(pasteboard: &NSPasteboard, text: &NSString) {
    let _ = unsafe { pasteboard.clearContents() };
    let obj = ProtocolObject::from_retained(text.copy());
    let objects = NSArray::from_vec(vec![obj]);
    let res = unsafe { pasteboard.writeObjects(&objects) };
    if !res {
        panic!("Failed writing to pasteboard");
    }
}

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

Examples found in repository

examples/nspasteboard.rs (line 32)

pub fn get_text_2(pasteboard: &NSPasteboard) -> Option<Retained<NSString>> {
    // The NSPasteboard API is a bit weird, it requires you to pass classes as
    // objects, which `objc2_foundation::NSArray` was not really made for - so
    // we convert the class to an `AnyObject` type instead.
    //
    // TODO: Investigate and find a better way to express this in `objc2`.
    let string_class = {
        let cls: *const AnyClass = NSString::class();
        let cls = cls as *mut AnyObject;
        unsafe { Retained::retain(cls).unwrap() }
    };
    let class_array = NSArray::from_vec(vec![string_class]);
    let objects = unsafe { pasteboard.readObjectsForClasses_options(&class_array, None) };

    let obj: *const AnyObject = objects?.first()?;
    // And this part is weird as well, since we now have to convert the object
    // into an NSString, which we know it to be since that's what we told
    // `readObjectsForClasses:options:`.
    let obj = obj as *mut NSString;
    Some(unsafe { Retained::retain(obj) }.unwrap())
}

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

Available on crate feature NSPasteboardItem only.

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

Available on crate feature NSPasteboardItem only.

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

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

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

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

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

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

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

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

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

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

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

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

Examples found in repository

examples/nspasteboard.rs (line 14)

pub fn get_text_1(pasteboard: &NSPasteboard) -> Option<Retained<NSString>> {
    unsafe { pasteboard.stringForType(NSPasteboardTypeString) }
}

impl NSPasteboard

Methods declared on superclass NSObject

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

pub unsafe fn new() -> Retained<Self>

impl NSPasteboard

FilterServices

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

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

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

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

impl NSPasteboard

NSFileContents

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

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

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

pub unsafe 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.

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 unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Available on crate feature NSAccessibilityConstants only.

Use Ivar::load_mut 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.

Trait Implementations

impl AsMut<AnyObject> for NSPasteboard

fn as_mut(&mut self) -> &mut AnyObject

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

impl AsMut<NSObject> for NSPasteboard

fn as_mut(&mut self) -> &mut NSObject

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

impl AsMut<NSPasteboard> for NSPasteboard

fn as_mut(&mut self) -> &mut Self

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

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 BorrowMut<AnyObject> for NSPasteboard

fn borrow_mut(&mut self) -> &mut AnyObject

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSPasteboard

fn borrow_mut(&mut self) -> &mut NSObject

Mutably borrows from an owned value.

impl ClassType for NSPasteboard

type Super = NSObject

The superclass of this class.

type Mutability = InteriorMutable

Whether the type is mutable or immutable.

const NAME: &'static str = "NSPasteboard"

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

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.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

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

where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

fn alloc() -> Allocated<Self>

where Self: Sized + IsAllocableAnyThread,

Allocate a new instance of the class.

impl Debug for NSPasteboard

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

Formats the value using the given formatter.

impl Deref for NSPasteboard

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSPasteboard

fn deref_mut(&mut self) -> &mut Self::Target

Mutably 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 NSObjectProtocol for NSPasteboard

fn isEqual(&self, other: &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,

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: &NSPasteboard) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method 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 Eq for NSPasteboard

impl Message for NSPasteboard

impl StructuralPartialEq for NSPasteboard