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

#ifndef IOS_CHROME_BROWSER_NTP_UI_BUNDLED_NEW_TAB_PAGE_CONSUMER_H_
#define IOS_CHROME_BROWSER_NTP_UI_BUNDLED_NEW_TAB_PAGE_CONSUMER_H_

#import <Foundation/Foundation.h>
#import <UIKit/UITraitCollection.h>

@class HomeCustomizationFramingCoordinates;
@class NewTabPageColorPalette;

// Handles updates to the NTP ViewController.
@protocol NewTabPageConsumer <NSObject>

// When the omnibox is focused, this value represents the scroll distance needed
// to pin the omnibox to the top. It is 0 if no scrolling was done in order pin
// the omnibox to the top (i.e. the NTP ScrollView was already scrolled far
// enough down that the omnibo was already pinned to the top).
@property(nonatomic, assign, readonly) CGFloat collectionShiftingOffset;

// Whether the Most Visited module is visible on the NTP.
@property(nonatomic, assign) BOOL mostVisitedVisible;

// Whether the Magic Stack module is visible on the NTP.
@property(nonatomic, assign) BOOL magicStackVisible;

// Collection of trait-specific override values for customizing NTP appearance
@property(nonatomic, readonly) id<UITraitOverrides> traitOverrides;

// Indicates that the omnibox has become the first responder to the keyboard.
- (void)omniboxDidBecomeFirstResponder;

// Indicates that the omnibox will stop being the first responder to the
// keyboard.
- (void)omniboxWillResignFirstResponder;

// Indicates that the omnibox stopped being the first responder to the keyboard.
- (void)omniboxDidEndEditing;

// Restores a given scroll position if applicable.
- (void)restoreScrollPosition:(CGFloat)scrollPosition;

// Restores the scroll position to the top of the feed.
- (void)restoreScrollPositionToTopOfFeed;

// Returns the height of the content above the feed. The views above the feed
// (like the content suggestions) are added through a content inset in the feed
// collection view, so this property is used to track the total height of those
// additional views.
- (CGFloat)heightAboveFeed;

// Returns the y content offset of the NTP collection view.
- (CGFloat)scrollPosition;

// Returns the Y value to use for the scroll view's contentOffset when scrolling
// the omnibox to the top of the screen.
- (CGFloat)pinnedOffsetY;

// Sets the background image of the NTP. Removes the current background image
// if nil is passed. If framing coordinates are non-nil, they will be used to
// position the image.
- (void)setBackgroundImage:(UIImage*)backgroundImage
        framingCoordinates:
            (HomeCustomizationFramingCoordinates*)framingCoordinates;

// Whether AIM is allowed.
- (void)setAIMAllowed:(BOOL)allowed;

// Sets whether the omnibox is in the bottom position.
- (void)setOmniboxInBottomPosition:(BOOL)isBottomOmnibox;

// Sets the bottom inset for the feed to avoid overlap with bottom toolbars.
- (void)setFeedBottomInset:(CGFloat)bottomInset;

@end

#endif  // IOS_CHROME_BROWSER_NTP_UI_BUNDLED_NEW_TAB_PAGE_CONSUMER_H_