Struct NSPasteboard

#[repr(C)]
pub struct NSPasteboard {
    pub ptr: Id<Object>,
}

An object that transfers data to and from the pasteboard server.

Fields

ptr: Id<Object>

The raw pointer to the Objective-C object.

Implementations

impl NSPasteboard

pub fn general_pasteboard() -> NSPasteboard

The shared pasteboard object to use for general content.

pub fn pasteboard_by_filtering_data_of_type( data: NSData, type: NSPasteboardType, ) -> NSPasteboard

Creates a new pasteboard object that supplies the specified data in as many types as possible based on the available filter services.

pub fn pasteboard_by_filtering_file(filename: NSString) -> NSPasteboard

Creates a new pasteboard object that supplies the specified file in as many types as possible based on the available filter services.

pub fn pasteboard_by_filtering_types_in_pasteboard( pboard: NSPasteboard, ) -> NSPasteboard

Creates a new pasteboard object that supplies the specified pasteboard data in as many types as possible based on the available filter services.

pub fn pasteboard_with_name(name: NSPasteboardName) -> NSPasteboard

Returns the pasteboard with the specified name.

pub fn pasteboard_with_unique_name() -> NSPasteboard

Creates and returns a new pasteboard with a name that is guaranteed to be unique with respect to other pasteboards in the system.

pub fn release_globally(&self)

Releases the receiver’s resources in the pasteboard server.

pub fn clear_contents(&mut self) -> Int

Clears the existing contents of the pasteboard.

pub fn write_objects(&mut self, objects: NSArray<id>) -> bool

Writes an array of objects to the receiver.

pub fn set_data_for_type( &mut self, data: NSData, data_type: NSPasteboardType, ) -> bool

Sets the data as the representation for the specified type for the first item on the receiver.

pub fn set_property_list_for_type( &mut self, plist: id, data_type: NSPasteboardType, ) -> bool

Sets the given property list as the representation for the specified type for the first item on the receiver.

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

Sets the given string as the representation for the specified type for the first item on the receiver.

pub fn read_objects_for_classes_options( &self, class_array: NSArray<Class>, options: NSDictionary<NSPasteboardReadingOptionKey, id>, ) -> Option<NSArray<id>>

Reads from the receiver objects that best match the specified array of classes.

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

An array that contains all the items held by the pasteboard.

pub fn index_of_pasteboard_item( &self, pasteboard_item: NSPasteboardItem, ) -> UInt

Returns the index of the specified pasteboard item.

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

Returns the data for the specified type from the first item in the receiver that contains the type.

pub fn property_list_for_type(&self, data_type: NSPasteboardType) -> Option<id>

Returns the property list for the specified type from the first item in the receiver that contains the type.

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

Returns a concatenation of the strings for the specified type from all the items in the receiver that contain the type.

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

Scans the specified types for a type that the receiver supports.

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

Returns a Boolean value that indicates whether the receiver contains any items that conform to the specified UTIs.

pub fn can_read_object_for_classes_options( &self, class_array: NSArray<Class>, options: NSDictionary<NSPasteboardReadingOptionKey, id>, ) -> bool

Returns a Boolean value that indicates whether the receiver contains any items that can be represented as an instance of any class in a given array.

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

An array of the receiver’s supported data types.

pub fn types_filterable_to(type: NSPasteboardType) -> NSArray<NSPasteboardType>

Returns the data types that can be converted to the specified type using the available filter services.

pub fn prepare_for_new_contents_with_options( &self, options: NSPasteboardContentsOptions, ) -> Int

Prepares the pasteboard to receive new contents, removing the existing pasteboard contents.

pub fn name(&self) -> NSPasteboardName

The receiver’s name.

pub fn change_count(&self) -> Int

The receiver’s change count.

pub fn declare_types_owner( &self, new_types: NSArray<NSPasteboardType>, new_owner: id, ) -> Int

Prepares the receiver for a change in its contents by declaring the new types of data it will contain and a new owner.

pub fn add_types_owner( &mut self, new_types: NSArray<NSPasteboardType>, new_owner: id, ) -> Int

Adds promises for the specified types to the first pasteboard item.

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

Writes the contents of the specified file to the pasteboard.

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

Writes the serialized contents of the specified file wrapper to the pasteboard.

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

Reads data representing a file’s contents from the receiver and writes it to the specified file.

pub fn read_file_wrapper(&self) -> Option<NSFileWrapper>

Reads data representing a file’s contents from the receiver and returns it as a file wrapper.

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Returns the class of self.

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

Returns a reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

pub unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

Returns a mutable reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

pub unsafe fn set_ivar<T>(&mut self, name: &str, value: T)

where T: Encode,

Sets the value of the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

Trait Implementations

impl Clone for NSPasteboard

fn clone(&self) -> Self

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NSPasteboard

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

Formats the value using the given formatter.

impl Deref for NSPasteboard

type Target = Object

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSPasteboard

fn deref_mut(&mut self) -> &mut Object

Mutably dereferences the value.

impl Display for NSPasteboard

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

Formats the value using the given formatter.

impl Encode for NSPasteboard

fn encode() -> Encoding

Returns the Objective-C type encoding for Self.

impl FromId for NSPasteboard

unsafe fn from_id(ptr: id) -> Self

Returns Self representation of the object.

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 INSPasteboard for NSPasteboard

fn p_general_pasteboard() -> NSPasteboard

The shared pasteboard object to use for general content.

fn m_pasteboard_by_filtering_data_of_type( data: NSData, type: NSPasteboardType, ) -> NSPasteboard

Creates a new pasteboard object that supplies the specified data in as many types as possible based on the available filter services.

fn m_pasteboard_by_filtering_file(filename: NSString) -> NSPasteboard

Creates a new pasteboard object that supplies the specified file in as many types as possible based on the available filter services.

fn m_pasteboard_by_filtering_types_in_pasteboard( pboard: NSPasteboard, ) -> NSPasteboard

Creates a new pasteboard object that supplies the specified pasteboard data in as many types as possible based on the available filter services.

fn m_pasteboard_with_name(name: NSPasteboardName) -> NSPasteboard

Returns the pasteboard with the specified name.

fn m_pasteboard_with_unique_name() -> NSPasteboard

Creates and returns a new pasteboard with a name that is guaranteed to be unique with respect to other pasteboards in the system.

fn m_release_globally(&self)

Releases the receiver’s resources in the pasteboard server.

fn m_clear_contents(&mut self) -> Int

Clears the existing contents of the pasteboard.

fn m_write_objects(&mut self, objects: NSArray<id>) -> bool

Writes an array of objects to the receiver.

fn m_set_data_for_type( &mut self, data: NSData, data_type: NSPasteboardType, ) -> bool

Sets the data as the representation for the specified type for the first item on the receiver.

fn m_set_property_list_for_type( &mut self, plist: id, data_type: NSPasteboardType, ) -> bool

Sets the given property list as the representation for the specified type for the first item on the receiver.

fn m_set_string_for_type( &mut self, string: NSString, data_type: NSPasteboardType, ) -> bool

Sets the given string as the representation for the specified type for the first item on the receiver.

fn m_read_objects_for_classes_options( &self, class_array: NSArray<Class>, options: NSDictionary<NSPasteboardReadingOptionKey, id>, ) -> Option<NSArray<id>>

Reads from the receiver objects that best match the specified array of classes.

fn p_pasteboard_items(&self) -> Option<NSArray<NSPasteboardItem>>

An array that contains all the items held by the pasteboard.

fn m_index_of_pasteboard_item(&self, pasteboard_item: NSPasteboardItem) -> UInt

Returns the index of the specified pasteboard item.

fn m_data_for_type(&self, data_type: NSPasteboardType) -> Option<NSData>

Returns the data for the specified type from the first item in the receiver that contains the type.

fn m_property_list_for_type(&self, data_type: NSPasteboardType) -> Option<id>

Returns the property list for the specified type from the first item in the receiver that contains the type.

fn m_string_for_type(&self, data_type: NSPasteboardType) -> Option<NSString>

Returns a concatenation of the strings for the specified type from all the items in the receiver that contain the type.

fn m_available_type_from_array( &self, types: NSArray<NSPasteboardType>, ) -> Option<NSPasteboardType>

Scans the specified types for a type that the receiver supports.

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

Returns a Boolean value that indicates whether the receiver contains any items that conform to the specified UTIs.

fn m_can_read_object_for_classes_options( &self, class_array: NSArray<Class>, options: NSDictionary<NSPasteboardReadingOptionKey, id>, ) -> bool

Returns a Boolean value that indicates whether the receiver contains any items that can be represented as an instance of any class in a given array.

fn p_types(&self) -> Option<NSArray<NSPasteboardType>>

An array of the receiver’s supported data types.

fn m_types_filterable_to(type: NSPasteboardType) -> NSArray<NSPasteboardType>

Returns the data types that can be converted to the specified type using the available filter services.

fn m_prepare_for_new_contents_with_options( &self, options: NSPasteboardContentsOptions, ) -> Int

Prepares the pasteboard to receive new contents, removing the existing pasteboard contents.

fn p_name(&self) -> NSPasteboardName

The receiver’s name.

fn p_change_count(&self) -> Int

The receiver’s change count.

fn m_declare_types_owner( &self, new_types: NSArray<NSPasteboardType>, new_owner: id, ) -> Int

Prepares the receiver for a change in its contents by declaring the new types of data it will contain and a new owner.

fn m_add_types_owner( &mut self, new_types: NSArray<NSPasteboardType>, new_owner: id, ) -> Int

Adds promises for the specified types to the first pasteboard item.

fn m_write_file_contents(&mut self, filename: NSString) -> bool

Writes the contents of the specified file to the pasteboard.

fn m_write_file_wrapper(&mut self, wrapper: NSFileWrapper) -> bool

Writes the serialized contents of the specified file wrapper to the pasteboard.

fn m_read_file_contents_type_to_file( &self, type: NSPasteboardType, filename: NSString, ) -> Option<NSString>

Reads data representing a file’s contents from the receiver and writes it to the specified file.

fn m_read_file_wrapper(&self) -> Option<NSFileWrapper>

Reads data representing a file’s contents from the receiver and returns it as a file wrapper.

impl PNSObject for NSPasteboard

fn m_class<'a>() -> &'a Class

Returns the class object for the receiver’s class.

fn m_self(&self) -> id

Returns the receiver.

fn m_new() -> Self

where Self: Sized + FromId,

Allocates a new instance of the receiving class, sends it an init message, and returns the initialized object.

fn m_alloc() -> Self

where Self: Sized + FromId,

Returns a new instance of the receiving class.

fn m_initialize()

Initializes the class before it receives its first message.

fn ip_superclass<'a>() -> Option<&'a Class>

Returns the class object for the receiver’s superclass.

fn m_is_equal(&self, object: &Self) -> bool

Returns a Boolean value that indicates whether the receiver and a given object are equal.

fn p_hash(&self) -> UInt

Returns an integer that can be used as a table address in a hash table structure.

fn m_is_kind_of_class(&self, class: Class) -> bool

Returns a Boolean value that indicates whether the receiver is an instance of given class or an instance of any class that inherits from that class.

fn m_is_member_of_class(&self, class: Class) -> bool

Returns a Boolean value that indicates whether the receiver is an instance of a given class.

fn m_responds_to_selector(&self, selector: Sel) -> bool

Returns a Boolean value that indicates whether the receiver implements or inherits a method that can respond to a specified message.

fn m_conforms_to_protocol(&self, protocol: Protocol) -> bool

Returns a Boolean value that indicates whether the receiver conforms to a given protocol.

fn p_description(&self) -> NSString

A textual representation of the receiver.

fn p_debug_description(&self) -> NSString

A textual representation of the receiver to use with a debugger.

fn m_perform_selector(&self, selector: Sel) -> id

Sends a specified message to the receiver and returns the result of the message.

fn m_perform_selector_with_object(&self, selector: Sel, with_object: id) -> id

Sends a message to the receiver with an object as the argument.

fn m_is_proxy(&self) -> bool

Returns a Boolean value that indicates whether the receiver does not descend from NSObject.

impl ToId for NSPasteboard

fn to_id(self) -> id

Returns id representation of the object.