IGListKit/Source/IGListBindingSectionControllerDataSource.h
Bas Broek edc38c77fe Remove @param alignment from header docs #trivial
Summary:
Issue fixed: #655

- [x] All tests pass. Demo project builds and runs.
- [ ] I added tests, an experiment, or detailed why my change isn't tested.
- [ ] 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've also addressed a few cases where there was no empty line between the `param`s and `return`.
Closes https://github.com/Instagram/IGListKit/pull/665

Differential Revision: D4906215

Pulled By: jessesquires

fbshipit-source-id: 5693c85eb548644b0b0e2571eea8ff4d9f706b12
2017-04-18 09:46:18 -07:00

66 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 <Foundation/Foundation.h>
@class IGListBindingSectionController;
@protocol IGListBindable;
@protocol IGListDiffable;
NS_ASSUME_NONNULL_BEGIN
/**
A protocol that returns data to power cells in an `IGListBindingSectionController`.
*/
@protocol IGListBindingSectionControllerDataSource <NSObject>
/**
Create an array of view models given a top-level object.
@param sectionController The section controller requesting view models.
@param object The top-level object that powers the section controller.
@return A new array of view models.
*/
- (NSArray<id<IGListDiffable>> *)sectionController:(IGListBindingSectionController *)sectionController
viewModelsForObject:(id)object;
/**
Return a dequeued cell for a given view model.
@param sectionController The section controller requesting a cell.
@param viewModel The view model for the cell.
@param index The index of the view model.
@return A dequeued cell.
@note The section controller will call `-bindViewModel:` with the provided view model after the cell is dequeued. You
should handle cell configuration using this method. However, you can do additional configuration at this stage as well.
*/
- (UICollectionViewCell<IGListBindable> *)sectionController:(IGListBindingSectionController *)sectionController
cellForViewModel:(id)viewModel
atIndex:(NSInteger)index;
/**
Return a cell size for a given view model.
@param sectionController The section controller requesting a size.
@param viewModel The view model for the cell.
@param index The index of the view model.
@return A size for the view model.
*/
- (CGSize)sectionController:(IGListBindingSectionController *)sectionController
sizeForViewModel:(id)viewModel
atIndex:(NSInteger)index;
@end
NS_ASSUME_NONNULL_END