IGListKit/Source/IGListScrollDelegate.h
Ryan Nystrom f536e2136d Generate 3.2 docs
Summary:
Does this need to wait for #1086?
Closes https://github.com/Instagram/IGListKit/pull/1085

Differential Revision: D6917735

Pulled By: rnystrom

fbshipit-source-id: 08165c8d9f1215abac1d4bc7c65c1d23e31f758a
2018-02-06 15:47:20 -08:00

63 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 <UIKit/UIKit.h>
@class IGListAdapter;
@class IGListSectionController;
NS_ASSUME_NONNULL_BEGIN
/**
Implement this protocol to receive display events for a section controller when it is on screen.
*/
NS_SWIFT_NAME(ListScrollDelegate)
@protocol IGListScrollDelegate <NSObject>
/**
Tells the delegate that the section controller was scrolled on screen.
@param listAdapter The list adapter whose collection view was scrolled.
@param sectionController The visible section controller that was scrolled.
*/
- (void)listAdapter:(IGListAdapter *)listAdapter didScrollSectionController:(IGListSectionController *)sectionController;
/**
Tells the delegate that the section controller will be dragged on screen.
@param listAdapter The list adapter whose collection view will drag.
@param sectionController The visible section controller that will drag.
*/
- (void)listAdapter:(IGListAdapter *)listAdapter willBeginDraggingSectionController:(IGListSectionController *)sectionController;
/**
Tells the delegate that the section controller did end dragging on screen.
@param listAdapter The list adapter whose collection view ended dragging.
@param sectionController The visible section controller that ended dragging.
*/
- (void)listAdapter:(IGListAdapter *)listAdapter didEndDraggingSectionController:(IGListSectionController *)sectionController willDecelerate:(BOOL)decelerate;
@optional
/**
Tells the delegate that the section controller did end decelerating on screen.
@param listAdapter The list adapter whose collection view ended decelerating.
@param sectionController The visible section controller that ended decelerating.
@note This method is `@optional` until the next breaking-change release.
*/
- (void)listAdapter:(IGListAdapter *)listAdapter didEndDeceleratingSectionController:(IGListSectionController *)sectionController;
@end
NS_ASSUME_NONNULL_END