objc2_ui_kit/generated/

UICollectionLayoutList.rs

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
#[cfg(feature = "objc2-core-foundation")]
use objc2_core_foundation::*;
use objc2_foundation::*;

use crate::*;

/// [Apple's documentation](https://developer.apple.com/documentation/uikit/uicollectionlayoutlistappearance?language=objc)
// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct UICollectionLayoutListAppearance(pub NSInteger);
impl UICollectionLayoutListAppearance {
    #[doc(alias = "UICollectionLayoutListAppearancePlain")]
    pub const Plain: Self = Self(0);
    #[doc(alias = "UICollectionLayoutListAppearanceGrouped")]
    pub const Grouped: Self = Self(1);
    #[doc(alias = "UICollectionLayoutListAppearanceInsetGrouped")]
    pub const InsetGrouped: Self = Self(2);
    #[doc(alias = "UICollectionLayoutListAppearanceSidebar")]
    pub const Sidebar: Self = Self(3);
    #[doc(alias = "UICollectionLayoutListAppearanceSidebarPlain")]
    pub const SidebarPlain: Self = Self(4);
}

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

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

/// [Apple's documentation](https://developer.apple.com/documentation/uikit/uicollectionlayoutlistheadermode?language=objc)
// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct UICollectionLayoutListHeaderMode(pub NSInteger);
impl UICollectionLayoutListHeaderMode {
    /// No headers are shown
    #[doc(alias = "UICollectionLayoutListHeaderModeNone")]
    pub const None: Self = Self(0);
    /// Uses supplementary views of kind UICollectionElementKindSectionHeader to show headers
    #[doc(alias = "UICollectionLayoutListHeaderModeSupplementary")]
    pub const Supplementary: Self = Self(1);
    /// Styles the first item in a section as a header. This is especially useful when using hierarchical data sources to be able to expand and collapse the header.
    #[doc(alias = "UICollectionLayoutListHeaderModeFirstItemInSection")]
    pub const FirstItemInSection: Self = Self(2);
}

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

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

/// [Apple's documentation](https://developer.apple.com/documentation/uikit/uicollectionlayoutlistfootermode?language=objc)
// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct UICollectionLayoutListFooterMode(pub NSInteger);
impl UICollectionLayoutListFooterMode {
    /// No footers are shown
    #[doc(alias = "UICollectionLayoutListFooterModeNone")]
    pub const None: Self = Self(0);
    /// Uses supplementary views of kind UICollectionElementKindSectionFooter to show footers
    #[doc(alias = "UICollectionLayoutListFooterModeSupplementary")]
    pub const Supplementary: Self = Self(1);
}

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

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

/// [Apple's documentation](https://developer.apple.com/documentation/uikit/uicollectionlayoutlistswipeactionsconfigurationprovider?language=objc)
#[cfg(all(feature = "UISwipeActionsConfiguration", feature = "block2"))]
pub type UICollectionLayoutListSwipeActionsConfigurationProvider =
    *mut block2::DynBlock<dyn Fn(NonNull<NSIndexPath>) -> *mut UISwipeActionsConfiguration>;

/// A block that is executed by list sections to provide granular control over separator appearance.
///
///
/// Parameter `itemIndexPath`: The index path of the item for which separators are being configured.
///
/// Parameter `sectionSeparatorConfiguration`: The list section's separator configuration for this cell. This configuration contains
/// the values for separator visibility and insets according to the current state of the item.
///
///
/// Returns: The configuration to use for separators at
/// `itemIndexPath.`
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/uikit/uicollectionlayoutlistitemseparatorhandler?language=objc)
#[cfg(all(feature = "UIListSeparatorConfiguration", feature = "block2"))]
pub type UICollectionLayoutListItemSeparatorHandler = *mut block2::DynBlock<
    dyn Fn(
        NonNull<NSIndexPath>,
        NonNull<UIListSeparatorConfiguration>,
    ) -> NonNull<UIListSeparatorConfiguration>,
>;

/// A setting for which items in the layout should tightly hug their content
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/uikit/uicollectionlayoutlistcontenthuggingelements?language=objc)
// NS_OPTIONS
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct UICollectionLayoutListContentHuggingElements(pub NSUInteger);
bitflags::bitflags! {
    impl UICollectionLayoutListContentHuggingElements: NSUInteger {
        #[doc(alias = "UICollectionLayoutListContentHuggingElementsNone")]
        const None = 0;
        #[doc(alias = "UICollectionLayoutListContentHuggingElementsSupplementaryHeader")]
        const SupplementaryHeader = 1<<0;
    }
}

unsafe impl Encode for UICollectionLayoutListContentHuggingElements {
    const ENCODING: Encoding = NSUInteger::ENCODING;
}

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

extern_class!(
    /// A list configuration can be used to layout a section inside a UICollectionViewCompositionalLayout as a list.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/uikit/uicollectionlayoutlistconfiguration?language=objc)
    #[unsafe(super(NSObject))]
    #[thread_kind = MainThreadOnly]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct UICollectionLayoutListConfiguration;
);

extern_conformance!(
    unsafe impl NSCopying for UICollectionLayoutListConfiguration {}
);

unsafe impl CopyingHelper for UICollectionLayoutListConfiguration {
    type Result = Self;
}

extern_conformance!(
    unsafe impl NSObjectProtocol for UICollectionLayoutListConfiguration {}
);

impl UICollectionLayoutListConfiguration {
    extern_methods!(
        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>;

        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(initWithAppearance:))]
        #[unsafe(method_family = init)]
        pub fn initWithAppearance(
            this: Allocated<Self>,
            appearance: UICollectionLayoutListAppearance,
        ) -> Retained<Self>;

        /// The overall appearance of the section.
        #[unsafe(method(appearance))]
        #[unsafe(method_family = none)]
        pub fn appearance(&self) -> UICollectionLayoutListAppearance;

        /// Whether this section shows separators or not. For additional control, see separatorConfiguration.
        /// Note that when this property is NO, the separatorConfiguration is ineffective.
        #[unsafe(method(showsSeparators))]
        #[unsafe(method_family = none)]
        pub fn showsSeparators(&self) -> bool;

        /// Setter for [`showsSeparators`][Self::showsSeparators].
        #[unsafe(method(setShowsSeparators:))]
        #[unsafe(method_family = none)]
        pub fn setShowsSeparators(&self, shows_separators: bool);

        #[cfg(feature = "UIListSeparatorConfiguration")]
        /// The preferred configuration for separators. Used as a baseline for a section in a list using this
        /// `UICollectionLayoutListConfiguration`
        #[unsafe(method(separatorConfiguration))]
        #[unsafe(method_family = none)]
        pub fn separatorConfiguration(&self) -> Retained<UIListSeparatorConfiguration>;

        #[cfg(feature = "UIListSeparatorConfiguration")]
        /// Setter for [`separatorConfiguration`][Self::separatorConfiguration].
        ///
        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
        #[unsafe(method(setSeparatorConfiguration:))]
        #[unsafe(method_family = none)]
        pub fn setSeparatorConfiguration(
            &self,
            separator_configuration: &UIListSeparatorConfiguration,
        );

        #[cfg(all(feature = "UIListSeparatorConfiguration", feature = "block2"))]
        /// This handler is executed when the list section is configuring separator appearance for an item. The index path for the item being configured and
        /// a resolved separator configuration are passed in to this block. The configuration returned from this block will be treated as the final
        /// separator configuration for this item.
        ///
        /// # Safety
        ///
        /// - The returned block's argument 1 must be a valid pointer.
        /// - The returned block's argument 2 must be a valid pointer.
        #[unsafe(method(itemSeparatorHandler))]
        #[unsafe(method_family = none)]
        pub unsafe fn itemSeparatorHandler(&self) -> UICollectionLayoutListItemSeparatorHandler;

        #[cfg(all(feature = "UIListSeparatorConfiguration", feature = "block2"))]
        /// Setter for [`itemSeparatorHandler`][Self::itemSeparatorHandler].
        ///
        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
        ///
        /// # Safety
        ///
        /// `item_separator_handler` must be a valid pointer or null.
        #[unsafe(method(setItemSeparatorHandler:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setItemSeparatorHandler(
            &self,
            item_separator_handler: UICollectionLayoutListItemSeparatorHandler,
        );

        #[cfg(feature = "UIColor")]
        /// The background color of the section.
        /// Defaults to nil, indicating the system background color for the specified appearance is used.
        #[unsafe(method(backgroundColor))]
        #[unsafe(method_family = none)]
        pub fn backgroundColor(&self) -> Option<Retained<UIColor>>;

        #[cfg(feature = "UIColor")]
        /// Setter for [`backgroundColor`][Self::backgroundColor].
        #[unsafe(method(setBackgroundColor:))]
        #[unsafe(method_family = none)]
        pub fn setBackgroundColor(&self, background_color: Option<&UIColor>);

        #[cfg(all(feature = "UISwipeActionsConfiguration", feature = "block2"))]
        /// Called when list is about to show leading swipe actions for a particular index path.
        /// Return either a UISwipeActionsConfiguration object or nil if this index path does not show swipe actions.
        ///
        /// # Safety
        ///
        /// The returned block's argument must be a valid pointer.
        #[unsafe(method(leadingSwipeActionsConfigurationProvider))]
        #[unsafe(method_family = none)]
        pub unsafe fn leadingSwipeActionsConfigurationProvider(
            &self,
        ) -> UICollectionLayoutListSwipeActionsConfigurationProvider;

        #[cfg(all(feature = "UISwipeActionsConfiguration", feature = "block2"))]
        /// Setter for [`leadingSwipeActionsConfigurationProvider`][Self::leadingSwipeActionsConfigurationProvider].
        ///
        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
        ///
        /// # Safety
        ///
        /// `leading_swipe_actions_configuration_provider` must be a valid pointer or null.
        #[unsafe(method(setLeadingSwipeActionsConfigurationProvider:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setLeadingSwipeActionsConfigurationProvider(
            &self,
            leading_swipe_actions_configuration_provider: UICollectionLayoutListSwipeActionsConfigurationProvider,
        );

        #[cfg(all(feature = "UISwipeActionsConfiguration", feature = "block2"))]
        /// Called when list is about to show trailing swipe actions for a particular index path.
        /// Return either a UISwipeActionsConfiguration object or nil if this index path does not show swipe actions.
        ///
        /// # Safety
        ///
        /// The returned block's argument must be a valid pointer.
        #[unsafe(method(trailingSwipeActionsConfigurationProvider))]
        #[unsafe(method_family = none)]
        pub unsafe fn trailingSwipeActionsConfigurationProvider(
            &self,
        ) -> UICollectionLayoutListSwipeActionsConfigurationProvider;

        #[cfg(all(feature = "UISwipeActionsConfiguration", feature = "block2"))]
        /// Setter for [`trailingSwipeActionsConfigurationProvider`][Self::trailingSwipeActionsConfigurationProvider].
        ///
        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
        ///
        /// # Safety
        ///
        /// `trailing_swipe_actions_configuration_provider` must be a valid pointer or null.
        #[unsafe(method(setTrailingSwipeActionsConfigurationProvider:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setTrailingSwipeActionsConfigurationProvider(
            &self,
            trailing_swipe_actions_configuration_provider: UICollectionLayoutListSwipeActionsConfigurationProvider,
        );

        /// Defines whether the section has a header. Defaults to UICollectionLayoutListHeaderModeNone.
        #[unsafe(method(headerMode))]
        #[unsafe(method_family = none)]
        pub fn headerMode(&self) -> UICollectionLayoutListHeaderMode;

        /// Setter for [`headerMode`][Self::headerMode].
        #[unsafe(method(setHeaderMode:))]
        #[unsafe(method_family = none)]
        pub fn setHeaderMode(&self, header_mode: UICollectionLayoutListHeaderMode);

        /// Defines whether the section has a footer. Defaults to UICollectionLayoutListFooterModeNone.
        #[unsafe(method(footerMode))]
        #[unsafe(method_family = none)]
        pub fn footerMode(&self) -> UICollectionLayoutListFooterMode;

        /// Setter for [`footerMode`][Self::footerMode].
        #[unsafe(method(setFooterMode:))]
        #[unsafe(method_family = none)]
        pub fn setFooterMode(&self, footer_mode: UICollectionLayoutListFooterMode);

        #[cfg(feature = "objc2-core-foundation")]
        /// Padding above each section header. The default value is `UICollectionViewLayoutAutomaticDimension`
        #[unsafe(method(headerTopPadding))]
        #[unsafe(method_family = none)]
        pub fn headerTopPadding(&self) -> CGFloat;

        #[cfg(feature = "objc2-core-foundation")]
        /// Setter for [`headerTopPadding`][Self::headerTopPadding].
        #[unsafe(method(setHeaderTopPadding:))]
        #[unsafe(method_family = none)]
        pub fn setHeaderTopPadding(&self, header_top_padding: CGFloat);

        /// Determines the type of items that will tightly hug their content.
        ///
        /// The default value for this property is `UICollectionLayoutListContentHuggingElementsSupplementaryHeader` on visionOS for plain style table views and an empty set on all other platforms.
        /// When the value of this property is `UICollectionLayoutListContentHuggingElementsSupplementaryHeader`, the header view will not stretch the width of the collection view if its content's intrinsic content size is less than the collection view's width.
        #[unsafe(method(contentHuggingElements))]
        #[unsafe(method_family = none)]
        pub fn contentHuggingElements(&self) -> UICollectionLayoutListContentHuggingElements;

        /// Setter for [`contentHuggingElements`][Self::contentHuggingElements].
        #[unsafe(method(setContentHuggingElements:))]
        #[unsafe(method_family = none)]
        pub fn setContentHuggingElements(
            &self,
            content_hugging_elements: UICollectionLayoutListContentHuggingElements,
        );
    );
}

/// UICollectionLayoutListSection.
#[cfg(feature = "UICollectionViewCompositionalLayout")]
impl NSCollectionLayoutSection {
    extern_methods!(
        /// Creates a list section using the specified configuration. You should pass the layoutEnvironment from inside the UICollectionViewCompositionalLayoutSectionProvider.
        #[unsafe(method(sectionWithListConfiguration:layoutEnvironment:))]
        #[unsafe(method_family = none)]
        pub fn sectionWithListConfiguration_layoutEnvironment(
            configuration: &UICollectionLayoutListConfiguration,
            layout_environment: &ProtocolObject<dyn NSCollectionLayoutEnvironment>,
        ) -> Retained<Self>;
    );
}

/// UICollectionLayoutListSection.
#[cfg(all(
    feature = "UICollectionViewCompositionalLayout",
    feature = "UICollectionViewLayout"
))]
impl UICollectionViewCompositionalLayout {
    extern_methods!(
        /// Creates a compositional layout containing only list sections of the specified configuration.
        #[unsafe(method(layoutWithListConfiguration:))]
        #[unsafe(method_family = none)]
        pub fn layoutWithListConfiguration(
            configuration: &UICollectionLayoutListConfiguration,
        ) -> Retained<Self>;
    );
}