objc2-foundation 0.2.2

Bindings to the Foundation framework
Documentation
//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use objc2::__framework_prelude::*;

use crate::*;

// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct NSItemProviderRepresentationVisibility(pub NSInteger);
impl NSItemProviderRepresentationVisibility {
    #[doc(alias = "NSItemProviderRepresentationVisibilityAll")]
    pub const All: Self = Self(0);
    #[doc(alias = "NSItemProviderRepresentationVisibilityTeam")]
    pub const Team: Self = Self(1);
    #[doc(alias = "NSItemProviderRepresentationVisibilityGroup")]
    pub const Group: Self = Self(2);
    #[doc(alias = "NSItemProviderRepresentationVisibilityOwnProcess")]
    pub const OwnProcess: Self = Self(3);
}

unsafe impl Encode for NSItemProviderRepresentationVisibility {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

unsafe impl RefEncode for NSItemProviderRepresentationVisibility {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

// NS_OPTIONS
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct NSItemProviderFileOptions(pub NSInteger);
bitflags::bitflags! {
    impl NSItemProviderFileOptions: NSInteger {
        const NSItemProviderFileOptionOpenInPlace = 1;
    }
}

unsafe impl Encode for NSItemProviderFileOptions {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

unsafe impl RefEncode for NSItemProviderFileOptions {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

extern_protocol!(
    pub unsafe trait NSItemProviderWriting: NSObjectProtocol {
        #[cfg(all(feature = "NSArray", feature = "NSString"))]
        #[method_id(@__retain_semantics Other writableTypeIdentifiersForItemProvider)]
        unsafe fn writableTypeIdentifiersForItemProvider_class() -> Retained<NSArray<NSString>>;

        #[cfg(all(feature = "NSArray", feature = "NSString"))]
        #[optional]
        #[method_id(@__retain_semantics Other writableTypeIdentifiersForItemProvider)]
        unsafe fn writableTypeIdentifiersForItemProvider(&self) -> Retained<NSArray<NSString>>;

        #[cfg(feature = "NSString")]
        #[optional]
        #[method(itemProviderVisibilityForRepresentationWithTypeIdentifier:)]
        unsafe fn itemProviderVisibilityForRepresentationWithTypeIdentifier_class(
            type_identifier: &NSString,
        ) -> NSItemProviderRepresentationVisibility;

        #[cfg(feature = "NSString")]
        #[optional]
        #[method(itemProviderVisibilityForRepresentationWithTypeIdentifier:)]
        unsafe fn itemProviderVisibilityForRepresentationWithTypeIdentifier(
            &self,
            type_identifier: &NSString,
        ) -> NSItemProviderRepresentationVisibility;

        #[cfg(all(
            feature = "NSData",
            feature = "NSError",
            feature = "NSProgress",
            feature = "NSString",
            feature = "block2"
        ))]
        #[method_id(@__retain_semantics Other loadDataWithTypeIdentifier:forItemProviderCompletionHandler:)]
        unsafe fn loadDataWithTypeIdentifier_forItemProviderCompletionHandler(
            &self,
            type_identifier: &NSString,
            completion_handler: &block2::Block<dyn Fn(*mut NSData, *mut NSError)>,
        ) -> Option<Retained<NSProgress>>;
    }

    unsafe impl ProtocolType for dyn NSItemProviderWriting {}
);

extern_protocol!(
    pub unsafe trait NSItemProviderReading: NSObjectProtocol {
        #[cfg(all(feature = "NSArray", feature = "NSString"))]
        #[method_id(@__retain_semantics Other readableTypeIdentifiersForItemProvider)]
        unsafe fn readableTypeIdentifiersForItemProvider() -> Retained<NSArray<NSString>>;

        #[cfg(all(feature = "NSData", feature = "NSError", feature = "NSString"))]
        #[method_id(@__retain_semantics Other objectWithItemProviderData:typeIdentifier:error:_)]
        unsafe fn objectWithItemProviderData_typeIdentifier_error(
            data: &NSData,
            type_identifier: &NSString,
        ) -> Result<Retained<Self>, Retained<NSError>>;
    }

    unsafe impl ProtocolType for dyn NSItemProviderReading {}
);

#[cfg(all(feature = "NSError", feature = "NSObject", feature = "block2"))]
pub type NSItemProviderCompletionHandler =
    *mut block2::Block<dyn Fn(*mut ProtocolObject<dyn NSSecureCoding>, *mut NSError)>;

#[cfg(all(
    feature = "NSDictionary",
    feature = "NSError",
    feature = "NSObject",
    feature = "block2"
))]
pub type NSItemProviderLoadHandler =
    *mut block2::Block<dyn Fn(NSItemProviderCompletionHandler, *const AnyClass, *mut NSDictionary)>;

extern_class!(
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct NSItemProvider;

    unsafe impl ClassType for NSItemProvider {
        type Super = NSObject;
        type Mutability = InteriorMutable;
    }
);

#[cfg(feature = "NSObject")]
unsafe impl NSCopying for NSItemProvider {}

unsafe impl NSObjectProtocol for NSItemProvider {}

extern_methods!(
    unsafe impl NSItemProvider {
        #[method_id(@__retain_semantics Init init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[cfg(all(
            feature = "NSData",
            feature = "NSError",
            feature = "NSProgress",
            feature = "NSString",
            feature = "block2"
        ))]
        #[method(registerDataRepresentationForTypeIdentifier:visibility:loadHandler:)]
        pub unsafe fn registerDataRepresentationForTypeIdentifier_visibility_loadHandler(
            &self,
            type_identifier: &NSString,
            visibility: NSItemProviderRepresentationVisibility,
            load_handler: &block2::Block<
                dyn Fn(
                    NonNull<block2::Block<dyn Fn(*mut NSData, *mut NSError)>>,
                ) -> *mut NSProgress,
            >,
        );

        #[cfg(all(
            feature = "NSError",
            feature = "NSProgress",
            feature = "NSString",
            feature = "NSURL",
            feature = "block2"
        ))]
        #[method(registerFileRepresentationForTypeIdentifier:fileOptions:visibility:loadHandler:)]
        pub unsafe fn registerFileRepresentationForTypeIdentifier_fileOptions_visibility_loadHandler(
            &self,
            type_identifier: &NSString,
            file_options: NSItemProviderFileOptions,
            visibility: NSItemProviderRepresentationVisibility,
            load_handler: &block2::Block<
                dyn Fn(
                    NonNull<block2::Block<dyn Fn(*mut NSURL, Bool, *mut NSError)>>,
                ) -> *mut NSProgress,
            >,
        );

        #[cfg(all(feature = "NSArray", feature = "NSString"))]
        #[method_id(@__retain_semantics Other registeredTypeIdentifiers)]
        pub unsafe fn registeredTypeIdentifiers(&self) -> Retained<NSArray<NSString>>;

        #[cfg(all(feature = "NSArray", feature = "NSString"))]
        #[method_id(@__retain_semantics Other registeredTypeIdentifiersWithFileOptions:)]
        pub unsafe fn registeredTypeIdentifiersWithFileOptions(
            &self,
            file_options: NSItemProviderFileOptions,
        ) -> Retained<NSArray<NSString>>;

        #[cfg(feature = "NSString")]
        #[method(hasItemConformingToTypeIdentifier:)]
        pub unsafe fn hasItemConformingToTypeIdentifier(&self, type_identifier: &NSString) -> bool;

        #[cfg(feature = "NSString")]
        #[method(hasRepresentationConformingToTypeIdentifier:fileOptions:)]
        pub unsafe fn hasRepresentationConformingToTypeIdentifier_fileOptions(
            &self,
            type_identifier: &NSString,
            file_options: NSItemProviderFileOptions,
        ) -> bool;

        #[cfg(all(
            feature = "NSData",
            feature = "NSError",
            feature = "NSProgress",
            feature = "NSString",
            feature = "block2"
        ))]
        #[method_id(@__retain_semantics Other loadDataRepresentationForTypeIdentifier:completionHandler:)]
        pub unsafe fn loadDataRepresentationForTypeIdentifier_completionHandler(
            &self,
            type_identifier: &NSString,
            completion_handler: &block2::Block<dyn Fn(*mut NSData, *mut NSError)>,
        ) -> Retained<NSProgress>;

        #[cfg(all(
            feature = "NSError",
            feature = "NSProgress",
            feature = "NSString",
            feature = "NSURL",
            feature = "block2"
        ))]
        #[method_id(@__retain_semantics Other loadFileRepresentationForTypeIdentifier:completionHandler:)]
        pub unsafe fn loadFileRepresentationForTypeIdentifier_completionHandler(
            &self,
            type_identifier: &NSString,
            completion_handler: &block2::Block<dyn Fn(*mut NSURL, *mut NSError)>,
        ) -> Retained<NSProgress>;

        #[cfg(all(
            feature = "NSError",
            feature = "NSProgress",
            feature = "NSString",
            feature = "NSURL",
            feature = "block2"
        ))]
        #[method_id(@__retain_semantics Other loadInPlaceFileRepresentationForTypeIdentifier:completionHandler:)]
        pub unsafe fn loadInPlaceFileRepresentationForTypeIdentifier_completionHandler(
            &self,
            type_identifier: &NSString,
            completion_handler: &block2::Block<dyn Fn(*mut NSURL, Bool, *mut NSError)>,
        ) -> Retained<NSProgress>;

        #[cfg(feature = "NSString")]
        #[method_id(@__retain_semantics Other suggestedName)]
        pub unsafe fn suggestedName(&self) -> Option<Retained<NSString>>;

        #[cfg(feature = "NSString")]
        #[method(setSuggestedName:)]
        pub unsafe fn setSuggestedName(&self, suggested_name: Option<&NSString>);

        #[method_id(@__retain_semantics Init initWithObject:)]
        pub unsafe fn initWithObject(
            this: Allocated<Self>,
            object: &ProtocolObject<dyn NSItemProviderWriting>,
        ) -> Retained<Self>;

        #[method(registerObject:visibility:)]
        pub unsafe fn registerObject_visibility(
            &self,
            object: &ProtocolObject<dyn NSItemProviderWriting>,
            visibility: NSItemProviderRepresentationVisibility,
        );

        #[cfg(all(feature = "NSObject", feature = "NSString"))]
        #[method_id(@__retain_semantics Init initWithItem:typeIdentifier:)]
        pub unsafe fn initWithItem_typeIdentifier(
            this: Allocated<Self>,
            item: Option<&ProtocolObject<dyn NSSecureCoding>>,
            type_identifier: Option<&NSString>,
        ) -> Retained<Self>;

        #[cfg(feature = "NSURL")]
        #[method_id(@__retain_semantics Init initWithContentsOfURL:)]
        pub unsafe fn initWithContentsOfURL(
            this: Allocated<Self>,
            file_url: Option<&NSURL>,
        ) -> Option<Retained<Self>>;

        #[cfg(all(
            feature = "NSDictionary",
            feature = "NSError",
            feature = "NSObject",
            feature = "NSString",
            feature = "block2"
        ))]
        #[method(registerItemForTypeIdentifier:loadHandler:)]
        pub unsafe fn registerItemForTypeIdentifier_loadHandler(
            &self,
            type_identifier: &NSString,
            load_handler: NSItemProviderLoadHandler,
        );

        #[cfg(all(
            feature = "NSDictionary",
            feature = "NSError",
            feature = "NSObject",
            feature = "NSString",
            feature = "block2"
        ))]
        #[method(loadItemForTypeIdentifier:options:completionHandler:)]
        pub unsafe fn loadItemForTypeIdentifier_options_completionHandler(
            &self,
            type_identifier: &NSString,
            options: Option<&NSDictionary>,
            completion_handler: NSItemProviderCompletionHandler,
        );
    }
);

extern_methods!(
    /// Methods declared on superclass `NSObject`
    unsafe impl NSItemProvider {
        #[method_id(@__retain_semantics New new)]
        pub unsafe fn new() -> Retained<Self>;
    }
);

extern "C" {
    #[cfg(feature = "NSString")]
    pub static NSItemProviderPreferredImageSizeKey: &'static NSString;
}

extern_methods!(
    /// NSPreviewSupport
    unsafe impl NSItemProvider {
        #[cfg(all(
            feature = "NSDictionary",
            feature = "NSError",
            feature = "NSObject",
            feature = "block2"
        ))]
        #[method(previewImageHandler)]
        pub unsafe fn previewImageHandler(&self) -> NSItemProviderLoadHandler;

        #[cfg(all(
            feature = "NSDictionary",
            feature = "NSError",
            feature = "NSObject",
            feature = "block2"
        ))]
        #[method(setPreviewImageHandler:)]
        pub unsafe fn setPreviewImageHandler(
            &self,
            preview_image_handler: NSItemProviderLoadHandler,
        );

        #[cfg(all(
            feature = "NSDictionary",
            feature = "NSError",
            feature = "NSObject",
            feature = "block2"
        ))]
        #[method(loadPreviewImageWithOptions:completionHandler:)]
        pub unsafe fn loadPreviewImageWithOptions_completionHandler(
            &self,
            options: Option<&NSDictionary>,
            completion_handler: NSItemProviderCompletionHandler,
        );
    }
);

extern "C" {
    #[cfg(feature = "NSString")]
    pub static NSExtensionJavaScriptPreprocessingResultsKey: Option<&'static NSString>;
}

extern "C" {
    #[cfg(feature = "NSString")]
    pub static NSExtensionJavaScriptFinalizeArgumentKey: Option<&'static NSString>;
}

extern "C" {
    #[cfg(feature = "NSString")]
    pub static NSItemProviderErrorDomain: &'static NSString;
}

// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct NSItemProviderErrorCode(pub NSInteger);
impl NSItemProviderErrorCode {
    pub const NSItemProviderUnknownError: Self = Self(-1);
    pub const NSItemProviderItemUnavailableError: Self = Self(-1000);
    pub const NSItemProviderUnexpectedValueClassError: Self = Self(-1100);
    pub const NSItemProviderUnavailableCoercionError: Self = Self(-1200);
}

unsafe impl Encode for NSItemProviderErrorCode {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

unsafe impl RefEncode for NSItemProviderErrorCode {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}