Trait NSFileProviderItemDecorating 

pub unsafe trait NSFileProviderItemDecorating: NSFileProviderItemProtocol {
    // Provided method
    unsafe fn decorations(
        &self,
    ) -> Option<Retained<NSArray<NSFileProviderItemDecorationIdentifier>>>
       where Self: Sized + Message { ... }
}

Available on crate features NSFileProviderItem and NSFileProviderItemDecoration only.

Decorations are defined in the extension’s Info.plist by adding a NSFileProviderDecorations key with one or many entries to the NSExtension dictionary.

<key

NSFileProviderDecorations </key

<array

<dict

<key

Identifier </key

<string

$(PRODUCT_BUNDLE_IDENTIFIER).hasComments </string

<key

BadgeImageType </key

<string

com.someone.item.decoration.unreadCommentIcon </string

<key

Category </key

<string

Badge </string

<key

LocalizedTitle </key

<dict

<key

NSStringFormat </key

<string

% @ unread comments </string

<key

NSStringFormatValues </key

<array

<string

item.userInfo.unreadCommentCount </string

</array

</dict

</dict

</array

The keys for each entry are defined as follows: Key | Property —————|––––– Identifier | The identifier used to refer to this decoration in the item definition (as type NSFileProviderItemDecorationIdentifier). BadgeImageType | The overlay UTI (see below) Label | A localizable title, to be used in detail views, on mouse over and for voice over Category | The position of the decoration: one of ‘Badge’, ‘Sharing’, or ‘FolderBadge’

At rendering time, the icon for the UTI specified by ‘BadgeImageType’ will be looked up. The UTI must conform to ‘com.apple.icon-decoration.badge’.

Decorations from different categories are presented in different places in the UI.

Note that regardless of the dictionary key used for the visual decoration, the Label key will be used for mouse over / voice over.

Category	Location
Badge	On top of the icon. The decoration is an image, taken from the BadgeImageType key. Only the first badge is displayed.
Sharing	Adjacent to the icon. The decoration is a string, taken from the Label key. Only the first label is displayed.
FolderBadge	Embossed on top of the folder icon. The image from the BadgeImageType key will be embossed. Only the first badge is displayed. Only valid for folders.

See also Apple’s documentation

Provided Methods

unsafe fn decorations( &self, ) -> Option<Retained<NSArray<NSFileProviderItemDecorationIdentifier>>>

where Self: Sized + Message,

Returns an array of decorations for the item.

To adopt this protocol, implement the -decorations method on your NSFileProviderItem to return valid decoration identifiers from your Info.plist.

Trait Implementations

impl ProtocolType for dyn NSFileProviderItemDecorating

const NAME: &'static str = "NSFileProviderItemDecorating"

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

fn protocol() -> Option<&'static AnyProtocol>

Get a reference to the Objective-C protocol object that this type represents.

impl<T> ImplementedBy<T> for dyn NSFileProviderItemDecorating

where T: ?Sized + Message + NSFileProviderItemDecorating,

Implementations on Foreign Types

impl<T> NSFileProviderItemDecorating for ProtocolObject<T>

where T: ?Sized + NSFileProviderItemDecorating,

Implementors