mirror of
https://github.com/Swiftgram/Telegram-iOS.git
synced 2025-06-16 05:55:20 +00:00
299 lines
13 KiB
Objective-C
299 lines
13 KiB
Objective-C
//
|
||
// ASTableView+Undeprecated.h
|
||
// Texture
|
||
//
|
||
// Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.
|
||
// Changes after 4/13/2017 are: Copyright (c) Pinterest, Inc. All rights reserved.
|
||
// Licensed under Apache 2.0: http://www.apache.org/licenses/LICENSE-2.0
|
||
//
|
||
|
||
#import <Foundation/Foundation.h>
|
||
#import <UIKit/UIKit.h>
|
||
#import <AsyncDisplayKit/ASTableNode.h>
|
||
#import <AsyncDisplayKit/ASLayoutRangeType.h>
|
||
|
||
NS_ASSUME_NONNULL_BEGIN
|
||
|
||
/**
|
||
* Currently our public table API is on @c ASTableNode and the @c ASTableView
|
||
* API is deprecated, but the implementations still live in the view.
|
||
*
|
||
* This category lets us avoid deprecation warnings everywhere internally.
|
||
* In the future, the ASTableView public API will be eliminated and so will this file.
|
||
*/
|
||
@interface ASTableView (Undeprecated)
|
||
|
||
@property (nullable, nonatomic, weak) id<ASTableDelegate> asyncDelegate;
|
||
@property (nullable, nonatomic, weak) id<ASTableDataSource> asyncDataSource;
|
||
@property (nonatomic) UIEdgeInsets contentInset;
|
||
@property (nonatomic) CGPoint contentOffset;
|
||
@property (nonatomic) BOOL automaticallyAdjustsContentOffset;
|
||
@property (nonatomic) BOOL inverted;
|
||
@property (nullable, nonatomic, readonly) NSArray<NSIndexPath *> *indexPathsForVisibleRows;
|
||
@property (nullable, nonatomic, readonly) NSArray<NSIndexPath *> *indexPathsForSelectedRows;
|
||
@property (nullable, nonatomic, readonly) NSIndexPath *indexPathForSelectedRow;
|
||
|
||
/**
|
||
* The number of screens left to scroll before the delegate -tableView:beginBatchFetchingWithContext: is called.
|
||
*
|
||
* Defaults to two screenfuls.
|
||
*/
|
||
@property (nonatomic) CGFloat leadingScreensForBatching;
|
||
|
||
/**
|
||
* Initializer.
|
||
*
|
||
* @param frame A rectangle specifying the initial location and size of the table view in its superview’s coordinates.
|
||
* The frame of the table view changes as table cells are added and deleted.
|
||
*
|
||
* @param style A constant that specifies the style of the table view. See UITableViewStyle for descriptions of valid constants.
|
||
*/
|
||
- (instancetype)initWithFrame:(CGRect)frame style:(UITableViewStyle)style;
|
||
|
||
/**
|
||
* Tuning parameters for a range type in full mode.
|
||
*
|
||
* @param rangeType The range type to get the tuning parameters for.
|
||
*
|
||
* @return A tuning parameter value for the given range type in full mode.
|
||
*
|
||
* @see ASLayoutRangeMode
|
||
* @see ASLayoutRangeType
|
||
*/
|
||
- (ASRangeTuningParameters)tuningParametersForRangeType:(ASLayoutRangeType)rangeType AS_WARN_UNUSED_RESULT;
|
||
|
||
/**
|
||
* Set the tuning parameters for a range type in full mode.
|
||
*
|
||
* @param tuningParameters The tuning parameters to store for a range type.
|
||
* @param rangeType The range type to set the tuning parameters for.
|
||
*
|
||
* @see ASLayoutRangeMode
|
||
* @see ASLayoutRangeType
|
||
*/
|
||
- (void)setTuningParameters:(ASRangeTuningParameters)tuningParameters forRangeType:(ASLayoutRangeType)rangeType;
|
||
|
||
/**
|
||
* Tuning parameters for a range type in the specified mode.
|
||
*
|
||
* @param rangeMode The range mode to get the running parameters for.
|
||
* @param rangeType The range type to get the tuning parameters for.
|
||
*
|
||
* @return A tuning parameter value for the given range type in the given mode.
|
||
*
|
||
* @see ASLayoutRangeMode
|
||
* @see ASLayoutRangeType
|
||
*/
|
||
- (ASRangeTuningParameters)tuningParametersForRangeMode:(ASLayoutRangeMode)rangeMode rangeType:(ASLayoutRangeType)rangeType AS_WARN_UNUSED_RESULT;
|
||
|
||
/**
|
||
* Set the tuning parameters for a range type in the specified mode.
|
||
*
|
||
* @param tuningParameters The tuning parameters to store for a range type.
|
||
* @param rangeMode The range mode to set the running parameters for.
|
||
* @param rangeType The range type to set the tuning parameters for.
|
||
*
|
||
* @see ASLayoutRangeMode
|
||
* @see ASLayoutRangeType
|
||
*/
|
||
- (void)setTuningParameters:(ASRangeTuningParameters)tuningParameters forRangeMode:(ASLayoutRangeMode)rangeMode rangeType:(ASLayoutRangeType)rangeType;
|
||
|
||
- (nullable __kindof UITableViewCell *)cellForRowAtIndexPath:(NSIndexPath *)indexPath;
|
||
|
||
/**
|
||
* Scrolls the table to the given row.
|
||
*
|
||
* @param indexPath The index path of the row.
|
||
* @param scrollPosition Where the row should end up after the scroll.
|
||
* @param animated Whether the scroll should be animated or not.
|
||
*/
|
||
- (void)scrollToRowAtIndexPath:(NSIndexPath *)indexPath atScrollPosition:(UITableViewScrollPosition)scrollPosition animated:(BOOL)animated;
|
||
|
||
- (void)selectRowAtIndexPath:(NSIndexPath *)indexPath animated:(BOOL)animated scrollPosition:(UITableViewScrollPosition)scrollPosition;
|
||
|
||
- (nullable NSIndexPath *)indexPathForRowAtPoint:(CGPoint)point;
|
||
|
||
- (nullable NSArray<NSIndexPath *> *)indexPathsForRowsInRect:(CGRect)rect;
|
||
|
||
/**
|
||
* Similar to -visibleCells.
|
||
*
|
||
* @return an array containing the cell nodes being displayed on screen.
|
||
*/
|
||
- (NSArray<ASCellNode *> *)visibleNodes AS_WARN_UNUSED_RESULT;
|
||
|
||
/**
|
||
* Similar to -indexPathForCell:.
|
||
*
|
||
* @param cellNode a cellNode part of the table view
|
||
*
|
||
* @return an indexPath for this cellNode
|
||
*/
|
||
- (nullable NSIndexPath *)indexPathForNode:(ASCellNode *)cellNode AS_WARN_UNUSED_RESULT;
|
||
|
||
/**
|
||
* Reload everything from scratch, destroying the working range and all cached nodes.
|
||
*
|
||
* @param completion block to run on completion of asynchronous loading or nil. If supplied, the block is run on
|
||
* the main thread.
|
||
* @warning This method is substantially more expensive than UITableView's version.
|
||
*/
|
||
-(void)reloadDataWithCompletion:(void (^ _Nullable)(void))completion;
|
||
|
||
/**
|
||
* Reload everything from scratch, destroying the working range and all cached nodes.
|
||
*
|
||
* @warning This method is substantially more expensive than UITableView's version.
|
||
*/
|
||
- (void)reloadData;
|
||
|
||
/**
|
||
* Triggers a relayout of all nodes.
|
||
*
|
||
* @discussion This method invalidates and lays out every cell node in the table view.
|
||
*/
|
||
- (void)relayoutItems;
|
||
|
||
/**
|
||
* Begins a series of method calls that insert, delete, select, or reload rows and sections of the table view, with animation enabled and no completion block.
|
||
*
|
||
* @discussion You call this method to bracket a series of method calls that ends with endUpdates and that consists of operations
|
||
* to insert, delete, select, and reload rows and sections of the table view. When you call endUpdates, ASTableView begins animating
|
||
* the operations simultaneously. It's important to remember that the ASTableView will be processing the updates asynchronously after this call is completed.
|
||
*
|
||
* @warning This method must be called from the main thread.
|
||
*/
|
||
- (void)beginUpdates;
|
||
|
||
/**
|
||
* Concludes a series of method calls that insert, delete, select, or reload rows and sections of the table view, with animation enabled and no completion block.
|
||
*
|
||
* @discussion You call this method to bracket a series of method calls that begins with beginUpdates and that consists of operations
|
||
* to insert, delete, select, and reload rows and sections of the table view. When you call endUpdates, ASTableView begins animating
|
||
* the operations simultaneously. It's important to remember that the ASTableView will be processing the updates asynchronously after this call is completed.
|
||
*
|
||
* @warning This method is must be called from the main thread.
|
||
*/
|
||
- (void)endUpdates;
|
||
|
||
/**
|
||
* Concludes a series of method calls that insert, delete, select, or reload rows and sections of the table view.
|
||
* You call this method to bracket a series of method calls that begins with beginUpdates and that consists of operations
|
||
* to insert, delete, select, and reload rows and sections of the table view. When you call endUpdates, ASTableView begins animating
|
||
* the operations simultaneously. This method is must be called from the main thread. It's important to remember that the ASTableView will
|
||
* be processing the updates asynchronously after this call and are not guaranteed to be reflected in the ASTableView until
|
||
* the completion block is executed.
|
||
*
|
||
* @param animated NO to disable all animations.
|
||
* @param completion A completion handler block to execute when all of the operations are finished. This block takes a single
|
||
* Boolean parameter that contains the value YES if all of the related animations completed successfully or
|
||
* NO if they were interrupted. This parameter may be nil. If supplied, the block is run on the main thread.
|
||
*/
|
||
- (void)endUpdatesAnimated:(BOOL)animated completion:(void (^ _Nullable)(BOOL completed))completion;
|
||
|
||
/**
|
||
* Blocks execution of the main thread until all section and row updates are committed. This method must be called from the main thread.
|
||
*/
|
||
- (void)waitUntilAllUpdatesAreCommitted;
|
||
|
||
/**
|
||
* Inserts one or more sections, with an option to animate the insertion.
|
||
*
|
||
* @param sections An index set that specifies the sections to insert.
|
||
*
|
||
* @param animation A constant that indicates how the insertion is to be animated. See UITableViewRowAnimation.
|
||
*
|
||
* @discussion This method must be called from the main thread. The asyncDataSource must be updated to reflect the changes
|
||
* before this method is called.
|
||
*/
|
||
- (void)insertSections:(NSIndexSet *)sections withRowAnimation:(UITableViewRowAnimation)animation;
|
||
|
||
/**
|
||
* Deletes one or more sections, with an option to animate the deletion.
|
||
*
|
||
* @param sections An index set that specifies the sections to delete.
|
||
*
|
||
* @param animation A constant that indicates how the deletion is to be animated. See UITableViewRowAnimation.
|
||
*
|
||
* @discussion This method must be called from the main thread. The asyncDataSource must be updated to reflect the changes
|
||
* before this method is called.
|
||
*/
|
||
- (void)deleteSections:(NSIndexSet *)sections withRowAnimation:(UITableViewRowAnimation)animation;
|
||
|
||
/**
|
||
* Reloads the specified sections using a given animation effect.
|
||
*
|
||
* @param sections An index set that specifies the sections to reload.
|
||
*
|
||
* @param animation A constant that indicates how the reloading is to be animated. See UITableViewRowAnimation.
|
||
*
|
||
* @discussion This method must be called from the main thread. The asyncDataSource must be updated to reflect the changes
|
||
* before this method is called.
|
||
*/
|
||
- (void)reloadSections:(NSIndexSet *)sections withRowAnimation:(UITableViewRowAnimation)animation;
|
||
|
||
/**
|
||
* Moves a section to a new location.
|
||
*
|
||
* @param section The index of the section to move.
|
||
*
|
||
* @param newSection The index that is the destination of the move for the section.
|
||
*
|
||
* @discussion This method must be called from the main thread. The asyncDataSource must be updated to reflect the changes
|
||
* before this method is called.
|
||
*/
|
||
- (void)moveSection:(NSInteger)section toSection:(NSInteger)newSection;
|
||
|
||
/**
|
||
* Inserts rows at the locations identified by an array of index paths, with an option to animate the insertion.
|
||
*
|
||
* @param indexPaths An array of NSIndexPath objects, each representing a row index and section index that together identify a row.
|
||
*
|
||
* @param animation A constant that indicates how the insertion is to be animated. See UITableViewRowAnimation.
|
||
*
|
||
* @discussion This method must be called from the main thread. The asyncDataSource must be updated to reflect the changes
|
||
* before this method is called.
|
||
*/
|
||
- (void)insertRowsAtIndexPaths:(NSArray<NSIndexPath *> *)indexPaths withRowAnimation:(UITableViewRowAnimation)animation;
|
||
|
||
/**
|
||
* Deletes the rows specified by an array of index paths, with an option to animate the deletion.
|
||
*
|
||
* @param indexPaths An array of NSIndexPath objects identifying the rows to delete.
|
||
*
|
||
* @param animation A constant that indicates how the deletion is to be animated. See UITableViewRowAnimation.
|
||
*
|
||
* @discussion This method must be called from the main thread. The asyncDataSource must be updated to reflect the changes
|
||
* before this method is called.
|
||
*/
|
||
- (void)deleteRowsAtIndexPaths:(NSArray<NSIndexPath *> *)indexPaths withRowAnimation:(UITableViewRowAnimation)animation;
|
||
|
||
/**
|
||
* Reloads the specified rows using a given animation effect.
|
||
*
|
||
* @param indexPaths An array of NSIndexPath objects identifying the rows to reload.
|
||
*
|
||
* @param animation A constant that indicates how the reloading is to be animated. See UITableViewRowAnimation.
|
||
*
|
||
* @discussion This method must be called from the main thread. The asyncDataSource must be updated to reflect the changes
|
||
* before this method is called.
|
||
*/
|
||
- (void)reloadRowsAtIndexPaths:(NSArray<NSIndexPath *> *)indexPaths withRowAnimation:(UITableViewRowAnimation)animation;
|
||
|
||
/**
|
||
* Moves the row at a specified location to a destination location.
|
||
*
|
||
* @param indexPath The index path identifying the row to move.
|
||
*
|
||
* @param newIndexPath The index path that is the destination of the move for the row.
|
||
*
|
||
* @discussion This method must be called from the main thread. The asyncDataSource must be updated to reflect the changes
|
||
* before this method is called.
|
||
*/
|
||
- (void)moveRowAtIndexPath:(NSIndexPath *)indexPath toIndexPath:(NSIndexPath *)newIndexPath;
|
||
|
||
- (void)setContentOffset:(CGPoint)contentOffset animated:(BOOL)animated;
|
||
|
||
@end
|
||
NS_ASSUME_NONNULL_END
|