// Copyright 2015 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_OVERSCROLL_ACTIONS_UI_BUNDLED_OVERSCROLL_ACTIONS_CONTROLLER_H_
#define IOS_CHROME_BROWSER_OVERSCROLL_ACTIONS_UI_BUNDLED_OVERSCROLL_ACTIONS_CONTROLLER_H_
#import <UIKit/UIKit.h>
#import "ios/chrome/browser/overscroll_actions/ui_bundled/overscroll_actions_view.h"
#import "ios/web/public/ui/crw_web_view_scroll_view_proxy.h"
@protocol CRWWebViewProxy;
class FullscreenController;
@class OverscrollActionsController;
// Describe the current state of the overscroll action controller.
enum class OverscrollState {
NO_PULL_STARTED, // No pull started.
STARTED_PULLING, // Started pulling.
ACTION_READY // Ready to take action on pull end.
};
// The delegate of the OverscrollActionsController, it provides the headerView
// on which the OverscrollActionsView will be added.
// The scrollView is used to control the state of the
// OverscrollActionsController.
// The delegate must implement the shouldAllowOverscrollActions method in order
// to allow overscroll actions.
// Finally the overscrollActionsController:didTriggerActionAtIndex: method is
// called when an action has been triggered.
@protocol OverscrollActionsControllerDelegate<NSObject>
// Called when a New Tab action has been triggered.
- (void)overscrollActionNewTab:(OverscrollActionsController*)controller;
// Called when a Close Tab action has been triggered.
- (void)overscrollActionCloseTab:(OverscrollActionsController*)controller;
// Called when a Refresh action has been triggered.
- (void)overscrollActionRefresh:(OverscrollActionsController*)controller;
// Should return true when the delegate wants to enable the overscroll actions.
- (BOOL)shouldAllowOverscrollActionsForOverscrollActionsController:
(OverscrollActionsController*)controller;
// The toolbar snapshot view that will be used to fade in/out the toolbar.
// This snapshot will be animated when performing the pull down animation
// revealing the actions.
- (UIView*)toolbarSnapshotViewForOverscrollActionsController:
(OverscrollActionsController*)controller;
// The header view over which the overscroll action view will be added.
- (UIView*)headerViewForOverscrollActionsController:
(OverscrollActionsController*)controller;
// Called to retrieve the top inset added to the scrollview for the header.
- (CGFloat)headerInsetForOverscrollActionsController:
(OverscrollActionsController*)controller;
// Called to retrieve the current height of the header.
- (CGFloat)headerHeightForOverscrollActionsController:
(OverscrollActionsController*)controller;
// Called to retrieve the initial content offset for the scrollview because
// some scrollviews don't start at offset 0.
- (CGFloat)initialContentOffsetForOverscrollActionsController:
(OverscrollActionsController*)controller;
// The fullscreen controller, if any, the delegate makes available for
// overscroll. The deleagate may return nullptr if fullscreen isn't supported.
// This method will be called each time the overscroll state might need to
// interact with fullscreen, so it's fine for a delegate to return nullptr as
// soon as it enters a state where fullscreen is unsupported.
- (FullscreenController*)fullscreenControllerForOverscrollActionsController:
(OverscrollActionsController*)controller;
@end
// The OverscrollActionsController controls the display of an
// OverscrollActionsView above the headerView provided by the delegate.
//
// Pulling down the scrollview will start showing the OverscrollActionView.
// Finally, the headerView frame will be resized in height during the process of
// showing the overscrollActionsView.
//
// The OverscrollActionsController can be used in two different modes depending
// on what kind of scrollview it's using:
//
// - the first mode will use a scrollview for the web view provided by the
// CRWWebViewProxy; the -invalidate method must be called before the web
// view is destroyed.
//
// - the second mode will use a scrollview provided during initialization;
// this second mode will typically be used in native tabs like the error
// tabs or the NTP.
@interface OverscrollActionsController : NSObject<UIScrollViewDelegate>
// Initializes the OverscrollActionsController with a proxy to the web
// view scrollview. The CRWWebViewProxy must not be nil.
- (instancetype)initWithWebViewProxy:(id<CRWWebViewProxy>)webViewProxy;
// Initializes the OverscrollActionsController with a scrollview. The
// scroll view must not be nil.
- (instancetype)initWithScrollView:(UIScrollView*)scrollView;
- (instancetype)init NS_UNAVAILABLE;
// Investigation into crbug.com/1102494 shows that the most likely issue is
// that there are many many instances of OverscrollActionsController live at
// once. This tracks how many live instances there are.
+ (int)instanceCount;
// The scrollview the overscroll controller will control.
@property(weak, nonatomic, readonly) UIScrollView* scrollView;
// The current state of the overscroll controller.
@property(nonatomic, assign, readonly) OverscrollState overscrollState;
// The delegate must be set for the OverscrollActionsController to work
// properly.
@property(nonatomic, weak) id<OverscrollActionsControllerDelegate> delegate;
// Used to clear state maintained by the controller and de-register from
// notifications. After this call the controller ceases to function and will
// clear its delegate.
- (void)invalidate;
// Schedules call to `invalidate` at the end of the current action. This lets
// the animation finish before invalidating the controller.
// If no action is running, calls `invalidate` immediately.
- (void)scheduleInvalidate;
// Force the controller to switch to NO_PULL_STARTED state.
- (void)clear;
// Disabling overscroll actions will stop showing the overscroll actions view on
// top of the header when the user is pulling the webview's scrollview.
// Disable/enableOverscrollActions method calls are ref counted, this means
// that calls to disable must be compensated by the same amount of call to
// enable in order to reenable overscroll actions.
- (void)disableOverscrollActions;
// Enabling overscroll actions will reverse the effect of a call to
// -disableOverscrollActions.
- (void)enableOverscrollActions;
// Sets the style of the overscroll actions.
- (void)setStyle:(OverscrollStyle)style;
// Trigger a overscroll refresh without user gesture.
- (void)forceAnimatedScrollRefresh;
@end
#endif // IOS_CHROME_BROWSER_OVERSCROLL_ACTIONS_UI_BUNDLED_OVERSCROLL_ACTIONS_CONTROLLER_H_
Codebase Browser
chromium