Struct UICollectionViewFlowLayout

Source
#[repr(C)]
pub struct UICollectionViewFlowLayout { /* private fields */ }
Available on crate features UICollectionViewFlowLayout and UICollectionViewLayout only.
Expand description

Implementations§

Source§

impl UICollectionViewFlowLayout

Source

pub unsafe fn minimumLineSpacing(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn setMinimumLineSpacing(&self, minimum_line_spacing: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for minimumLineSpacing.

Source

pub unsafe fn minimumInteritemSpacing(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn setMinimumInteritemSpacing( &self, minimum_interitem_spacing: CGFloat, )

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn itemSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn setItemSize(&self, item_size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for itemSize.

Source

pub unsafe fn estimatedItemSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn setEstimatedItemSize(&self, estimated_item_size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for estimatedItemSize.

Source

pub unsafe fn scrollDirection(&self) -> UICollectionViewScrollDirection

Source

pub unsafe fn setScrollDirection( &self, scroll_direction: UICollectionViewScrollDirection, )

Setter for scrollDirection.

Source

pub unsafe fn headerReferenceSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn setHeaderReferenceSize(&self, header_reference_size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for headerReferenceSize.

Source

pub unsafe fn footerReferenceSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn setFooterReferenceSize(&self, footer_reference_size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for footerReferenceSize.

Source

pub unsafe fn sectionInset(&self) -> UIEdgeInsets

Available on crate features UIGeometry and objc2-core-foundation only.
Source

pub unsafe fn setSectionInset(&self, section_inset: UIEdgeInsets)

Available on crate features UIGeometry and objc2-core-foundation only.

Setter for sectionInset.

Source

pub unsafe fn sectionInsetReference( &self, ) -> UICollectionViewFlowLayoutSectionInsetReference

The reference boundary that the section insets will be defined as relative to. Defaults to .fromContentInset. NOTE: Content inset will always be respected at a minimum. For example, if the sectionInsetReference equals .fromSafeArea, but the adjusted content inset is greater that the combination of the safe area and section insets, then section content will be aligned with the content inset instead.

Source

pub unsafe fn setSectionInsetReference( &self, section_inset_reference: UICollectionViewFlowLayoutSectionInsetReference, )

Source

pub unsafe fn sectionHeadersPinToVisibleBounds(&self) -> bool

Source

pub unsafe fn setSectionHeadersPinToVisibleBounds( &self, section_headers_pin_to_visible_bounds: bool, )

Source

pub unsafe fn sectionFootersPinToVisibleBounds(&self) -> bool

Source

pub unsafe fn setSectionFootersPinToVisibleBounds( &self, section_footers_pin_to_visible_bounds: bool, )

Source§

impl UICollectionViewFlowLayout

Methods declared on superclass UICollectionViewLayout.

Source

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

Source

pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

Source§

impl UICollectionViewFlowLayout

Methods declared on superclass NSObject.

Source

pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>

Methods from Deref<Target = UICollectionViewLayout>§

Source

pub unsafe fn collectionView(&self) -> Option<Retained<UICollectionView>>

Available on crate features UICollectionView and UIResponder and UIScrollView and UIView only.
Source

pub unsafe fn invalidateLayout(&self)

Source

pub unsafe fn invalidateLayoutWithContext( &self, context: &UICollectionViewLayoutInvalidationContext, )

Source

pub unsafe fn registerClass_forDecorationViewOfKind( &self, view_class: Option<&AnyClass>, element_kind: &NSString, )

Source

pub unsafe fn registerNib_forDecorationViewOfKind( &self, nib: Option<&UINib>, element_kind: &NSString, )

👎Deprecated: Loading Interface Builder products will not be supported in a future version of visionOS.
Available on crate feature UINib only.
Source

pub unsafe fn prepareLayout(&self)

Source

pub unsafe fn layoutAttributesForElementsInRect( &self, rect: CGRect, ) -> Option<Retained<NSArray<UICollectionViewLayoutAttributes>>>

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn layoutAttributesForItemAtIndexPath( &self, index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>

Source

pub unsafe fn layoutAttributesForSupplementaryViewOfKind_atIndexPath( &self, element_kind: &NSString, index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>

Source

pub unsafe fn layoutAttributesForDecorationViewOfKind_atIndexPath( &self, element_kind: &NSString, index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>

Source

pub unsafe fn shouldInvalidateLayoutForBoundsChange( &self, new_bounds: CGRect, ) -> bool

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn invalidationContextForBoundsChange( &self, new_bounds: CGRect, ) -> Retained<UICollectionViewLayoutInvalidationContext>

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn shouldInvalidateLayoutForPreferredLayoutAttributes_withOriginalAttributes( &self, preferred_attributes: &UICollectionViewLayoutAttributes, original_attributes: &UICollectionViewLayoutAttributes, ) -> bool

Source

pub unsafe fn invalidationContextForPreferredLayoutAttributes_withOriginalAttributes( &self, preferred_attributes: &UICollectionViewLayoutAttributes, original_attributes: &UICollectionViewLayoutAttributes, ) -> Retained<UICollectionViewLayoutInvalidationContext>

Source

pub unsafe fn targetContentOffsetForProposedContentOffset_withScrollingVelocity( &self, proposed_content_offset: CGPoint, velocity: CGPoint, ) -> CGPoint

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn targetContentOffsetForProposedContentOffset( &self, proposed_content_offset: CGPoint, ) -> CGPoint

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn collectionViewContentSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn developmentLayoutDirection( &self, ) -> UIUserInterfaceLayoutDirection

Available on crate feature UIInterface only.
Source

pub unsafe fn flipsHorizontallyInOppositeLayoutDirection(&self) -> bool

Source

pub unsafe fn prepareForCollectionViewUpdates( &self, update_items: &NSArray<UICollectionViewUpdateItem>, )

Available on crate feature UICollectionViewUpdateItem only.
Source

pub unsafe fn finalizeCollectionViewUpdates(&self)

Source

pub unsafe fn prepareForAnimatedBoundsChange(&self, old_bounds: CGRect)

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn finalizeAnimatedBoundsChange(&self)

Source

pub unsafe fn prepareForTransitionToLayout( &self, new_layout: &UICollectionViewLayout, )

Source

pub unsafe fn prepareForTransitionFromLayout( &self, old_layout: &UICollectionViewLayout, )

Source

pub unsafe fn finalizeLayoutTransition(&self)

Source

pub unsafe fn initialLayoutAttributesForAppearingItemAtIndexPath( &self, item_index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>

Source

pub unsafe fn finalLayoutAttributesForDisappearingItemAtIndexPath( &self, item_index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>

Source

pub unsafe fn initialLayoutAttributesForAppearingSupplementaryElementOfKind_atIndexPath( &self, element_kind: &NSString, element_index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>

Source

pub unsafe fn finalLayoutAttributesForDisappearingSupplementaryElementOfKind_atIndexPath( &self, element_kind: &NSString, element_index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>

Source

pub unsafe fn initialLayoutAttributesForAppearingDecorationElementOfKind_atIndexPath( &self, element_kind: &NSString, decoration_index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>

Source

pub unsafe fn finalLayoutAttributesForDisappearingDecorationElementOfKind_atIndexPath( &self, element_kind: &NSString, decoration_index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>

Source

pub unsafe fn indexPathsToDeleteForSupplementaryViewOfKind( &self, element_kind: &NSString, ) -> Retained<NSArray<NSIndexPath>>

Source

pub unsafe fn indexPathsToDeleteForDecorationViewOfKind( &self, element_kind: &NSString, ) -> Retained<NSArray<NSIndexPath>>

Source

pub unsafe fn indexPathsToInsertForSupplementaryViewOfKind( &self, element_kind: &NSString, ) -> Retained<NSArray<NSIndexPath>>

Source

pub unsafe fn indexPathsToInsertForDecorationViewOfKind( &self, element_kind: &NSString, ) -> Retained<NSArray<NSIndexPath>>

Source

pub unsafe fn targetIndexPathForInteractivelyMovingItem_withPosition( &self, previous_index_path: &NSIndexPath, position: CGPoint, ) -> Retained<NSIndexPath>

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn layoutAttributesForInteractivelyMovingItemAtIndexPath_withTargetPosition( &self, index_path: &NSIndexPath, position: CGPoint, ) -> Retained<UICollectionViewLayoutAttributes>

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn invalidationContextForInteractivelyMovingItems_withTargetPosition_previousIndexPaths_previousPosition( &self, target_index_paths: &NSArray<NSIndexPath>, target_position: CGPoint, previous_index_paths: &NSArray<NSIndexPath>, previous_position: CGPoint, ) -> Retained<UICollectionViewLayoutInvalidationContext>

Available on crate feature objc2-core-foundation only.
Source

pub unsafe fn invalidationContextForEndingInteractiveMovementOfItemsToFinalIndexPaths_previousIndexPaths_movementCancelled( &self, index_paths: &NSArray<NSIndexPath>, previous_index_paths: &NSArray<NSIndexPath>, movement_cancelled: bool, ) -> Retained<UICollectionViewLayoutInvalidationContext>

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Available on crate feature UIIndirectScribbleInteraction 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());
Source

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 UIIndirectScribbleInteraction 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.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Available on crate feature UIIndirectScribbleInteraction 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§

Source§

impl AsRef<AnyObject> for UICollectionViewFlowLayout

Source§

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for UICollectionViewFlowLayout

Source§

fn as_ref(&self) -> &NSObject

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

impl AsRef<UICollectionViewFlowLayout> for UICollectionViewFlowLayout

Source§

fn as_ref(&self) -> &Self

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

impl AsRef<UICollectionViewLayout> for UICollectionViewFlowLayout

Source§

fn as_ref(&self) -> &UICollectionViewLayout

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

impl Borrow<AnyObject> for UICollectionViewFlowLayout

Source§

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value. Read more
Source§

impl Borrow<NSObject> for UICollectionViewFlowLayout

Source§

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value. Read more
Source§

impl Borrow<UICollectionViewLayout> for UICollectionViewFlowLayout

Source§

fn borrow(&self) -> &UICollectionViewLayout

Immutably borrows from an owned value. Read more
Source§

impl ClassType for UICollectionViewFlowLayout

Source§

const NAME: &'static str = "UICollectionViewFlowLayout"

The name of the Objective-C class that this type represents. Read more
Source§

type Super = UICollectionViewLayout

The superclass of this class. Read more
Source§

type ThreadKind = dyn MainThreadOnly

Whether the type can be used from any thread, or from only the main thread. Read more
Source§

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents. Read more
Source§

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.
Source§

impl Debug for UICollectionViewFlowLayout

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deref for UICollectionViewFlowLayout

Source§

type Target = UICollectionViewLayout

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl Hash for UICollectionViewFlowLayout

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Message for UICollectionViewFlowLayout

Source§

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more
Source§

impl NSCoding for UICollectionViewFlowLayout

Source§

unsafe fn encodeWithCoder(&self, coder: &NSCoder)
where Self: Sized + Message,

Source§

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>
where Self: Sized + Message,

Source§

impl NSObjectProtocol for UICollectionViewFlowLayout

Source§

fn isEqual(&self, other: Option<&AnyObject>) -> bool
where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object. Read more
Source§

fn hash(&self) -> usize
where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure. Read more
Source§

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. Read more
Source§

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. Read more
Source§

fn isMemberOfClass(&self, cls: &AnyClass) -> bool
where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses. Read more
Source§

fn respondsToSelector(&self, aSelector: Sel) -> bool
where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector. Read more
Source§

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
where Self: Sized + Message,

Check whether the object conforms to a given protocol. Read more
Source§

fn description(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object. Read more
Source§

fn debugDescription(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object to use when debugging. Read more
Source§

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. Read more
Source§

fn retainCount(&self) -> usize
where Self: Sized + Message,

The reference count of the object. Read more
Source§

impl PartialEq for UICollectionViewFlowLayout

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl RefEncode for UICollectionViewFlowLayout

Source§

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

The Objective-C type-encoding for a reference of this type. Read more
Source§

impl DowncastTarget for UICollectionViewFlowLayout

Source§

impl Eq for UICollectionViewFlowLayout

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<'a, T> MainThreadOnly for T
where T: ClassType<ThreadKind = dyn MainThreadOnly + 'a> + ?Sized,

Source§

fn mtm(&self) -> MainThreadMarker

Get a MainThreadMarker from the main-thread-only object. Read more
Source§

fn alloc(mtm: MainThreadMarker) -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class on the main thread. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,