mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-21 08:18:35 +00:00
edc38c77fe
Summary: Issue fixed: #655 - [x] All tests pass. Demo project builds and runs. - [ ] I added tests, an experiment, or detailed why my change isn't tested. - [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) I've also addressed a few cases where there was no empty line between the `param`s and `return`. Closes https://github.com/Instagram/IGListKit/pull/665 Differential Revision: D4906215 Pulled By: jessesquires fbshipit-source-id: 5693c85eb548644b0b0e2571eea8ff4d9f706b12
144 lines
6.2 KiB
Objective-C
144 lines
6.2 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 successfully finished `-[UICollectionView performBatchUpdates:completion:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param updates The batch updates that were applied to the collection view.
|
|
@param collectionView The collection view that performed the batch updates.
|
|
|
|
@note This event is called in the completion block of the batch update.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
didPerformBatchUpdates:(IGListBatchUpdateData *)updates
|
|
collectionView:(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.
|
|
|
|
@note 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.
|
|
|
|
@note 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 moveItemAtIndexPath:toIndexPath:]`
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param fromIndexPath The index path of the item that will be moved.
|
|
@param toIndexPath The index path to move the item to.
|
|
@param collectionView The collection view that will perform the move.
|
|
|
|
@note This event is only sent when outside of `-[UICollectionView performBatchUpdates:completion:]`.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
willMoveFromIndexPath:(NSIndexPath *)fromIndexPath
|
|
toIndexPath:(NSIndexPath *)toIndexPath
|
|
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.
|
|
|
|
@note 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.
|
|
|
|
@note 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
|