IGListKit/Source/IGListScrollDelegate.h
Ryan Nystrom 8d8a632b67 Update MIT license language (#1272)
Summary:
Updating license language to meet FB open source standards.
Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1272

Differential Revision: D12844366

Pulled By: rnystrom

fbshipit-source-id: 27ae49ae00d963c5c012c79c5738365c232a5773
2018-11-01 10:58:46 -07:00

63 lines
2.2 KiB
Objective-C

/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
#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.
@param decelerate 'Yes' if the scrolling movement will continue, but decelerate, after a touch-up gesture during a
dragging operation. If the value is 'No', scrolling stops immediately upon touch-up.
*/
- (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