IGListKit/Source/IGListWorkingRangeDelegate.h
Jesse Squires 204f7d5390 Docs updates and refinements, #181
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
2016-11-15 11:44:10 -08:00

45 lines
1.5 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>
@class IGListAdapter;
@class IGListSectionController;
@protocol IGListSectionType;
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.
*/
@protocol IGListWorkingRangeDelegate <NSObject>
/**
Notifies the delegate that an section controller will enter the working range.
@param listAdapter The adapter controlling the list.
@param sectionController The section controller entering the range.
*/
- (void)listAdapter:(IGListAdapter *)listAdapter sectionControllerWillEnterWorkingRange:(IGListSectionController <IGListSectionType> *)sectionController;
/**
Notifies the delegate that an section controller exited the working range.
@param listAdapter The adapter controlling the list.
@param sectionController The section controller that exited the range.
*/
- (void)listAdapter:(IGListAdapter *)listAdapter sectionControllerDidExitWorkingRange:(IGListSectionController <IGListSectionType> *)sectionController;
@end
NS_ASSUME_NONNULL_END