Struct NSSharingService

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

Available on crate feature NSSharingService only.

NSSharingService can be used to share items to different kinds of local and remote services. Items are objects which respond to the NSPasteboardWriting protocol, like NSURL, NSImage or NSString. If an NSURL is a file URL (point to a video for example), then the content of the file will be shared. If the URL is remote, then the URL itself will be shared.

See also Apple’s documentation

Implementations

impl NSSharingService

pub unsafe fn delegate( &self, mtm: MainThreadMarker, ) -> Option<Retained<ProtocolObject<dyn NSSharingServiceDelegate>>>

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn NSSharingServiceDelegate>>, )

This is a weak property. Setter for delegate.

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

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

Available on crate feature NSImage only.

pub unsafe fn alternateImage(&self) -> Option<Retained<NSImage>>

Available on crate feature NSImage only.

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

Title of the service in the Share menu. Can be modified.

pub unsafe fn setMenuItemTitle(&self, menu_item_title: &NSString)

Setter for menuItemTitle.

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

NSArray of NSString objects representing handles (example: email adresses)

pub unsafe fn setRecipients(&self, recipients: Option<&NSArray<NSString>>)

Setter for recipients.

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

pub unsafe fn setSubject(&self, subject: Option<&NSString>)

Setter for subject.

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

Message body as string

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

URL to access the post on Facebook, Twitter, Sina Weibo, etc. (also known as permalink)

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

Account name used for sending on Twitter or Sina Weibo

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

NSArray of NSURL objects representing the files that were shared

pub unsafe fn sharingServicesForItems( items: &NSArray, ) -> Retained<NSArray<NSSharingService>>

👎Deprecated: Use -[NSSharingServicePicker standardShareMenuItem] instead.

Returns a list of NSSharingServices which could share all the provided items together. sharingServicesForItems can be used to build a custom UI, or to populate a contextual NSMenu. The items represent the objects to be shared and must conform to the <NSPasteboardWriting

protocol or be an NSItemProvider or an NSDocument. (e.g. NSString, NSImage, NSURL, etc.)

pub unsafe fn sharingServiceNamed( service_name: &NSSharingServiceName, ) -> Option<Retained<NSSharingService>>

Returns an NSSharingService representing one of the built-in services.

pub unsafe fn initWithTitle_image_alternateImage_handler( this: Allocated<Self>, title: &NSString, image: &NSImage, alternate_image: Option<&NSImage>, block: &DynBlock<dyn Fn()>, ) -> Retained<Self>

Available on crate features NSImage and block2 only.

Creates a custom NSSharingService object. Custom sharing services can be added to the NSSharingServicePicker with the sharingServicePicker:sharingServicesForItems:proposedSharingServices: delegate method.

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

Use -initWithTitle:image:alternateImage:handler: instead

pub unsafe fn canPerformWithItems(&self, items: Option<&NSArray>) -> bool

Returns whether a service can do something with all the provided items. This can be used to validate a custom UI such as a dedicated Twitter button. If items is nil, the method will return YES when the service is configured. Therefore you could call it once at launch time with nil items to check whether to display the button or not, and then with real items to enable and disable the button depending on the context or selection.

The items represent the objects to be shared and must conform to the <NSPasteboardWriting

protocol or be an NSItemProvider or an NSDocument. (e.g. NSString, NSImage, NSURL, etc.)

pub unsafe fn performWithItems(&self, items: &NSArray)

Manually performs the service on the provided items. In most cases this will display a sharing window.

The items represent the objects to be shared and must conform to the <NSPasteboardWriting

protocol or be an NSItemProvider or an NSDocument. (e.g. NSString, NSImage, NSURL, etc.)

impl NSSharingService

Methods declared on superclass NSObject.

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

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSSharingService

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSSharingService> for NSSharingService

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSSharingService

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSSharingService

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSSharingService

const NAME: &'static str = "NSSharingService"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NSSharingService

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSSharingService

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 NSSharingService

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NSSharingService

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 NSSharingService

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 NSSharingService

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

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

impl DowncastTarget for NSSharingService

impl Eq for NSSharingService