mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-22 16:58:23 +00:00
118 lines
5.4 KiB
Objective-C
118 lines
5.4 KiB
Objective-C
/**
|
|
* Copyright (c) 2016-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*/
|
|
|
|
#import <UIKit/UIKit.h>
|
|
|
|
#import <IGListKit/IGListBatchUpdateData.h>
|
|
|
|
@class IGListAdapterUpdater;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
A protocol that receives events about IGListAdapterUpdater operations.
|
|
*/
|
|
@protocol IGListAdapterUpdaterDelegate <NSObject>
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call -[UICollectionView performBatchUpdates:completion:].
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param collectionView The collection view that will perform the batch updates.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater willPerformBatchUpdatesWithCollectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater succesfully finished -[UICollectionView performBatchUpdates:completion:].
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param collectionView The collection view that performed the batch updates.
|
|
|
|
@discussion This event is called in the completion block of the batch update.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater didPerformBatchUpdates:(IGListBatchUpdateData *)updates withCollectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call -[UICollectionView insertItemsAtIndexPaths:].
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param indexPaths An array of index paths that will be inserted.
|
|
@param collectionView The collection view that will perform the insert.
|
|
|
|
@discussion This event is only sent when outside of -[UICollectionView performBatchUpdates:completion:].
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater willInsertIndexPaths:(NSArray<NSIndexPath *> *)indexPaths collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call -[UICollectionView deleteItemsAtIndexPaths:].
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param indexPaths An array of index paths that will be deleted.
|
|
@param collectionView The collection view that will perform the delete.
|
|
|
|
@discussion This event is only sent when outside of -[UICollectionView performBatchUpdates:completion:].
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater willDeleteIndexPaths:(NSArray<NSIndexPath *> *)indexPaths collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call -[UICollectionView reloadItemsAtIndexPaths:].
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param indexPaths An array of index paths that will be reloaded.
|
|
@param collectionView The collection view that will perform the reload.
|
|
|
|
@discussion This event is only sent when outside of -[UICollectionView performBatchUpdates:completion:].
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater willReloadIndexPaths:(NSArray<NSIndexPath *> *)indexPaths collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call -[UICollectionView reloadSections:].
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param sections The sections that will be reloaded
|
|
@param collectionView The collection view that will perform the reload.
|
|
|
|
@discussion This event is only sent when outside of -[UICollectionView performBatchUpdates:completion:].
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater willReloadSections:(NSIndexSet *)sections collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call -[UICollectionView reloadData].
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param collectionView The collection view that will be reloaded.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater willReloadDataWithCollectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater successfully called -[UICollectionView reloadData].
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param collectionView The collection view that reloaded.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater didReloadDataWithCollectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the collection view threw an exception in -[UICollectionView performBatchUpdates:completion:].
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param exception The exception thrown by the collection view.
|
|
@param fromObjects The items transitioned from in the diff, if any.
|
|
@param toObjects The items transitioned to in the diff, if any.
|
|
@param updates The batch updates that were applied to the collection view.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
willCrashWithException:(NSException *)exception
|
|
fromObjects:(nullable NSArray *)fromObjects
|
|
toObjects:(nullable NSArray *)toObjects
|
|
updates:(IGListBatchUpdateData *)updates;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|