Upstream Chrome on iOS source code [8/11].

ios/chrome/browser/ui/settings/settings_navigation_controller.h

+// Copyright 2013 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_SETTINGS_SETTINGS_NAVIGATION_CONTROLLER_H_
+#define IOS_CHROME_BROWSER_UI_SETTINGS_SETTINGS_NAVIGATION_CONTROLLER_H_
+
+#import <UIKit/UIKit.h>
+
+@class OpenUrlCommand;
+@protocol ImportDataControllerDelegate;
+@protocol UserFeedbackDataSource;
+
+namespace ios {
+class ChromeBrowserState;
+}  // namespace ios
+
+@protocol SettingsControllerProtocol<NSObject>
+
+@optional
+
+// Notifies the controller that the settings screen is being dismissed.
+- (void)settingsWillBeDismissed;
+
+@end
+
+@protocol SettingsNavigationControllerDelegate<NSObject>
+
+// Handles a close settings and open URL command.
+- (void)closeSettingsAndOpenUrl:(OpenUrlCommand*)command;
+
+// Informs the delegate that the settings navigation controller should be
+// closed and a new incognito window should be opened.
+- (void)closeSettingsAndOpenNewIncognitoTab;
+
+// Informs the delegate that the settings navigation controller should be
+// closed.
+- (void)closeSettings;
+
+@end
+
+// Controller to modify user settings.
+@interface SettingsNavigationController : UINavigationController
+
+// Whether sync changes should be committed when the settings are being
+// dismissed. Defaults to YES.
+@property(nonatomic, assign) BOOL shouldCommitSyncChangesOnDismissal;
+
+// Creates a new SettingsCollectionViewController and the chrome around it.
+// |browserState| is used to personalize some settings aspects and should not be
+// nil. |delegate| may be nil.
+// clang-format off
++ (SettingsNavigationController*)newSettingsMainControllerWithMainBrowserState:
+        (ios::ChromeBrowserState*)browserState
+                                                           currentBrowserState:
+        (ios::ChromeBrowserState*)currentBrowserState
+                                                                      delegate:
+        (id<SettingsNavigationControllerDelegate>)delegate;
+// clang-format on
+
+// Creates a new AccountsCollectionViewController and the chrome around it.
+// |browserState| is used to personalize some settings aspects and should not be
+// nil. |delegate| may be nil.
++ (SettingsNavigationController*)
+newAccountsController:(ios::ChromeBrowserState*)browserState
+             delegate:(id<SettingsNavigationControllerDelegate>)delegate;
+
+// Creates a new SignInSettingsCollectionViewController and the chrome around
+// it. |browserState| is used to personalize some settings aspects and should
+// not be nil. |delegate| may be nil.
++ (SettingsNavigationController*)
+     newSyncController:(ios::ChromeBrowserState*)browserState
+allowSwitchSyncAccount:(BOOL)allowSwitchSyncAccount
+              delegate:(id<SettingsNavigationControllerDelegate>)delegate;
+
+// Creates a new SyncEncryptionPassphraseCollectionViewController and the chrome
+// around it. |browserState| is used to personalize some settings aspects and
+// should not be nil. |delegate| may be nil.
++ (SettingsNavigationController*)
+newSyncEncryptionPassphraseController:(ios::ChromeBrowserState*)browserState
+                             delegate:(id<SettingsNavigationControllerDelegate>)
+                                          delegate;
+
+// Creates a new NativeAppsCollectionViewController and the chrome around it.
+// |browserState| is used to personalize some settings aspects and should not be
+// nil. |delegate| may be nil.
++ (SettingsNavigationController*)
+newNativeAppsController:(ios::ChromeBrowserState*)browserState
+               delegate:(id<SettingsNavigationControllerDelegate>)delegate;
+
+// Creates a new ClearBrowsingDataCollectionViewController and the chrome around
+// it.
+// |browserState| is used to personalize some settings aspects and should not be
+// nil. |delegate| may be nil.
++ (SettingsNavigationController*)
+newClearBrowsingDataController:(ios::ChromeBrowserState*)browserState
+                      delegate:
+                          (id<SettingsNavigationControllerDelegate>)delegate;
+
++ (SettingsNavigationController*)
+newContextualSearchController:(ios::ChromeBrowserState*)browserState
+                     delegate:
+                         (id<SettingsNavigationControllerDelegate>)delegate;
+
+// Creates a new SavePasswordsCollectionViewController and the chrome around it.
+// |browserState| is used to personalize some settings aspects and should not be
+// nil. |delegate| may be nil.
++ (SettingsNavigationController*)
+newSavePasswordsController:(ios::ChromeBrowserState*)browserState
+                  delegate:(id<SettingsNavigationControllerDelegate>)delegate;
+
+// Creates and displays a new UserFeedbackViewController. |browserState| is used
+// to personalize some settings aspects and should not be nil. |dataSource| is
+// used to populate the UserFeedbackViewController. |delegate| may be nil.
++ (SettingsNavigationController*)
+newUserFeedbackController:(ios::ChromeBrowserState*)browserState
+                 delegate:(id<SettingsNavigationControllerDelegate>)delegate
+       feedbackDataSource:(id<UserFeedbackDataSource>)dataSource;
+
+// Creates and displays a new ImportDataCollectionViewController. |browserState|
+// should not be nil.
++ (SettingsNavigationController*)
+newImportDataController:(ios::ChromeBrowserState*)browserState
+               delegate:(id<SettingsNavigationControllerDelegate>)delegate
+     importDataDelegate:(id<ImportDataControllerDelegate>)importDataDelegate
+              fromEmail:(NSString*)fromEmail
+                toEmail:(NSString*)toEmail
+             isSignedIn:(BOOL)isSignedIn;
+
+// Returns a new Done button for a UINavigationItem which will call
+// closeSettings when it is pressed. Should only be called by view controllers
+// owned by SettingsNavigationController.
+- (UIBarButtonItem*)doneButton;
+
+// Returns the current main browser state.
+- (ios::ChromeBrowserState*)mainBrowserState;
+
+// Notifies this |SettingsNavigationController| that it will be dismissed such
+// that it has a possibility to do necessary clean up.
+- (void)settingsWillBeDismissed;
+
+// Closes this |SettingsNavigationController| by asking its delegate.
+- (void)closeSettings;
+
+// Pops the top view controller if there exists more than one view controller in
+// the navigation stack. Closes the settings if the top view controller is the
+// only view controller in the navigation stack.
+- (void)popViewControllerOrCloseSettingsAnimated:(BOOL)animated;
+
+@end
+
+@interface SettingsNavigationController (ExposedForTesting)
+
+// Initializes the UINavigationController with |rootViewController|.
+// User of this class should not call the normal |initWithRootViewController|.
+- (instancetype)
+initWithRootViewController:(UIViewController*)rootViewController
+              browserState:(ios::ChromeBrowserState*)browserState
+                  delegate:(id<SettingsNavigationControllerDelegate>)delegate;
+
+@end
+
+#endif  // IOS_CHROME_BROWSER_UI_SETTINGS_SETTINGS_NAVIGATION_CONTROLLER_H_