#[repr(C)]pub struct FIFinderSyncController { /* private fields */ }
Expand description
A controller that acts as a bridge between your Finder Sync extension and the Finder itself.
Use the Finder Sync controller to configure your extension, to set badges on items in the Finder’s window, and to get a list of selected and targeted items.
See also Apple’s documentation
Implementations§
Source§impl FIFinderSyncController
impl FIFinderSyncController
Sourcepub unsafe fn defaultController() -> Retained<Self>
pub unsafe fn defaultController() -> Retained<Self>
Returns the shared Finder Sync controller object.
- Returns: The default Finder Sync controller object for this extension.
Sourcepub unsafe fn directoryURLs(&self) -> Retained<NSSet<NSURL>>
pub unsafe fn directoryURLs(&self) -> Retained<NSSet<NSURL>>
The directories managed by this extension.
The extension receives
FIFinderSync/beginObservingDirectoryAtURL:
and
FIFinderSync/endObservingDirectoryAtURL:
messages for every
directory in this set and for all of their subdirectories.
Always set directoryURLs
when the extension starts. If there are no
directories to watch, set directoryURLs
to an empty set.
Sourcepub unsafe fn setDirectoryURLs(&self, directory_ur_ls: Option<&NSSet<NSURL>>)
pub unsafe fn setDirectoryURLs(&self, directory_ur_ls: Option<&NSSet<NSURL>>)
Setter for directoryURLs
.
Sourcepub unsafe fn setBadgeImage_label_forBadgeIdentifier(
&self,
image: &NSImage,
label: Option<&NSString>,
badge_id: &NSString,
)
Available on crate feature objc2-app-kit
only.
pub unsafe fn setBadgeImage_label_forBadgeIdentifier( &self, image: &NSImage, label: Option<&NSString>, badge_id: &NSString, )
objc2-app-kit
only.Sets the badge image and label for the given ID.
Use this method to configure your badges. Finder may display the image, the
label or both. Your Finder Sync extension typically sets up a fixed number
of badges during its init
method.
- Parameters:
- image: An <doc ://com.apple.documentation/documentation/appkit/nsimage> object. The system may or may not draw this image on top of the item’s icon; when it does, the system determines the overlay position. Don’t add any padding to the image to adjust this positioning. The image draws at up to 320 x 320 points.
- label: A label describing the sync state represented by this badge. Each label should be a short localized string, such as “Waiting.”
- badgeID: A unique ID, identifying this badge.
Sourcepub unsafe fn setBadgeIdentifier_forURL(&self, badge_id: &NSString, url: &NSURL)
pub unsafe fn setBadgeIdentifier_forURL(&self, badge_id: &NSString, url: &NSURL)
Sets the badge for a file or directory.
Adds the specified badge to the given file or directory. Setting the
identifier to an empty string ( " "
) removes the badge.
Avoid adding badges to items that the Finder hasn’t displayed yet.
When setting the initial badge, call this method from your Finder Sync
extension’s FIFinderSync/requestBadgeIdentifierForURL:
method. When updating badges, call this method only for items that have
already received a badge.
- Parameters:
- badgeID: A unique ID, identifying the badge.
- url: The URL of the file or directory.
§See Also
FIFinderSync/requestBadgeIdentifierForURL:
Sourcepub unsafe fn targetedURL(&self) -> Option<Retained<NSURL>>
pub unsafe fn targetedURL(&self) -> Option<Retained<NSURL>>
Returns the URL of the Finder’s current target.
Use this method when creating a custom shortcut menu for the Finder. This returns the URL of the item that the user Control-clicked, letting you customize the menu for that item.
This method returns valid values only from the Finder Sync extension’s
FIFinderSync/menuForMenuKind:
method or from one of the menu
actions created in this method. If the selected items are outside the
extension’s managed directories (for example, when the user clicks on the
toolbar button), this method returns nil
.
- Returns: The URL of the Finder’s current target.
Sourcepub unsafe fn selectedItemURLs(&self) -> Option<Retained<NSArray<NSURL>>>
pub unsafe fn selectedItemURLs(&self) -> Option<Retained<NSArray<NSURL>>>
Returns an array of selected items.
Use this method when creating a shortcut menu or a menu for the extension’s toolbar button. You can then modify the menu’s content based on the items currently selected.
This method returns valid values only from the Finder Sync extension’s
FIFinderSync/menuForMenuKind:
method or from one of the menu
actions created in this method. If the selected items are outside the
extension’s managed directories (for example, when the user clicks on the
toolbar button), this method returns nil
.
- Returns: An array of items currently selected in the Finder window.
pub unsafe fn lastUsedDateForItemWithURL( &self, item_url: &NSURL, ) -> Option<Retained<NSDate>>
pub unsafe fn setLastUsedDate_forItemWithURL_completion( &self, last_used_date: &NSDate, item_url: &NSURL, completion: &DynBlock<dyn Fn(NonNull<NSError>)>, )
block2
only.pub unsafe fn tagDataForItemWithURL( &self, item_url: &NSURL, ) -> Option<Retained<NSData>>
pub unsafe fn setTagData_forItemWithURL_completion( &self, tag_data: Option<&NSData>, item_url: &NSURL, completion: &DynBlock<dyn Fn(NonNull<NSError>)>, )
block2
only.pub unsafe fn isExtensionEnabled() -> bool
pub unsafe fn showExtensionManagementInterface()
Methods from Deref<Target = NSExtensionContext>§
pub unsafe fn inputItems(&self) -> Retained<NSArray>
pub unsafe fn cancelRequestWithError(&self, error: &NSError)
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
pub fn class(&self) -> &'static AnyClass
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.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.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,
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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 FIFinderSyncController
impl AsRef<AnyObject> for FIFinderSyncController
Source§impl AsRef<NSExtensionContext> for FIFinderSyncController
impl AsRef<NSExtensionContext> for FIFinderSyncController
Source§fn as_ref(&self) -> &NSExtensionContext
fn as_ref(&self) -> &NSExtensionContext
Source§impl AsRef<NSObject> for FIFinderSyncController
impl AsRef<NSObject> for FIFinderSyncController
Source§impl Borrow<AnyObject> for FIFinderSyncController
impl Borrow<AnyObject> for FIFinderSyncController
Source§impl Borrow<NSExtensionContext> for FIFinderSyncController
impl Borrow<NSExtensionContext> for FIFinderSyncController
Source§fn borrow(&self) -> &NSExtensionContext
fn borrow(&self) -> &NSExtensionContext
Source§impl Borrow<NSObject> for FIFinderSyncController
impl Borrow<NSObject> for FIFinderSyncController
Source§impl ClassType for FIFinderSyncController
impl ClassType for FIFinderSyncController
Source§const NAME: &'static str = "FIFinderSyncController"
const NAME: &'static str = "FIFinderSyncController"
Source§type Super = NSExtensionContext
type Super = NSExtensionContext
Source§type ThreadKind = <<FIFinderSyncController as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<FIFinderSyncController as ClassType>::Super as ClassType>::ThreadKind
Source§impl Debug for FIFinderSyncController
impl Debug for FIFinderSyncController
Source§impl Deref for FIFinderSyncController
impl Deref for FIFinderSyncController
Source§impl Hash for FIFinderSyncController
impl Hash for FIFinderSyncController
Source§impl Message for FIFinderSyncController
impl Message for FIFinderSyncController
Source§impl NSObjectProtocol for FIFinderSyncController
impl NSObjectProtocol for FIFinderSyncController
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