#[repr(C)]pub struct UICollectionViewFlowLayout { /* private fields */ }
UICollectionViewFlowLayout
and UICollectionViewLayout
only.Expand description
Implementations§
Source§impl UICollectionViewFlowLayout
impl UICollectionViewFlowLayout
pub unsafe fn minimumLineSpacing(&self) -> CGFloat
objc2-core-foundation
only.Sourcepub unsafe fn setMinimumLineSpacing(&self, minimum_line_spacing: CGFloat)
Available on crate feature objc2-core-foundation
only.
pub unsafe fn setMinimumLineSpacing(&self, minimum_line_spacing: CGFloat)
objc2-core-foundation
only.Setter for minimumLineSpacing
.
pub unsafe fn minimumInteritemSpacing(&self) -> CGFloat
objc2-core-foundation
only.Sourcepub unsafe fn setMinimumInteritemSpacing(
&self,
minimum_interitem_spacing: CGFloat,
)
Available on crate feature objc2-core-foundation
only.
pub unsafe fn setMinimumInteritemSpacing( &self, minimum_interitem_spacing: CGFloat, )
objc2-core-foundation
only.Setter for minimumInteritemSpacing
.
pub unsafe fn itemSize(&self) -> CGSize
objc2-core-foundation
only.Sourcepub unsafe fn setItemSize(&self, item_size: CGSize)
Available on crate feature objc2-core-foundation
only.
pub unsafe fn setItemSize(&self, item_size: CGSize)
objc2-core-foundation
only.Setter for itemSize
.
pub unsafe fn estimatedItemSize(&self) -> CGSize
objc2-core-foundation
only.Sourcepub unsafe fn setEstimatedItemSize(&self, estimated_item_size: CGSize)
Available on crate feature objc2-core-foundation
only.
pub unsafe fn setEstimatedItemSize(&self, estimated_item_size: CGSize)
objc2-core-foundation
only.Setter for estimatedItemSize
.
pub unsafe fn scrollDirection(&self) -> UICollectionViewScrollDirection
Sourcepub unsafe fn setScrollDirection(
&self,
scroll_direction: UICollectionViewScrollDirection,
)
pub unsafe fn setScrollDirection( &self, scroll_direction: UICollectionViewScrollDirection, )
Setter for scrollDirection
.
pub unsafe fn headerReferenceSize(&self) -> CGSize
objc2-core-foundation
only.Sourcepub unsafe fn setHeaderReferenceSize(&self, header_reference_size: CGSize)
Available on crate feature objc2-core-foundation
only.
pub unsafe fn setHeaderReferenceSize(&self, header_reference_size: CGSize)
objc2-core-foundation
only.Setter for headerReferenceSize
.
objc2-core-foundation
only.Available on crate feature objc2-core-foundation
only.
objc2-core-foundation
only.Setter for footerReferenceSize
.
pub unsafe fn sectionInset(&self) -> UIEdgeInsets
UIGeometry
and objc2-core-foundation
only.Sourcepub unsafe fn setSectionInset(&self, section_inset: UIEdgeInsets)
Available on crate features UIGeometry
and objc2-core-foundation
only.
pub unsafe fn setSectionInset(&self, section_inset: UIEdgeInsets)
UIGeometry
and objc2-core-foundation
only.Setter for sectionInset
.
Sourcepub unsafe fn sectionInsetReference(
&self,
) -> UICollectionViewFlowLayoutSectionInsetReference
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.
Sourcepub unsafe fn setSectionInsetReference(
&self,
section_inset_reference: UICollectionViewFlowLayoutSectionInsetReference,
)
pub unsafe fn setSectionInsetReference( &self, section_inset_reference: UICollectionViewFlowLayoutSectionInsetReference, )
Setter for sectionInsetReference
.
pub unsafe fn sectionHeadersPinToVisibleBounds(&self) -> bool
Sourcepub unsafe fn setSectionHeadersPinToVisibleBounds(
&self,
section_headers_pin_to_visible_bounds: bool,
)
pub unsafe fn setSectionHeadersPinToVisibleBounds( &self, section_headers_pin_to_visible_bounds: bool, )
Setter for sectionHeadersPinToVisibleBounds
.
Setter for sectionFootersPinToVisibleBounds
.
Source§impl UICollectionViewFlowLayout
Methods declared on superclass UICollectionViewLayout
.
impl UICollectionViewFlowLayout
Methods declared on superclass UICollectionViewLayout
.
Source§impl UICollectionViewFlowLayout
Methods declared on superclass NSObject
.
impl UICollectionViewFlowLayout
Methods declared on superclass NSObject
.
pub unsafe fn new(mtm: MainThreadMarker) -> Retained<Self>
Methods from Deref<Target = UICollectionViewLayout>§
pub unsafe fn collectionView(&self) -> Option<Retained<UICollectionView>>
UICollectionView
and UIResponder
and UIScrollView
and UIView
only.pub unsafe fn invalidateLayout(&self)
pub unsafe fn invalidateLayoutWithContext( &self, context: &UICollectionViewLayoutInvalidationContext, )
pub unsafe fn registerClass_forDecorationViewOfKind( &self, view_class: Option<&AnyClass>, element_kind: &NSString, )
pub unsafe fn registerNib_forDecorationViewOfKind( &self, nib: Option<&UINib>, element_kind: &NSString, )
UINib
only.pub unsafe fn prepareLayout(&self)
pub unsafe fn layoutAttributesForElementsInRect( &self, rect: CGRect, ) -> Option<Retained<NSArray<UICollectionViewLayoutAttributes>>>
objc2-core-foundation
only.pub unsafe fn layoutAttributesForItemAtIndexPath( &self, index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>
pub unsafe fn layoutAttributesForSupplementaryViewOfKind_atIndexPath( &self, element_kind: &NSString, index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>
pub unsafe fn layoutAttributesForDecorationViewOfKind_atIndexPath( &self, element_kind: &NSString, index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>
pub unsafe fn shouldInvalidateLayoutForBoundsChange( &self, new_bounds: CGRect, ) -> bool
objc2-core-foundation
only.pub unsafe fn invalidationContextForBoundsChange( &self, new_bounds: CGRect, ) -> Retained<UICollectionViewLayoutInvalidationContext>
objc2-core-foundation
only.pub unsafe fn shouldInvalidateLayoutForPreferredLayoutAttributes_withOriginalAttributes( &self, preferred_attributes: &UICollectionViewLayoutAttributes, original_attributes: &UICollectionViewLayoutAttributes, ) -> bool
pub unsafe fn invalidationContextForPreferredLayoutAttributes_withOriginalAttributes( &self, preferred_attributes: &UICollectionViewLayoutAttributes, original_attributes: &UICollectionViewLayoutAttributes, ) -> Retained<UICollectionViewLayoutInvalidationContext>
pub unsafe fn targetContentOffsetForProposedContentOffset_withScrollingVelocity( &self, proposed_content_offset: CGPoint, velocity: CGPoint, ) -> CGPoint
objc2-core-foundation
only.pub unsafe fn targetContentOffsetForProposedContentOffset( &self, proposed_content_offset: CGPoint, ) -> CGPoint
objc2-core-foundation
only.pub unsafe fn collectionViewContentSize(&self) -> CGSize
objc2-core-foundation
only.pub unsafe fn developmentLayoutDirection( &self, ) -> UIUserInterfaceLayoutDirection
UIInterface
only.pub unsafe fn flipsHorizontallyInOppositeLayoutDirection(&self) -> bool
pub unsafe fn prepareForCollectionViewUpdates( &self, update_items: &NSArray<UICollectionViewUpdateItem>, )
UICollectionViewUpdateItem
only.pub unsafe fn finalizeCollectionViewUpdates(&self)
pub unsafe fn prepareForAnimatedBoundsChange(&self, old_bounds: CGRect)
objc2-core-foundation
only.pub unsafe fn finalizeAnimatedBoundsChange(&self)
pub unsafe fn prepareForTransitionToLayout( &self, new_layout: &UICollectionViewLayout, )
pub unsafe fn prepareForTransitionFromLayout( &self, old_layout: &UICollectionViewLayout, )
pub unsafe fn finalizeLayoutTransition(&self)
pub unsafe fn initialLayoutAttributesForAppearingItemAtIndexPath( &self, item_index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>
pub unsafe fn finalLayoutAttributesForDisappearingItemAtIndexPath( &self, item_index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>
pub unsafe fn initialLayoutAttributesForAppearingSupplementaryElementOfKind_atIndexPath( &self, element_kind: &NSString, element_index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>
pub unsafe fn finalLayoutAttributesForDisappearingSupplementaryElementOfKind_atIndexPath( &self, element_kind: &NSString, element_index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>
pub unsafe fn initialLayoutAttributesForAppearingDecorationElementOfKind_atIndexPath( &self, element_kind: &NSString, decoration_index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>
pub unsafe fn finalLayoutAttributesForDisappearingDecorationElementOfKind_atIndexPath( &self, element_kind: &NSString, decoration_index_path: &NSIndexPath, ) -> Option<Retained<UICollectionViewLayoutAttributes>>
pub unsafe fn indexPathsToDeleteForSupplementaryViewOfKind( &self, element_kind: &NSString, ) -> Retained<NSArray<NSIndexPath>>
pub unsafe fn indexPathsToDeleteForDecorationViewOfKind( &self, element_kind: &NSString, ) -> Retained<NSArray<NSIndexPath>>
pub unsafe fn indexPathsToInsertForSupplementaryViewOfKind( &self, element_kind: &NSString, ) -> Retained<NSArray<NSIndexPath>>
pub unsafe fn indexPathsToInsertForDecorationViewOfKind( &self, element_kind: &NSString, ) -> Retained<NSArray<NSIndexPath>>
pub unsafe fn targetIndexPathForInteractivelyMovingItem_withPosition( &self, previous_index_path: &NSIndexPath, position: CGPoint, ) -> Retained<NSIndexPath>
objc2-core-foundation
only.pub unsafe fn layoutAttributesForInteractivelyMovingItemAtIndexPath_withTargetPosition( &self, index_path: &NSIndexPath, position: CGPoint, ) -> Retained<UICollectionViewLayoutAttributes>
objc2-core-foundation
only.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>
objc2-core-foundation
only.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>§
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
Available on crate feature UIIndirectScribbleInteraction
only.
pub fn class(&self) -> &'static AnyClass
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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.Available on crate feature UIIndirectScribbleInteraction
only.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
Available on crate feature UIIndirectScribbleInteraction
only.
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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
impl AsRef<AnyObject> for UICollectionViewFlowLayout
Source§impl AsRef<NSObject> for UICollectionViewFlowLayout
impl AsRef<NSObject> for UICollectionViewFlowLayout
Source§impl AsRef<UICollectionViewLayout> for UICollectionViewFlowLayout
impl AsRef<UICollectionViewLayout> for UICollectionViewFlowLayout
Source§fn as_ref(&self) -> &UICollectionViewLayout
fn as_ref(&self) -> &UICollectionViewLayout
Source§impl Borrow<AnyObject> for UICollectionViewFlowLayout
impl Borrow<AnyObject> for UICollectionViewFlowLayout
Source§impl Borrow<NSObject> for UICollectionViewFlowLayout
impl Borrow<NSObject> for UICollectionViewFlowLayout
Source§impl Borrow<UICollectionViewLayout> for UICollectionViewFlowLayout
impl Borrow<UICollectionViewLayout> for UICollectionViewFlowLayout
Source§fn borrow(&self) -> &UICollectionViewLayout
fn borrow(&self) -> &UICollectionViewLayout
Source§impl ClassType for UICollectionViewFlowLayout
impl ClassType for UICollectionViewFlowLayout
Source§const NAME: &'static str = "UICollectionViewFlowLayout"
const NAME: &'static str = "UICollectionViewFlowLayout"
Source§type Super = UICollectionViewLayout
type Super = UICollectionViewLayout
Source§type ThreadKind = dyn MainThreadOnly
type ThreadKind = dyn MainThreadOnly
Source§impl Debug for UICollectionViewFlowLayout
impl Debug for UICollectionViewFlowLayout
Source§impl Deref for UICollectionViewFlowLayout
impl Deref for UICollectionViewFlowLayout
Source§impl Hash for UICollectionViewFlowLayout
impl Hash for UICollectionViewFlowLayout
Source§impl Message for UICollectionViewFlowLayout
impl Message for UICollectionViewFlowLayout
Source§impl NSObjectProtocol for UICollectionViewFlowLayout
impl NSObjectProtocol for UICollectionViewFlowLayout
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
Source§fn isMemberOfClass(&self, cls: &AnyClass) -> bool
fn isMemberOfClass(&self, cls: &AnyClass) -> bool
Source§fn respondsToSelector(&self, aSelector: Sel) -> bool
fn respondsToSelector(&self, aSelector: Sel) -> bool
Source§fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
Source§fn debugDescription(&self) -> Retained<NSObject>
fn debugDescription(&self) -> Retained<NSObject>
Source§impl RefEncode for UICollectionViewFlowLayout
impl RefEncode for UICollectionViewFlowLayout
Source§const ENCODING_REF: Encoding = <UICollectionViewLayout as ::objc2::RefEncode>::ENCODING_REF
const ENCODING_REF: Encoding = <UICollectionViewLayout as ::objc2::RefEncode>::ENCODING_REF
impl DowncastTarget for UICollectionViewFlowLayout
impl Eq for UICollectionViewFlowLayout
Auto Trait Implementations§
impl !Freeze for UICollectionViewFlowLayout
impl !RefUnwindSafe for UICollectionViewFlowLayout
impl !Send for UICollectionViewFlowLayout
impl !Sync for UICollectionViewFlowLayout
impl !Unpin for UICollectionViewFlowLayout
impl !UnwindSafe for UICollectionViewFlowLayout
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<'a, T> MainThreadOnly for T
impl<'a, T> MainThreadOnly for T
Source§fn mtm(&self) -> MainThreadMarker
fn mtm(&self) -> MainThreadMarker
MainThreadMarker
from the main-thread-only object. Read more