Codebase Browser
chromium
Go to App

chromium/ios/chrome/browser/ui/tab_switcher/tab_grid/tab_grid_view_controller.h 

// Copyright 2018 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_UI_TAB_SWITCHER_TAB_GRID_TAB_GRID_VIEW_CONTROLLER_H_
#define IOS_CHROME_BROWSER_UI_TAB_SWITCHER_TAB_GRID_TAB_GRID_VIEW_CONTROLLER_H_

#import <UIKit/UIKit.h>

#import "ios/chrome/browser/keyboard/ui_bundled/key_command_actions.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_grid/grid/disabled_grid_view_controller.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_grid/grid/grid_consumer.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_grid/tab_grid_consumer.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_grid/tab_grid_idle_status_handler.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_grid/tab_grid_paging.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_grid/toolbars/tab_grid_toolbars_main_tab_grid_delegate.h"
#import "ios/chrome/browser/ui/tab_switcher/tab_grid/transitions/tab_grid_transition_layout_providing.h"

@protocol ApplicationCommands;
@class GridContainerViewController;
@protocol GridCommands;
class GURL;
@protocol InactiveTabsInfoConsumer;
@class IncognitoGridViewController;
@protocol IncognitoReauthCommands;
@protocol IncognitoReauthConsumer;
enum class IPHDismissalReasonType;
@class LayoutGuideCenter;
@class PinnedTabsViewController;
@protocol PriceCardDataSource;
@protocol RecentTabsConsumer;
@class RecentTabsTableViewController;
@class RegularGridViewController;
@class TabGridBottomToolbar;
@protocol TabCollectionConsumer;
@protocol TabCollectionDragDropHandler;
@protocol TabGridActivityObserver;
@protocol TabGridCommands;
@protocol TabGridConsumer;
@protocol TabContextMenuProvider;
@protocol TabGridMutator;
@protocol TabGridToolbarsCommandsWrangler;
@class TabGridTopToolbar;
@class TabGroupsPanelViewController;

// Configurations for tab grid pages.
enum class TabGridPageConfiguration {
  // All pages are enabled.
  kAllPagesEnabled = 0,
  // Only the incognito page is disabled.
  kIncognitoPageDisabled = 1,
  // Only incognito page is enabled.
  kIncognitoPageOnly = 2,
};

// Delegate protocol for an object that can handle presenting ("opening") tabs
// from the tab grid.
@protocol TabPresentationDelegate <NSObject>
// Show the active tab in `page`, presented on top of the tab grid.  The
// omnibox will be focused after the animation if `focusOmnibox` is YES.
- (void)showActiveTabInPage:(TabGridPage)page focusOmnibox:(BOOL)focusOmnibox;
@end

@protocol TabGridViewControllerDelegate <NSObject>

// Opens a link when the user clicks on the in-text link.
- (void)openLinkWithURL:(const GURL&)URL;

// Asks the delegate to show the inactive tabs.
- (void)showInactiveTabs;

// Asks the delegate whether the user is eligible for the swipe-to-incognito
// in-product help message. This depends on multiple factors, including but not
// limited to the current tab grid mode and the frequency that the IPH has
// previously shown.
- (BOOL)tabGridIsUserEligibleForSwipeToIncognitoIPH;

// Asks the delegate whether the tab grid should present the swipe-to-incognito
// in-product help message. Once this is invoked, `swipeToIncognitoIPH` must
// show, and `tabGridDidDismissSwipeToIncognitoIPH` must be invoked on
// dismissal.
- (BOOL)tabGridShouldPresentSwipeToIncognitoIPH;

// Notifies the delegate that the tab grid has dismissed the swipe-to-incognito
// in-product help message with `reason`.
- (void)tabGridDidDismissSwipeToIncognitoIPHWithReason:
    (IPHDismissalReasonType)reason;

@end

// View controller representing a tab switcher. The tab switcher has an
// incognito tab grid, regular tab grid, and a third panel (either Tab Groups or
// Recent Tabs).
@interface TabGridViewController
    : UIViewController <DisabledGridViewControllerDelegate,
                        GridConsumer,
                        KeyCommandActions,
                        TabGridConsumer,
                        TabGridIdleStatusHandler,
                        TabGridToolbarsMainTabGridDelegate,
                        TabGridTransitionLayoutProviding,
                        UISearchBarDelegate>

@property(nonatomic, weak) id<ApplicationCommands> handler;

// Handler for the TabGrid commands.
@property(nonatomic, weak) id<TabGridCommands> tabGridHandler;

// Delegate for this view controller to handle presenting tab UI.
@property(nonatomic, weak) id<TabPresentationDelegate> tabPresentationDelegate;

@property(nonatomic, weak) id<TabGridViewControllerDelegate> delegate;

// Delegate to notify when activity has to be updated.
@property(nonatomic, weak) id<TabGridActivityObserver> activityObserver;

// Mutator to apply all user change in the model.
@property(nonatomic, weak) id<TabGridMutator> mutator;

// Consumers send updates from the model layer to the UI layer.
@property(nonatomic, readonly) id<RecentTabsConsumer> remoteTabsConsumer;

// Delegates send updates from the UI layer to the model layer.
@property(nonatomic, weak) id<GridCommands> regularGridHandler;
@property(nonatomic, weak) id<GridCommands> incognitoGridHandler;

// Data source for acquiring data which power the PriceCardView
@property(nonatomic, weak) id<PriceCardDataSource> priceCardDataSource;

// Readwrite override of the UIViewController property. This object will ignore
// the value supplied by UIViewController.
@property(nonatomic, weak, readwrite)
    UIViewController* childViewControllerForStatusBarStyle;

// Child view controllers.
@property(nonatomic, strong)
    RegularGridViewController* regularTabsViewController;
@property(nonatomic, strong) PinnedTabsViewController* pinnedTabsViewController;
@property(nonatomic, strong)
    IncognitoGridViewController* incognitoTabsViewController;
@property(nonatomic, strong)
    TabGroupsPanelViewController* tabGroupsPanelViewController;
// The view controller for Recent Tabs.
// TODO(crbug.com/41390276) : This was only exposed in the public interface so
// that TabGridViewController does not need to know about model objects. The
// model objects used in this view controller should be factored out.
@property(nonatomic, readonly)
    RecentTabsTableViewController* remoteTabsViewController;

// The layout guide center to use to refer to the bottom toolbar.
@property(nonatomic, strong) LayoutGuideCenter* layoutGuideCenter;

// Top and bottom toolbars. Those must be set before -viewDidLoad is called.
@property(nonatomic, strong) TabGridTopToolbar* topToolbar;
@property(nonatomic, strong) TabGridBottomToolbar* bottomToolbar;

// Whether the primary signed-in account is subject to parental controls.
@property(nonatomic, assign) BOOL isSubjectToParentalControls;

// Disabled tab view controllers only available when a certain browser mode is
// disabled.
@property(nonatomic, weak) UIViewController* regularDisabledGridViewController;
@property(nonatomic, weak)
    UIViewController* incognitoDisabledGridViewController;
@property(nonatomic, weak)
    UIViewController* tabGroupsDisabledGridViewController;

// Contains grids (available or disabled one).
@property(nonatomic, weak) UIViewController* regularGridContainerViewController;
@property(nonatomic, weak)
    UIViewController* incognitoGridContainerViewController;
@property(nonatomic, weak)
    UIViewController* tabGroupsGridContainerViewController;
@property(nonatomic, weak)
    GridContainerViewController* remoteGridContainerViewController;

// Active page of the tab grid. The active page is the page that
// contains the most recent active tab.
@property(nonatomic, assign, readonly) TabGridPage activePage;
// The currently visible page.
@property(nonatomic, assign, readonly) TabGridPage currentPage;

// Init with tab grid view configuration, which decides which sub view
// controller should be added.
- (instancetype)initWithPageConfiguration:
    (TabGridPageConfiguration)tabGridPageConfiguration
    NS_DESIGNATED_INITIALIZER;

- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithCoder:(NSCoder*)coder NS_UNAVAILABLE;
- (instancetype)initWithNibName:(NSString*)nibNameOrNil
                         bundle:(NSBundle*)nibBundleOrNil NS_UNAVAILABLE;

// Notifies the ViewController that its content is being displayed or hidden.
- (void)contentWillAppearAnimated:(BOOL)animated;
- (void)contentDidAppear;
- (void)contentWillDisappearAnimated:(BOOL)animated;

// Dismisses any modal UI which may be presented.
- (void)dismissModals;

// Sets both the current page and page control's selected page to `page`.
// Animation is used if `animated` is YES.
- (void)setCurrentPageAndPageControl:(TabGridPage)page animated:(BOOL)animated;

// Updates the active page to be the current page.
- (void)updateActivePageToCurrent;

@end

#endif  // IOS_CHROME_BROWSER_UI_TAB_SWITCHER_TAB_GRID_TAB_GRID_VIEW_CONTROLLER_H_