ios/chrome/browser/ui/tab_grid/grid_consumer.h

// Copyright 2018 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef IOS_CHROME_BROWSER_UI_TAB_GRID_GRID_CONSUMER_H_
#define IOS_CHROME_BROWSER_UI_TAB_GRID_GRID_CONSUMER_H_

@class GridItem;

// Supports insert/delete/updates to a grid.
@protocol GridConsumer

// Tells the consumer to replace its current set of items with |items| and
// update the selected index to be |selectedIndex|. |selectedIndex| is
// disregarded if |items| is empty. It's an error to call this method with a
// |selectedIndex| value higher than the maximum index of |items|.
- (void)populateItems:(NSArray<GridItem*>*)items
        selectedIndex:(NSUInteger)selectedIndex;

// Tells the consumer to insert |item| at |index| and update the selected index
// to be |selectedIndex|. It's an error to call this method with a
// |selectedIndex| value higher than the maximum index of |items|.
- (void)insertItem:(GridItem*)item
           atIndex:(NSUInteger)index
     selectedIndex:(NSUInteger)selectedIndex;

// Tells the consumer to remove |item| at |index| and update the selected index
// to be |selectedIndex|. |selectedIndex| is disregarded if the last item is
// removed. It's an error to call this method with a |selectedIndex| value
// higher than the maximum index of |items|.
- (void)removeItemAtIndex:(NSUInteger)index
            selectedIndex:(NSUInteger)selectedIndex;

// Tells the consumer to update the selected index to be |selectedIndex|. It's
// an error to call this method with a |selectedIndex| value higher than the
// maximum index of |items|.
- (void)selectItemAtIndex:(NSUInteger)selectedIndex;

// Tells the consumer to update the item at |index| with |item|.
- (void)replaceItemAtIndex:(NSUInteger)index withItem:(GridItem*)item;

// Tells the consumer to move the item at |fromIndex| to |toIndex| and update
// the selected index to be |selectedIndex|. It's an error to call this method
// with a |selectedIndex| value higher than the maximum index of |items|.
- (void)moveItemFromIndex:(NSUInteger)fromIndex
                  toIndex:(NSUInteger)toIndex
            selectedIndex:(NSUInteger)selectedIndex;

@end

#endif  // IOS_CHROME_BROWSER_UI_TAB_GRID_GRID_CONSUMER_H_