/* Copyright (c) 2014-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.
 */

#ifndef ASCollectionViewLayoutFacilitatorProtocol_h
#define ASCollectionViewLayoutFacilitatorProtocol_h

/**
 * This facilitator protocol is intended to help Layout to better
 * gel with the CollectionView
 */
@protocol ASCollectionViewLayoutFacilitatorProtocol <NSObject>

/**
 * Inform that the collectionView is editing the cells at a list of indexPaths
 */
- (void)collectionViewEditingCellsAtIndexPaths:(NSArray *)indexPaths;

/**
 * Inform that the collectionView is editing the sections at a set of indexes
 */
- (void)collectionViewEditingSectionsAtIndexSet:(NSIndexSet *)indexes;

/**
 * Inform that the collectionView is adding some cell updates into a batch,
 * and will perform these batch updates at a later point
 *
 * NOTE: used in combination with -collectionViewWillPerformBatchUpdates
 */
- (void)collectionViewBatchingCellEditsAtIndexPaths:(NSArray *)indexPaths;

/**
 * Inform that the collectionView is adding some section updates into a batch, 
 * and will perform these batch updates at a later point
 *
 * NOTE: used in combination with -collectionViewWillPerformBatchUpdates
 */
- (void)collectionViewBatchingSectionEditsAtIndexes:(NSIndexSet *)indexes;

/**
 * Informs the delegate that the collectionView is about to call performBatchUpdates
 */
- (void)collectionViewWillPerformBatchUpdates;

@end

#endif /* ASCollectionViewLayoutFacilitatorProtocol_h */