IGListKit/Source/IGListDisplayDelegate.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

66 lines
2.6 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 display events for an section controller when it is on screen.
*/
@protocol IGListDisplayDelegate <NSObject>
/**
Tells the delegate that the specified section controller is about to be displayed.
@param listAdapter The list adapter for the section controller.
@param sectionController The section controller about to be displayed.
*/
- (void)listAdapter:(IGListAdapter *)listAdapter willDisplaySectionController:(IGListSectionController <IGListSectionType> *)sectionController;
/**
Tells the delegate that the specified section controller is no longer being displayed.
@param listAdapter The list adapter for the section controller.
@param sectionController The section controller that is no longer displayed.
*/
- (void)listAdapter:(IGListAdapter *)listAdapter didEndDisplayingSectionController:(IGListSectionController <IGListSectionType> *)sectionController;
/**
Tells the delegate that a cell in the specified list is about to be displayed.
@param listAdapter The list adapter in which the cell will display.
@param sectionController The section controller that is displaying the cell.
@param cell The cell about to be displayed.
@param index The index of the cell in the section.
*/
- (void)listAdapter:(IGListAdapter *)listAdapter willDisplaySectionController:(IGListSectionController <IGListSectionType> *)sectionController
cell:(UICollectionViewCell *)cell
atIndex:(NSInteger)index;
/**
Tells the delegate that a cell in the specified list is no longer being displayed.
@param listAdapter The list adapter in which the cell was displayed.
@param sectionController The section controller that is no longer displaying the cell.
@param cell The cell that is no longer displayed.
@param index The index of the cell in the section.
*/
- (void)listAdapter:(IGListAdapter *)listAdapter didEndDisplayingSectionController:(IGListSectionController <IGListSectionType> *)sectionController
cell:(UICollectionViewCell *)cell
atIndex:(NSInteger)index;
@end
NS_ASSUME_NONNULL_END