mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-19 15:28:54 +00:00
204f7d5390
Summary: Did a full pass on documentation. - Clean up - Fixes - Better markdown > **NOTE:** this PR does not re-gen docs. I will do that next. Before we cut 2.0 Closes https://github.com/Instagram/IGListKit/pull/198 Reviewed By: rnystrom Differential Revision: D4181253 Pulled By: jessesquires fbshipit-source-id: 133c4af392bb396ecc6eff0c895c55e6d18730b7
87 lines
2.2 KiB
Objective-C
87 lines
2.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 <Foundation/Foundation.h>
|
|
|
|
#import <IGListKit/IGListMoveIndexPath.h>
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
A result object returned when diffing with sections.
|
|
*/
|
|
@interface IGListIndexPathResult : NSObject
|
|
|
|
/**
|
|
The index paths inserted into the new collection.
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSArray<NSIndexPath *> *inserts;
|
|
|
|
/**
|
|
The index paths deleted from the old collection.
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSArray<NSIndexPath *> *deletes;
|
|
|
|
/**
|
|
The index paths in the new collection that need updated.
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSArray<NSIndexPath *> *updates;
|
|
|
|
/**
|
|
The moves from an index path in the old collection to an index path in the new collection.
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSArray<IGListMoveIndexPath *> *moves;
|
|
|
|
/**
|
|
Returns whether the result has any changes or not.
|
|
|
|
@return `YES` if the result has changes, `NO` otherwise.
|
|
*/
|
|
- (BOOL)hasChanges;
|
|
|
|
/**
|
|
Returns the index path of the object with the specified identifier *before* the diff.
|
|
|
|
@param identifier The diff identifier of the object.
|
|
|
|
@return The index path of the object before the diff, or `nil`.
|
|
|
|
@see `-[IGListDiffable diffIdentifier]`.
|
|
*/
|
|
- (nullable NSIndexPath *)oldIndexPathForIdentifier:(id<NSObject>)identifier;
|
|
|
|
/**
|
|
Returns the index path of the object with the specified identifier *after* the diff.
|
|
|
|
@param identifier The diff identifier of the object.
|
|
|
|
@return The index path of the object after the diff, or `nil`.
|
|
|
|
@see `-[IGListDiffable diffIdentifier]`.
|
|
*/
|
|
- (nullable NSIndexPath *)newIndexPathForIdentifier:(id<NSObject>)identifier;
|
|
|
|
/**
|
|
Creates a new result object with operations safe for use in `UITableView` and `UICollectionView` batch updates.
|
|
*/
|
|
- (IGListIndexPathResult *)resultForBatchUpdates;
|
|
|
|
/**
|
|
:nodoc:
|
|
*/
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
/**
|
|
:nodoc:
|
|
*/
|
|
+ (instancetype)new NS_UNAVAILABLE;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|