ios/chrome/browser/presenters/ui_bundled/contained_presenter.h

// Copyright 2017 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_PRESENTERS_UI_BUNDLED_CONTAINED_PRESENTER_H_
#define IOS_CHROME_BROWSER_PRESENTERS_UI_BUNDLED_CONTAINED_PRESENTER_H_

#import <UIKit/UIKit.h>

@protocol ContainedPresenterDelegate;

// Helper that manages the positioning and presentation of a contained (child)
// view controller. Implementors determine the specifics of the positioning
// and presentation.
@protocol ContainedPresenter

// The view controller which will contain the presented (child) view controller.
@property(nonatomic, weak) UIViewController* baseViewController;
// The view controller to be presented.
@property(nonatomic, weak) UIViewController* presentedViewController;
// The delegate object which will be told about presentation events.
@property(nonatomic, weak) id<ContainedPresenterDelegate> delegate;

// It's an error to call any of the following methods when
// `presentedViewController` is nil. It's the responsibility of the object that
// owns an implementation of this protocol to ensure that doesn't happen.

// Prepares the view controllers for presentation. The presented view controller
// should become a child of the base view controller.
- (void)prepareForPresentation;

// Presents the presented view controller, animating the presentation if
// `animated` is YES. If `animated` is NO, any layout changes should execute
// synchronously. This is a no-op if the presented view controller is already
// being presented. It's an error to call this without calling
// -prepareForPresentation first.
- (void)presentAnimated:(BOOL)animated;

// Dismisses the presented view controller, animating the dismissal if
// `animated` is YES. If `animated` is NO, any layout changes should execute
// synchronously. This is a no-op if the presented view controller is already
// dismissed, or hasn't been presented. Once the presentation completes (or
// synchronously if `animated` is NO), `delegate` should have its
// -containedPresenterDidDismiss: method called, and the presented view
// controller should stop being a child of the base view controller.
- (void)dismissAnimated:(BOOL)animated;

@end

#endif  // IOS_CHROME_BROWSER_PRESENTERS_UI_BUNDLED_CONTAINED_PRESENTER_H_