1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
// Copyright 2012 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 CHROME_BROWSER_UI_VIEWS_FRAME_IMMERSIVE_MODE_CONTROLLER_H_
#define CHROME_BROWSER_UI_VIEWS_FRAME_IMMERSIVE_MODE_CONTROLLER_H_
#include "base/compiler_specific.h"
#include "base/observer_list.h"
#include "chrome/browser/ui/host_desktop.h"
class BrowserView;
namespace gfx {
class Rect;
class Size;
}
// A lock which will keep the top-of-window views revealed for its
// lifetime.
// See ImmersiveModeController::GetRevealedLock for details.
class ImmersiveRevealedLock {
public:
virtual ~ImmersiveRevealedLock() {}
protected:
ImmersiveRevealedLock() {}
};
// Controller for an "immersive mode" similar to MacOS presentation mode where
// the top-of-window views are hidden until the mouse hits the top of the
// screen. The tab strip is optionally painted with miniature "tab indicator"
// rectangles.
// Currently, immersive mode is only available for Chrome OS.
class ImmersiveModeController {
public:
enum AnimateReveal {
ANIMATE_REVEAL_YES,
ANIMATE_REVEAL_NO
};
class Observer {
public:
// Called when a reveal of the top-of-window views has been initiated.
virtual void OnImmersiveRevealStarted() {}
// Called when the immersive mode controller has been destroyed.
virtual void OnImmersiveModeControllerDestroyed() {}
protected:
virtual ~Observer() {}
};
ImmersiveModeController();
virtual ~ImmersiveModeController();
// Must initialize after browser view has a Widget and native window.
virtual void Init(BrowserView* browser_view) = 0;
// Enables or disables immersive mode.
virtual void SetEnabled(bool enabled) = 0;
virtual bool IsEnabled() const = 0;
// True if the miniature "tab indicators" should be hidden in the main browser
// view when immersive mode is enabled.
virtual bool ShouldHideTabIndicators() const = 0;
// True when the top views are hidden due to immersive mode.
virtual bool ShouldHideTopViews() const = 0;
// True when the top views are fully or partially visible.
virtual bool IsRevealed() const = 0;
// Returns the top container's vertical offset relative to its parent. When
// revealing or closing the top-of-window views, part of the top container is
// offscreen.
// This method takes in the top container's size because it is called as part
// of computing the new bounds for the top container in
// BrowserViewLayout::UpdateTopContainerBounds().
virtual int GetTopContainerVerticalOffset(
const gfx::Size& top_container_size) const = 0;
// Returns a lock which will keep the top-of-window views revealed for its
// lifetime. Several locks can be obtained. When all of the locks are
// destroyed, if immersive mode is enabled and there is nothing else keeping
// the top-of-window views revealed, the top-of-window views will be closed.
// This method always returns a valid lock regardless of whether immersive
// mode is enabled. The lock's lifetime can span immersive mode being
// enabled / disabled.
// If acquiring the lock causes a reveal, the top-of-window views will animate
// according to |animate_reveal|.
// The caller takes ownership of the returned lock.
// This is currently only supported on Ash.
virtual ImmersiveRevealedLock* GetRevealedLock(
AnimateReveal animate_reveal) WARN_UNUSED_RESULT = 0;
// Called by the find bar to indicate that its visible bounds have changed.
// |new_visible_bounds_in_screen| should be empty if the find bar is not
// visible.
virtual void OnFindBarVisibleBoundsChanged(
const gfx::Rect& new_visible_bounds_in_screen) = 0;
// Disables animations and moves the mouse so that it is not over the
// top-of-window views for the sake of testing. Must be called before
// enabling immersive fullscreen.
virtual void SetupForTest() = 0;
virtual void AddObserver(Observer* observer);
virtual void RemoveObserver(Observer* observer);
protected:
ObserverList<Observer> observers_;
private:
DISALLOW_COPY_AND_ASSIGN(ImmersiveModeController);
};
namespace chrome {
// Implemented in immersive_mode_controller_factory.cc.
ImmersiveModeController* CreateImmersiveModeController(
chrome::HostDesktopType host_desktop_type);
} // namespace chrome
#endif // CHROME_BROWSER_UI_VIEWS_FRAME_IMMERSIVE_MODE_CONTROLLER_H_
|
