2016-09-07 22:37:59 +00:00
|
|
|
/**
|
2018-11-01 17:56:41 +00:00
|
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
2016-09-07 22:37:59 +00:00
|
|
|
*
|
2018-05-01 21:33:50 +00:00
|
|
|
* This source code is licensed under the MIT license found in the
|
|
|
|
|
* LICENSE file in the root directory of this source tree.
|
2016-09-07 22:37:59 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#import <UIKit/UIKit.h>
|
|
|
|
|
|
|
|
|
|
@class IGListAdapter;
|
|
|
|
|
@class IGListSectionController;
|
|
|
|
|
|
2017-04-19 15:17:56 +00:00
|
|
|
|
2016-09-07 22:37:59 +00:00
|
|
|
|
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Implement this protocol to receive working range events for a list.
|
|
|
|
|
|
|
|
|
|
The working range is a range *near* the viewport in which you can begin preparing content for display. For example,
|
|
|
|
|
you could begin decoding images, or warming text caches.
|
|
|
|
|
*/
|
Swift name annotations
Summary:
This adds `NS_SWIFT_NAME` annotations to all public API's to provide cleaner integration into Swift:
- Removes the need to prefix classes in Swift code, instead rely on Swift module name spacing
- Adds more argument labels to C function API's like `IGListDiff([], [], .equality)` => `ListDiff(oldArray: [], newArray: [], option: .equality)`
While this is a large API change it should be as easy as:
- Find and replace `(IGList)([^K])` to `List$2` in Xcode with a scope set to Swift
- Build and follow compiler's auto fix corrections for C API's or any missed renames
I have not updated the documentation to reflect this yet, I am totally willing to do so but before I sink that amount of time into it I wanted to see if the Instagram team is even open to this change!
- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] 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 have updated the documentation
Closes https://github.com/Instagram/IGListKit/pull/593
Reviewed By: jessesquires
Differential Revision: D5028039
Pulled By: rnystrom
fbshipit-source-id: b473d874a1f9574e56b2ebaabd5b73d1b57d4bab
2017-05-09 21:29:52 +00:00
|
|
|
NS_SWIFT_NAME(ListWorkingRangeDelegate)
|
2016-09-07 22:37:59 +00:00
|
|
|
@protocol IGListWorkingRangeDelegate <NSObject>
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Notifies the delegate that an section controller will enter the working range.
|
|
|
|
|
|
2017-04-18 16:30:53 +00:00
|
|
|
@param listAdapter The adapter controlling the list.
|
2016-09-07 22:37:59 +00:00
|
|
|
@param sectionController The section controller entering the range.
|
|
|
|
|
*/
|
2017-04-19 15:17:56 +00:00
|
|
|
- (void)listAdapter:(IGListAdapter *)listAdapter sectionControllerWillEnterWorkingRange:(IGListSectionController *)sectionController;
|
2016-09-07 22:37:59 +00:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Notifies the delegate that an section controller exited the working range.
|
|
|
|
|
|
2017-04-18 16:30:53 +00:00
|
|
|
@param listAdapter The adapter controlling the list.
|
2016-09-07 22:37:59 +00:00
|
|
|
@param sectionController The section controller that exited the range.
|
|
|
|
|
*/
|
2017-04-19 15:17:56 +00:00
|
|
|
- (void)listAdapter:(IGListAdapter *)listAdapter sectionControllerDidExitWorkingRange:(IGListSectionController *)sectionController;
|
2016-09-07 22:37:59 +00:00
|
|
|
|
|
|
|
|
@end
|
|
|
|
|
|
|
|
|
|
NS_ASSUME_NONNULL_END
|