Up

NSCollectionViewLayout documentation

Authors

Generated by Gregory John Casamento,,,

Date: Generated at 2024-11-13 12:52:37 -0500


Contents -

  1. Software documentation for the NSCollectionViewLayout class
  2. Software documentation for the NSCollectionViewLayoutAttributes class
  3. Software documentation for the NSCollectionViewLayoutInvalidationContext class
  4. Software documentation for the NSCollectionViewUpdateItem class
  5. Software documentation for the NSCollectionViewLayout(NSSubclassingHooks) category
  6. Software documentation for the NSCollectionViewLayout(NSUpdateSupportHooks) category

Software documentation for the NSCollectionViewLayout class

NSCollectionViewLayout : NSObject

class_NSCollectionViewLayout NSObject NSObject NSCollectionViewLayout NSCollectionViewLayout NSObject->NSCollectionViewLayout
Declared in:
AppKit/NSCollectionViewLayout.h
Availability: MacOS-X 10.11.0

Description forthcoming.

Instance Variables

Method summary


collectionView 

- (NSCollectionView*) collectionView;
Availability: MacOS-X 10.11.0

Description forthcoming.

invalidateLayout 

- (void) invalidateLayout;
Availability: MacOS-X 10.11.0

Description forthcoming.

invalidateLayoutWithContext: 

- (void) invalidateLayoutWithContext: (NSCollectionViewLayoutInvalidationContext*)context;
Availability: MacOS-X 10.11.0

Description forthcoming.

registerClass: forDecorationViewOfKind: 

- (void) registerClass: (Class)viewClass forDecorationViewOfKind: (NSCollectionViewDecorationElementKind)elementKind;
Availability: MacOS-X 10.11.0

Description forthcoming.

registerNib: forDecorationViewOfKind: 

- (void) registerNib: (NSNib*)nib forDecorationViewOfKind: (NSCollectionViewDecorationElementKind)elementKind;
Availability: MacOS-X 10.11.0

Description forthcoming.

setCollectionView: 

- (void) setCollectionView: (NSCollectionView*)cv;
Availability: MacOS-X 10.11.0

Description forthcoming.



Instance Variables for NSCollectionViewLayout Class

_collectionView

@protected NSCollectionView* _collectionView;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_collectionViewContentSize

@protected NSSize _collectionViewContentSize;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_invalidationContextClass

@protected Class _invalidationContextClass;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_layoutAttributesClass

@protected Class _layoutAttributesClass;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_valid

@protected BOOL _valid;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.




Software documentation for the NSCollectionViewLayoutAttributes class

NSCollectionViewLayoutAttributes : NSObject

class_NSCollectionViewLayoutAttributes NSObject NSObject NSCollectionViewLayoutAttributes NSCollectionViewLayoutAttributes NSObject->NSCollectionViewLayoutAttributes
Declared in:
AppKit/NSCollectionViewLayout.h
Availability: MacOS-X 10.11.0

Description forthcoming.

Instance Variables

Method summary


layoutAttributesForDecorationViewOfKind: withIndexPath: 

+ (instancetype) layoutAttributesForDecorationViewOfKind: (NSCollectionViewDecorationElementKind)decorationViewKind withIndexPath: (NSIndexPath*)indexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

layoutAttributesForInterItemGapBeforeIndexPath: 

+ (instancetype) layoutAttributesForInterItemGapBeforeIndexPath: (NSIndexPath*)indexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

layoutAttributesForItemWithIndexPath: 

+ (instancetype) layoutAttributesForItemWithIndexPath: (NSIndexPath*)indexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

layoutAttributesForSupplementaryViewOfKind: withIndexPath: 

+ (instancetype) layoutAttributesForSupplementaryViewOfKind: (NSCollectionViewSupplementaryElementKind)elementKind withIndexPath: (NSIndexPath*)indexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

alpha 

- (CGFloat) alpha;
Availability: MacOS-X 10.11.0

Description forthcoming.

frame 

- (NSRect) frame;
Availability: MacOS-X 10.11.0

Description forthcoming.

indexPath 

- (NSIndexPath*) indexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

isHidden 

- (BOOL) isHidden;
Availability: MacOS-X 10.11.0

Description forthcoming.

representedElementCategory 

- (NSCollectionElementCategory) representedElementCategory;
Availability: MacOS-X 10.11.0

Description forthcoming.

representedElementKind 

- (NSString*) representedElementKind;
Availability: MacOS-X 10.11.0

Description forthcoming.

setAlpha: 

- (void) setAlpha: (CGFloat)alpha;
Availability: MacOS-X 10.11.0

Description forthcoming.

setFrame: 

- (void) setFrame: (NSRect)frame;
Availability: MacOS-X 10.11.0

Description forthcoming.

setHidden: 

- (void) setHidden: (BOOL)hidden;
Availability: MacOS-X 10.11.0

Description forthcoming.

setIndexPath: 

- (void) setIndexPath: (NSIndexPath*)indexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

setSize: 

- (void) setSize: (NSSize)size;
Availability: MacOS-X 10.11.0

Description forthcoming.

setZIndex: 

- (void) setZIndex: (NSInteger)zIndex;
Availability: MacOS-X 10.11.0

Description forthcoming.

size 

- (NSSize) size;
Availability: MacOS-X 10.11.0

Description forthcoming.

zIndex 

- (NSInteger) zIndex;
Availability: MacOS-X 10.11.0

Description forthcoming.



Instance Variables for NSCollectionViewLayoutAttributes Class

_alpha

@protected CGFloat _alpha;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_frame

@protected NSRect _frame;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_hidden

@protected BOOL _hidden;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_indexPath

@protected NSIndexPath* _indexPath;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_representedElementCategory

@protected NSCollectionElementCategory _representedElementCategory;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_representedElementKind

@protected NSString* _representedElementKind;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_zIndex

@protected NSInteger _zIndex;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.




Software documentation for the NSCollectionViewLayoutInvalidationContext class

NSCollectionViewLayoutInvalidationContext : NSObject

class_NSCollectionViewLayoutInvalidationContext NSObject NSObject NSCollectionViewLayoutInvalidationContext NSCollectionViewLayoutInvalidationContext NSObject->NSCollectionViewLayoutInvalidationContext
Declared in:
AppKit/NSCollectionViewLayout.h
Availability: MacOS-X 10.11.0

Description forthcoming.

Instance Variables

Method summary


contentOffsetAdjustment 

- (NSPoint) contentOffsetAdjustment;
Availability: MacOS-X 10.11.0

Description forthcoming.

contentSizeAdjustment 

- (NSSize) contentSizeAdjustment;
Availability: MacOS-X 10.11.0

Description forthcoming.

invalidateDataSourceCounts 

- (BOOL) invalidateDataSourceCounts;
Availability: MacOS-X 10.11.0

Description forthcoming.

invalidateDecorationElementsOfKind: atIndexPaths: 

- (void) invalidateDecorationElementsOfKind: (NSCollectionViewDecorationElementKind)elementKind atIndexPaths: (NSSet*)indexPaths;
Availability: MacOS-X 10.11.0

Description forthcoming.

invalidateEverything 

- (BOOL) invalidateEverything;
Availability: MacOS-X 10.11.0

Description forthcoming.

invalidateItemsAtIndexPaths: 

- (void) invalidateItemsAtIndexPaths: (NSSet*)indexPaths;
Availability: MacOS-X 10.11.0

Description forthcoming.

invalidateSupplementaryElementsOfKind: atIndexPaths: 

- (void) invalidateSupplementaryElementsOfKind: (NSCollectionViewSupplementaryElementKind)elementKind atIndexPaths: (NSSet*)indexPaths;
Availability: MacOS-X 10.11.0

Description forthcoming.

invalidatedDecorationIndexPaths 

- (NSDictionary*) invalidatedDecorationIndexPaths;
Availability: MacOS-X 10.11.0

Description forthcoming.

invalidatedItemIndexPaths 

- (NSSet*) invalidatedItemIndexPaths;
Availability: MacOS-X 10.11.0

Description forthcoming.

invalidatedSupplementaryIndexPaths 

- (NSDictionary*) invalidatedSupplementaryIndexPaths;
Availability: MacOS-X 10.11.0

Description forthcoming.

setContentOffsetAdjustment: 

- (void) setContentOffsetAdjustment: (NSPoint)point;
Availability: MacOS-X 10.11.0

Description forthcoming.

setContentSizeAdjustment: 

- (void) setContentSizeAdjustment: (NSSize)size;
Availability: MacOS-X 10.11.0

Description forthcoming.



Instance Variables for NSCollectionViewLayoutInvalidationContext Class

_contentOffsetAdjustment

@protected NSPoint _contentOffsetAdjustment;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_contentSizeAdjustment

@protected NSSize _contentSizeAdjustment;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_invalidatedDecorationIndexPaths

@protected NSDictionary* _invalidatedDecorationIndexPaths;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_invalidatedItemIndexPaths

@protected NSSet* _invalidatedItemIndexPaths;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_invalidatedSupplementaryIndexPaths

@protected NSDictionary* _invalidatedSupplementaryIndexPaths;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.




Software documentation for the NSCollectionViewUpdateItem class

NSCollectionViewUpdateItem : NSObject

class_NSCollectionViewUpdateItem NSObject NSObject NSCollectionViewUpdateItem NSCollectionViewUpdateItem NSObject->NSCollectionViewUpdateItem
Declared in:
AppKit/NSCollectionViewLayout.h
Availability: MacOS-X 10.11.0

Description forthcoming.

Instance Variables

Method summary


indexPathAfterUpdate 

- (NSIndexPath*) indexPathAfterUpdate;
Availability: MacOS-X 10.11.0

Description forthcoming.

indexPathBeforeUpdate 

- (NSIndexPath*) indexPathBeforeUpdate;
Availability: MacOS-X 10.11.0

Description forthcoming.

updateAction 

- (NSCollectionUpdateAction) updateAction;
Availability: MacOS-X 10.11.0

Description forthcoming.



Instance Variables for NSCollectionViewUpdateItem Class

_indexPathAfterUpdate

@protected NSIndexPath* _indexPathAfterUpdate;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_indexPathBeforeUpdate

@protected NSIndexPath* _indexPathBeforeUpdate;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_updateAction

@protected NSCollectionUpdateAction _updateAction;
Availability: MacOS-X 10.11.0

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.




Software documentation for the NSCollectionViewLayout(NSSubclassingHooks) category

NSCollectionViewLayout(NSSubclassingHooks)

Declared in:
AppKit/NSCollectionViewLayout.h
Availability: MacOS-X 10.11.0

Description forthcoming.

Method summary


collectionViewContentSize 

- (NSSize) collectionViewContentSize;
Availability: MacOS-X 10.11.0

Description forthcoming.

invalidationContextForBoundsChange: 

- (NSCollectionViewLayoutInvalidationContext*) invalidationContextForBoundsChange: (NSRect)newBounds;
Availability: MacOS-X 10.11.0

Description forthcoming.

invalidationContextForPreferredLayoutAttributes: withOriginalAttributes: 

- (NSCollectionViewLayoutInvalidationContext*) invalidationContextForPreferredLayoutAttributes: (NSCollectionViewLayoutAttributes*)preferredAttributes withOriginalAttributes: (NSCollectionViewLayoutAttributes*)originalAttributes;
Availability: MacOS-X 10.11.0

Description forthcoming.

layoutAttributesForDecorationViewOfKind: atIndexPath: 

- (NSCollectionViewLayoutAttributes*) layoutAttributesForDecorationViewOfKind: (NSCollectionViewDecorationElementKind)elementKind atIndexPath: (NSIndexPath*)indexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

layoutAttributesForDropTargetAtPoint: 

- (NSCollectionViewLayoutAttributes*) layoutAttributesForDropTargetAtPoint: (NSPoint)pointInCollectionView;
Availability: MacOS-X 10.11.0

Description forthcoming.

layoutAttributesForElementsInRect: 

- (NSArray*) layoutAttributesForElementsInRect: (NSRect)rect;
Availability: MacOS-X 10.11.0

Description forthcoming.

layoutAttributesForInterItemGapBeforeIndexPath: 

- (NSCollectionViewLayoutAttributes*) layoutAttributesForInterItemGapBeforeIndexPath: (NSIndexPath*)indexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

layoutAttributesForItemAtIndexPath: 

- (NSCollectionViewLayoutAttributes*) layoutAttributesForItemAtIndexPath: (NSIndexPath*)indexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

layoutAttributesForSupplementaryViewOfKind: atIndexPath: 

- (NSCollectionViewLayoutAttributes*) layoutAttributesForSupplementaryViewOfKind: (NSCollectionViewSupplementaryElementKind)elementKind atIndexPath: (NSIndexPath*)indexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

prepareLayout 

- (void) prepareLayout;
Availability: MacOS-X 10.11.0

Description forthcoming.

shouldInvalidateLayoutForBoundsChange: 

- (BOOL) shouldInvalidateLayoutForBoundsChange: (NSRect)newBounds;
Availability: MacOS-X 10.11.0

Description forthcoming.

shouldInvalidateLayoutForPreferredLayoutAttributes: withOriginalAttributes: 

- (BOOL) shouldInvalidateLayoutForPreferredLayoutAttributes: (NSCollectionViewLayoutAttributes*)preferredAttributes withOriginalAttributes: (NSCollectionViewLayoutAttributes*)originalAttributes;
Availability: MacOS-X 10.11.0

Description forthcoming.

targetContentOffsetForProposedContentOffset: 

- (NSPoint) targetContentOffsetForProposedContentOffset: (NSPoint)proposedContentOffset;
Availability: MacOS-X 10.11.0

Description forthcoming.

targetContentOffsetForProposedContentOffset: withScrollingVelocity: 

- (NSPoint) targetContentOffsetForProposedContentOffset: (NSPoint)proposedContentOffset withScrollingVelocity: (NSPoint)velocity;
Availability: MacOS-X 10.11.0

Description forthcoming.

Software documentation for the NSCollectionViewLayout(NSUpdateSupportHooks) category

NSCollectionViewLayout(NSUpdateSupportHooks)

Declared in:
AppKit/NSCollectionViewLayout.h
Availability: MacOS-X 10.11.0

Description forthcoming.

Method summary


finalLayoutAttributesForDisappearingDecorationElementOfKind: atIndexPath: 

- (NSCollectionViewLayoutAttributes*) finalLayoutAttributesForDisappearingDecorationElementOfKind: (NSCollectionViewDecorationElementKind)elementKind atIndexPath: (NSIndexPath*)decorationIndexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

finalLayoutAttributesForDisappearingItemAtIndexPath: 

- (NSCollectionViewLayoutAttributes*) finalLayoutAttributesForDisappearingItemAtIndexPath: (NSIndexPath*)itemIndexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

finalLayoutAttributesForDisappearingSupplementaryElementOfKind: atIndexPath: 

- (NSCollectionViewLayoutAttributes*) finalLayoutAttributesForDisappearingSupplementaryElementOfKind: (NSCollectionViewSupplementaryElementKind)elementKind atIndexPath: (NSIndexPath*)elementIndexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

finalizeAnimatedBoundsChange 

- (void) finalizeAnimatedBoundsChange;
Availability: MacOS-X 10.11.0

Description forthcoming.

finalizeCollectionViewUpdates 

- (void) finalizeCollectionViewUpdates;
Availability: MacOS-X 10.11.0

Description forthcoming.

finalizeLayoutTransition 

- (void) finalizeLayoutTransition;
Availability: MacOS-X 10.11.0

Description forthcoming.

indexPathsToDeleteForDecorationViewOfKind: 

- (NSSet*) indexPathsToDeleteForDecorationViewOfKind: (NSCollectionViewDecorationElementKind)elementKind;
Availability: MacOS-X 10.11.0

Description forthcoming.

indexPathsToDeleteForSupplementaryViewOfKind: 

- (NSSet*) indexPathsToDeleteForSupplementaryViewOfKind: (NSCollectionViewSupplementaryElementKind)elementKind;
Availability: MacOS-X 10.11.0

Description forthcoming.

indexPathsToInsertForDecorationViewOfKind: 

- (NSSet*) indexPathsToInsertForDecorationViewOfKind: (NSCollectionViewDecorationElementKind)elementKind;
Availability: MacOS-X 10.11.0

Description forthcoming.

indexPathsToInsertForSupplementaryViewOfKind: 

- (NSSet*) indexPathsToInsertForSupplementaryViewOfKind: (NSCollectionViewSupplementaryElementKind)elementKind;
Availability: MacOS-X 10.11.0

Description forthcoming.

initialLayoutAttributesForAppearingDecorationElementOfKind: atIndexPath: 

- (NSCollectionViewLayoutAttributes*) initialLayoutAttributesForAppearingDecorationElementOfKind: (NSCollectionViewDecorationElementKind)elementKind atIndexPath: (NSIndexPath*)decorationIndexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

initialLayoutAttributesForAppearingItemAtIndexPath: 

- (NSCollectionViewLayoutAttributes*) initialLayoutAttributesForAppearingItemAtIndexPath: (NSIndexPath*)itemIndexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

initialLayoutAttributesForAppearingSupplementaryElementOfKind: atIndexPath: 

- (NSCollectionViewLayoutAttributes*) initialLayoutAttributesForAppearingSupplementaryElementOfKind: (NSCollectionViewSupplementaryElementKind)elementKind atIndexPath: (NSIndexPath*)elementIndexPath;
Availability: MacOS-X 10.11.0

Description forthcoming.

prepareForAnimatedBoundsChange: 

- (void) prepareForAnimatedBoundsChange: (NSRect)oldBounds;
Availability: MacOS-X 10.11.0

Description forthcoming.

prepareForCollectionViewUpdates: 

- (void) prepareForCollectionViewUpdates: (NSArray*)updateItems;
Availability: MacOS-X 10.11.0

Description forthcoming.

prepareForTransitionFromLayout: 

- (void) prepareForTransitionFromLayout: (NSCollectionViewLayout*)oldLayout;
Availability: MacOS-X 10.11.0

Description forthcoming.

prepareForTransitionToLayout: 

- (void) prepareForTransitionToLayout: (NSCollectionViewLayout*)newLayout;
Availability: MacOS-X 10.11.0

Description forthcoming.


Up