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 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803
|
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chromeos/ui/frame/immersive/immersive_fullscreen_controller.h"
#include <set>
#include "base/functional/bind.h"
#include "chromeos/ui/base/window_properties.h"
#include "chromeos/ui/frame/immersive/immersive_context.h"
#include "chromeos/ui/frame/immersive/immersive_focus_watcher.h"
#include "chromeos/ui/frame/immersive/immersive_fullscreen_controller_delegate.h"
#include "ui/aura/client/aura_constants.h"
#include "ui/aura/client/cursor_client.h"
#include "ui/aura/env.h"
#include "ui/aura/window.h"
#include "ui/aura/window_targeter.h"
#include "ui/compositor/scoped_animation_duration_scale_mode.h"
#include "ui/display/display.h"
#include "ui/display/screen.h"
#include "ui/events/base_event_utils.h"
#include "ui/gfx/animation/animation_delegate_notifier.h"
#include "ui/gfx/geometry/point.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/views/animation/animation_delegate_views.h"
#include "ui/views/bubble/bubble_dialog_delegate_view.h"
#include "ui/views/view.h"
#include "ui/views/widget/widget.h"
DEFINE_UI_CLASS_PROPERTY_TYPE(chromeos::ImmersiveFullscreenController*)
namespace chromeos {
DEFINE_UI_CLASS_PROPERTY_KEY(ImmersiveFullscreenController*,
kImmersiveFullscreenControllerKey,
nullptr)
namespace {
// A window targeter installed on a Widget's window when it's in immersive mode.
// This targeter insets the touch area for direct children of the window it's
// installed on (see calls to SetInsets) so that gestures at the top of the
// screen will be directed to the Widget window for triggering immersive reveal.
// The insets are disabled while the top view is revealed.
class ImmersiveWindowTargeter : public aura::WindowTargeter {
public:
ImmersiveWindowTargeter() = default;
ImmersiveWindowTargeter(const ImmersiveWindowTargeter&) = delete;
ImmersiveWindowTargeter& operator=(const ImmersiveWindowTargeter&) = delete;
~ImmersiveWindowTargeter() override = default;
bool ShouldUseExtendedBounds(const aura::Window* target) const override {
return target->parent() == window();
}
};
// The delay in milliseconds between the mouse stopping at the top edge of the
// screen and the top-of-window views revealing.
const int kMouseRevealDelayMs = 200;
// The maximum amount of pixels that the cursor can move for the cursor to be
// considered "stopped". This allows the user to reveal the top-of-window views
// without holding the cursor completely still.
const int kMouseRevealXThresholdPixels = 3;
// Used to multiply x value of an update in check to determine if gesture is
// vertical. This is used to make sure that gesture is close to vertical instead
// of just more vertical then horizontal.
const int kSwipeVerticalThresholdMultiplier = 3;
// The height in pixels of the region above the top edge of the display which
// hosts the immersive fullscreen window in which mouse events are ignored
// (cannot reveal or unreveal the top-of-window views).
// See ShouldIgnoreMouseEventAtLocation() for more details.
const int kHeightOfDeadRegionAboveTopContainer = 10;
} // namespace
// static
const int ImmersiveFullscreenController::kImmersiveFullscreenTopEdgeInset = 8;
// static
const int ImmersiveFullscreenController::kMouseRevealBoundsHeight = 3;
// static
bool ImmersiveFullscreenController::value_for_animations_disabled_for_test_ =
false;
////////////////////////////////////////////////////////////////////////////////
ImmersiveFullscreenController::ImmersiveFullscreenController()
: animations_disabled_for_test_(value_for_animations_disabled_for_test_) {}
ImmersiveFullscreenController::~ImmersiveFullscreenController() {
EnableEventObservers(false);
EnableWindowObservers(false);
}
void ImmersiveFullscreenController::Init(
ImmersiveFullscreenControllerDelegate* delegate,
views::Widget* widget,
views::View* top_container) {
// This function may be called more than once (e.g. by
// ClientControlledShellSurface).
EnableWindowObservers(false);
widget_observation_.Reset();
widget_observation_.Observe(widget);
delegate_ = delegate;
top_container_ = top_container;
animation_notifier_ = std::make_unique<
gfx::AnimationDelegateNotifier<views::AnimationDelegateViews>>(
this, top_container);
animation_ = std::make_unique<gfx::SlideAnimation>(animation_notifier_.get());
widget_ = widget;
// A widget can have more than one ImmersiveFullscreenController
// (WideFrameView does this), so this key only tracks the first
// ImmersiveFullscreenController.
if (nullptr == widget->GetNativeWindow()->GetProperty(
kImmersiveFullscreenControllerKey)) {
widget->GetNativeWindow()->SetProperty(kImmersiveFullscreenControllerKey,
this);
}
EnableWindowObservers(true);
}
bool ImmersiveFullscreenController::IsEnabled() const {
return enabled_;
}
bool ImmersiveFullscreenController::IsRevealed() const {
return enabled_ && reveal_state_ != CLOSED;
}
ImmersiveRevealedLock* ImmersiveFullscreenController::GetRevealedLock(
AnimateReveal animate_reveal) {
return new ImmersiveRevealedLock(weak_ptr_factory_.GetWeakPtr(),
animate_reveal);
}
///////////////////////////////////////////////////////////////////////////////
// ui::EventObserver overrides:
void ImmersiveFullscreenController::OnEvent(const ui::Event& event) {
if (!event.IsLocatedEvent())
return;
const ui::LocatedEvent* located_event = event.AsLocatedEvent();
aura::Window* target = static_cast<aura::Window*>(event.target());
if (event.IsMouseEvent()) {
HandleMouseEvent(*event.AsMouseEvent(), located_event->root_location(),
views::Widget::GetTopLevelWidgetForNativeView(target));
} else if (event.IsTouchEvent()) {
HandleTouchEvent(*event.AsTouchEvent(), located_event->root_location());
}
}
////////////////////////////////////////////////////////////////////////////////
// ui::EventHandler overrides:
void ImmersiveFullscreenController::OnEvent(ui::Event* event) {
ui::EventHandler::OnEvent(event);
}
void ImmersiveFullscreenController::OnGestureEvent(ui::GestureEvent* event) {
if (!enabled_)
return;
// Touch gestures should not initiate revealing the top-of-window views while
// |widget_| is inactive.
if (!widget_->IsActive())
return;
switch (event->type()) {
case ui::EventType::kGestureScrollBegin:
if (ShouldHandleGestureEvent(
event->target()->GetScreenLocation(*event))) {
gesture_begun_ = true;
// Do not consume the event. Otherwise, we end up consuming all
// ui::EventType::kGestureScrollBegin events in the top-of-window views
// when the top-of-window views are revealed.
}
break;
case ui::EventType::kGestureScrollUpdate:
if (gesture_begun_) {
if (UpdateRevealedLocksForSwipe(GetSwipeType(*event)))
event->SetHandled();
gesture_begun_ = false;
}
break;
case ui::EventType::kGestureScrollEnd:
case ui::EventType::kScrollFlingStart:
gesture_begun_ = false;
break;
default:
break;
}
}
////////////////////////////////////////////////////////////////////////////////
// aura::WindowObserver overrides:
void ImmersiveFullscreenController::OnWindowPropertyChanged(
aura::Window* window,
const void* key,
intptr_t old) {
if (key == kImmersiveIsActive)
UpdateEnabled();
}
void ImmersiveFullscreenController::OnWindowDestroying(aura::Window* window) {
CleanupOnWindowDestroy();
}
////////////////////////////////////////////////////////////////////////////////
// views::Observer overrides:
void ImmersiveFullscreenController::OnViewBoundsChanged(
views::View* observed_view) {
DCHECK_EQ(top_container_, observed_view);
widget()->GetNativeWindow()->SetProperty(
kImmersiveTopContainerBoundsInScreen,
new gfx::Rect(top_container_->GetBoundsInScreen()));
}
void ImmersiveFullscreenController::OnViewIsDeleting(
views::View* observed_view) {
DCHECK_EQ(observed_view, top_container_);
top_container_ = nullptr;
}
////////////////////////////////////////////////////////////////////////////////
// views::WidgetObserver: overrides:
void ImmersiveFullscreenController::OnWidgetDestroyed(views::Widget* widget) {
CleanupOnWindowDestroy();
}
////////////////////////////////////////////////////////////////////////////////
// gfx::AnimationDelegate overrides:
void ImmersiveFullscreenController::AnimationEnded(
const gfx::Animation* animation) {
if (reveal_state_ == SLIDING_OPEN) {
OnSlideOpenAnimationCompleted();
} else if (reveal_state_ == SLIDING_CLOSED) {
OnSlideClosedAnimationCompleted();
}
}
void ImmersiveFullscreenController::AnimationProgressed(
const gfx::Animation* animation) {
delegate_->SetVisibleFraction(animation->GetCurrentValue());
}
////////////////////////////////////////////////////////////////////////////////
// ImmersiveRevealedLock::Delegate overrides:
void ImmersiveFullscreenController::LockRevealedState(
AnimateReveal animate_reveal) {
++revealed_lock_count_;
Animate animate =
(animate_reveal == ANIMATE_REVEAL_YES) ? ANIMATE_FAST : ANIMATE_NO;
MaybeStartReveal(animate);
}
void ImmersiveFullscreenController::UnlockRevealedState() {
--revealed_lock_count_;
DCHECK_GE(revealed_lock_count_, 0);
if (revealed_lock_count_ == 0) {
// Always animate ending the reveal fast.
MaybeEndReveal(ANIMATE_FAST);
}
}
////////////////////////////////////////////////////////////////////////////////
// public:
// static
void ImmersiveFullscreenController::EnableForWidget(views::Widget* widget,
bool enabled) {
widget->GetNativeWindow()->SetProperty(kImmersiveIsActive, enabled);
}
// static
ImmersiveFullscreenController* ImmersiveFullscreenController::Get(
views::Widget* widget) {
return widget->GetNativeWindow()->GetProperty(
kImmersiveFullscreenControllerKey);
}
////////////////////////////////////////////////////////////////////////////////
// private:
void ImmersiveFullscreenController::EnableWindowObservers(bool enable) {
if (enable) {
top_container_->AddObserver(this);
widget_->GetNativeWindow()->AddObserver(this);
} else {
if (top_container_) {
top_container_->RemoveObserver(this);
top_container_ = nullptr;
}
if (widget_) {
widget_->GetNativeWindow()->RemoveObserver(this);
widget_ = nullptr;
}
animation_.reset();
animation_notifier_.reset();
}
}
void ImmersiveFullscreenController::EnableEventObservers(bool enable) {
if (event_observers_enabled_ == enable)
return;
event_observers_enabled_ = enable;
aura::Window* window = widget_->GetNativeWindow();
aura::Env* env = aura::Env::GetInstance();
if (enable) {
immersive_focus_watcher_ = std::make_unique<ImmersiveFocusWatcher>(this);
std::set<ui::EventType> types = {
ui::EventType::kMouseMoved, ui::EventType::kMousePressed,
ui::EventType::kMouseReleased, ui::EventType::kMousewheel,
ui::EventType::kMouseCaptureChanged, ui::EventType::kTouchPressed};
env->AddEventObserver(this, env, types);
window->AddPreTargetHandler(this);
} else {
window->RemovePreTargetHandler(this);
env->RemoveEventObserver(this);
immersive_focus_watcher_.reset();
animation_->Stop();
}
}
void ImmersiveFullscreenController::HandleMouseEvent(
const ui::MouseEvent& event,
const gfx::Point& location_in_screen,
views::Widget* target) {
if (!enabled_)
return;
if (event.type() != ui::EventType::kMouseMoved &&
event.type() != ui::EventType::kMousePressed &&
event.type() != ui::EventType::kMouseReleased &&
event.type() != ui::EventType::kMouseCaptureChanged) {
return;
}
// Mouse hover can initiate revealing the top-of-window views while |widget_|
// is inactive.
if (reveal_state_ == SLIDING_OPEN || reveal_state_ == REVEALED) {
top_edge_hover_timer_.Stop();
UpdateLocatedEventRevealedLock(&event, location_in_screen);
} else if (event.type() != ui::EventType::kMouseCaptureChanged) {
// Trigger reveal if the cursor pauses at the top of the screen for a while.
UpdateTopEdgeHoverTimer(event, location_in_screen, target);
}
}
void ImmersiveFullscreenController::HandleTouchEvent(
const ui::TouchEvent& event,
const gfx::Point& location_in_screen) {
if (!enabled_ || event.type() != ui::EventType::kTouchPressed) {
return;
}
// Touch should not initiate revealing the top-of-window views while |widget_|
// is inactive.
if (!widget_->IsActive())
return;
UpdateLocatedEventRevealedLock(&event, location_in_screen);
}
void ImmersiveFullscreenController::UpdateTopEdgeHoverTimer(
const ui::MouseEvent& event,
const gfx::Point& location_in_screen,
views::Widget* target) {
DCHECK(enabled_);
DCHECK(reveal_state_ == SLIDING_CLOSED || reveal_state_ == CLOSED);
// Check whether |widget_| is the event target instead of checking for
// activation. This allows the timer to be started when |widget_| is inactive
// but prevents starting the timer if the mouse is over a portion of the top
// edge obscured by an unrelated widget.
if (!top_edge_hover_timer_.IsRunning() && !IsTargetForWidget(target))
return;
// Mouse hover should not initiate revealing the top-of-window views while a
// window has mouse capture.
if (ImmersiveContext::Get()->DoesAnyWindowHaveCapture())
return;
if (ShouldIgnoreMouseEventAtLocation(location_in_screen))
return;
// Stop the timer if the cursor left the top edge or is on a different
// display.
gfx::Rect hit_bounds_in_screen = GetDisplayBoundsInScreen();
hit_bounds_in_screen.set_height(kMouseRevealBoundsHeight);
if (!hit_bounds_in_screen.Contains(location_in_screen)) {
top_edge_hover_timer_.Stop();
return;
}
// The cursor is now at the top of the screen. Consider the cursor "not
// moving" even if it moves a little bit because users don't have perfect
// pointing precision. (The y position is not tested because
// |hit_bounds_in_screen| is short.)
if (top_edge_hover_timer_.IsRunning() &&
abs(location_in_screen.x() - mouse_x_when_hit_top_in_screen_) <=
kMouseRevealXThresholdPixels)
return;
// Start the reveal if the cursor doesn't move for some amount of time.
mouse_x_when_hit_top_in_screen_ = location_in_screen.x();
top_edge_hover_timer_.Stop();
// Timer is stopped when |this| is destroyed, hence Unretained() is safe.
top_edge_hover_timer_.Start(
FROM_HERE, base::Milliseconds(kMouseRevealDelayMs),
base::BindOnce(
&ImmersiveFullscreenController::AcquireLocatedEventRevealedLock,
base::Unretained(this)));
}
void ImmersiveFullscreenController::UpdateLocatedEventRevealedLock(
const ui::LocatedEvent* event,
const gfx::Point& location_in_screen) {
if (!enabled_)
return;
DCHECK(!event || event->IsMouseEvent() || event->IsTouchEvent());
// Neither the mouse nor touch can initiate a reveal when the top-of-window
// views are sliding closed or are closed with the following exceptions:
// - Hovering at y = 0 which is handled in HandleMouseEvent().
// - Doing a SWIPE_OPEN edge gesture which is handled in OnGestureEvent().
if (reveal_state_ == CLOSED || reveal_state_ == SLIDING_CLOSED)
return;
// For the sake of simplicity, ignore |widget_|'s activation in computing
// whether the top-of-window views should stay revealed. Ideally, the
// top-of-window views would stay revealed only when the mouse cursor is
// hovered above a non-obscured portion of the top-of-window views. The
// top-of-window views may be partially obscured when |widget_| is inactive.
// Ignore all events while a window has capture. This keeps the top-of-window
// views revealed during a drag.
if (ImmersiveContext::Get()->DoesAnyWindowHaveCapture())
return;
if ((!event || event->IsMouseEvent()) &&
ShouldIgnoreMouseEventAtLocation(location_in_screen)) {
return;
}
// The visible bounds of |top_container_| should be contained in
// |hit_bounds_in_screen|.
std::vector<gfx::Rect> hit_bounds_in_screen =
delegate_->GetVisibleBoundsInScreen();
bool keep_revealed = false;
for (size_t i = 0; i < hit_bounds_in_screen.size(); ++i) {
// Allow the cursor to move slightly off the top-of-window views before
// sliding closed. In the case of ImmersiveModeControllerAsh, this helps
// when the user is attempting to click on the bookmark bar and
// overshoots slightly.
if (event && event->type() == ui::EventType::kMouseMoved) {
const int kBoundsOffsetY = 8;
hit_bounds_in_screen[i].Inset(
gfx::Insets::TLBR(0, 0, -kBoundsOffsetY, 0));
}
if (hit_bounds_in_screen[i].Contains(location_in_screen)) {
keep_revealed = true;
break;
}
}
if (keep_revealed)
AcquireLocatedEventRevealedLock();
else
located_event_revealed_lock_.reset();
}
void ImmersiveFullscreenController::UpdateLocatedEventRevealedLock() {
if (!aura::client::GetCursorClient(
widget_->GetNativeWindow()->GetRootWindow())
->IsMouseEventsEnabled()) {
// If mouse events are disabled, the user's last interaction was probably
// via touch. Do no further processing in this case as there is no easy
// way of retrieving the position of the user's last touch.
return;
}
UpdateLocatedEventRevealedLock(
nullptr, display::Screen::GetScreen()->GetCursorScreenPoint());
}
void ImmersiveFullscreenController::AcquireLocatedEventRevealedLock() {
// CAUTION: Acquiring the lock results in a reentrant call to
// AcquireLocatedEventRevealedLock() when
// |ImmersiveFullscreenController::animations_disabled_for_test_| is true.
if (!located_event_revealed_lock_.get())
located_event_revealed_lock_.reset(GetRevealedLock(ANIMATE_REVEAL_YES));
}
bool ImmersiveFullscreenController::UpdateRevealedLocksForSwipe(
SwipeType swipe_type) {
if (!enabled_ || swipe_type == SWIPE_NONE)
return false;
// Swipes while |widget_| is inactive should have been filtered out in
// OnGestureEvent().
DCHECK(widget_->IsActive());
if (reveal_state_ == SLIDING_CLOSED || reveal_state_ == CLOSED) {
if (swipe_type == SWIPE_OPEN && !located_event_revealed_lock_.get()) {
located_event_revealed_lock_.reset(GetRevealedLock(ANIMATE_REVEAL_YES));
return true;
}
} else {
if (swipe_type == SWIPE_CLOSE) {
// Attempt to end the reveal. If other code is holding onto a lock, the
// attempt will be unsuccessful.
located_event_revealed_lock_.reset();
if (immersive_focus_watcher_)
immersive_focus_watcher_->ReleaseLock();
if (reveal_state_ == SLIDING_CLOSED || reveal_state_ == CLOSED) {
widget_->GetFocusManager()->ClearFocus();
return true;
}
// Ending the reveal was unsuccessful. Reaquire the locks if appropriate.
UpdateLocatedEventRevealedLock();
if (immersive_focus_watcher_)
immersive_focus_watcher_->UpdateFocusRevealedLock();
}
}
return false;
}
base::TimeDelta ImmersiveFullscreenController::GetAnimationDuration(
Animate animate) const {
base::TimeDelta duration;
switch (animate) {
case ANIMATE_NO:
// Use default which is `base::TimeDelta()`.
break;
case ANIMATE_SLOW:
duration = base::Milliseconds(400);
break;
case ANIMATE_FAST:
duration = base::Milliseconds(200);
break;
}
return ui::ScopedAnimationDurationScaleMode::duration_multiplier() * duration;
}
void ImmersiveFullscreenController::MaybeStartReveal(Animate animate) {
if (!enabled_)
return;
if (animations_disabled_for_test_)
animate = ANIMATE_NO;
// Callers with ANIMATE_NO expect this function to synchronously reveal the
// top-of-window views.
if (reveal_state_ == REVEALED ||
(reveal_state_ == SLIDING_OPEN && animate != ANIMATE_NO)) {
return;
}
RevealState previous_reveal_state = reveal_state_;
reveal_state_ = SLIDING_OPEN;
if (previous_reveal_state == CLOSED) {
EnableTouchInsets(false);
delegate_->OnImmersiveRevealStarted();
// Do not do any more processing if OnImmersiveRevealStarted() changed
// |reveal_state_|.
if (reveal_state_ != SLIDING_OPEN)
return;
}
// Slide in the reveal view.
if (animate == ANIMATE_NO) {
animation_->Reset(1);
OnSlideOpenAnimationCompleted();
} else {
animation_->SetSlideDuration(GetAnimationDuration(animate));
animation_->Show();
}
}
void ImmersiveFullscreenController::OnSlideOpenAnimationCompleted() {
DCHECK_EQ(SLIDING_OPEN, reveal_state_);
reveal_state_ = REVEALED;
delegate_->SetVisibleFraction(1);
// The user may not have moved the mouse since the reveal was initiated.
// Update the revealed lock to reflect the mouse's current state.
UpdateLocatedEventRevealedLock();
}
void ImmersiveFullscreenController::MaybeEndReveal(Animate animate) {
if (!enabled_ || revealed_lock_count_ != 0)
return;
if (animations_disabled_for_test_)
animate = ANIMATE_NO;
// Callers with ANIMATE_NO expect this function to synchronously close the
// top-of-window views.
if (reveal_state_ == CLOSED ||
(reveal_state_ == SLIDING_CLOSED && animate != ANIMATE_NO)) {
return;
}
reveal_state_ = SLIDING_CLOSED;
base::TimeDelta duration = GetAnimationDuration(animate);
if (duration.is_positive()) {
animation_->SetSlideDuration(duration);
animation_->Hide();
} else {
animation_->Reset(0);
OnSlideClosedAnimationCompleted();
}
}
void ImmersiveFullscreenController::OnSlideClosedAnimationCompleted() {
DCHECK_EQ(SLIDING_CLOSED, reveal_state_);
reveal_state_ = CLOSED;
EnableTouchInsets(true);
delegate_->OnImmersiveRevealEnded();
}
ImmersiveFullscreenController::SwipeType
ImmersiveFullscreenController::GetSwipeType(
const ui::GestureEvent& event) const {
if (event.type() != ui::EventType::kGestureScrollUpdate) {
return SWIPE_NONE;
}
// Make sure that it is a clear vertical gesture.
if (std::abs(event.details().scroll_y()) <=
kSwipeVerticalThresholdMultiplier * std::abs(event.details().scroll_x()))
return SWIPE_NONE;
if (event.details().scroll_y() < 0)
return SWIPE_CLOSE;
if (event.details().scroll_y() > 0)
return SWIPE_OPEN;
return SWIPE_NONE;
}
bool ImmersiveFullscreenController::ShouldIgnoreMouseEventAtLocation(
const gfx::Point& location) const {
// Ignore mouse events in the region immediately above the top edge of the
// display. This is to handle the case of a user with a vertical display
// layout (primary display above/below secondary display) and the immersive
// fullscreen window on the bottom display. It is really hard to trigger a
// reveal in this case because:
// - It is hard to stop the cursor in the top |kMouseRevealBoundsHeight|
// pixels of the bottom display.
// - The cursor is warped to the top display if the cursor gets to the top
// edge of the bottom display.
// Mouse events are ignored in the bottom few pixels of the top display
// (Mouse events in this region cannot start or end a reveal). This allows a
// user to overshoot the top of the bottom display and still reveal the
// top-of-window views.
gfx::Rect dead_region = GetDisplayBoundsInScreen();
dead_region.set_y(dead_region.y() - kHeightOfDeadRegionAboveTopContainer);
dead_region.set_height(kHeightOfDeadRegionAboveTopContainer);
return dead_region.Contains(location);
}
bool ImmersiveFullscreenController::ShouldHandleGestureEvent(
const gfx::Point& location) const {
DCHECK(widget_->IsActive());
if (reveal_state_ == REVEALED) {
std::vector<gfx::Rect> hit_bounds_in_screen(
delegate_->GetVisibleBoundsInScreen());
for (size_t i = 0; i < hit_bounds_in_screen.size(); ++i) {
if (hit_bounds_in_screen[i].Contains(location))
return true;
}
return false;
}
// When the top-of-window views are not fully revealed, handle gestures which
// start in the top few pixels of the screen.
gfx::Rect hit_bounds_in_screen(GetDisplayBoundsInScreen());
hit_bounds_in_screen.set_height(kImmersiveFullscreenTopEdgeInset);
if (hit_bounds_in_screen.Contains(location))
return true;
// There may be a bezel sensor off screen logically above
// |hit_bounds_in_screen|. The check for the event not contained by the
// closest screen ensures that the event is from a valid bezel (as opposed to
// another screen in an extended desktop).
gfx::Rect screen_bounds =
display::Screen::GetScreen()->GetDisplayNearestPoint(location).bounds();
return (!screen_bounds.Contains(location) &&
location.y() < hit_bounds_in_screen.y() &&
location.x() >= hit_bounds_in_screen.x() &&
location.x() < hit_bounds_in_screen.right());
}
gfx::Rect ImmersiveFullscreenController::GetDisplayBoundsInScreen() const {
return ImmersiveContext::Get()->GetDisplayBoundsInScreen(widget_);
}
bool ImmersiveFullscreenController::IsTargetForWidget(
views::Widget* target) const {
return target == widget_ || target == top_container_->GetWidget();
}
void ImmersiveFullscreenController::UpdateEnabled() {
if (!widget_)
return;
const bool enabled =
widget_->GetNativeWindow()->GetProperty(kImmersiveIsActive);
if (enabled_ == enabled) {
// Frame layout depends on the window's state and size,
// which can happen asynchronously and/or independently,
// from the timing when the immersive state change.
delegate_->Relayout();
return;
}
enabled_ = enabled;
EnableEventObservers(enabled_);
ImmersiveContext::Get()->OnEnteringOrExitingImmersive(this, enabled);
if (enabled_) {
// Animate enabling immersive mode by sliding out the top-of-window views.
// No animation occurs if a lock is holding the top-of-window views open.
normal_targeter_ = widget_->GetNativeWindow()->SetEventTargeter(
std::make_unique<ImmersiveWindowTargeter>());
// Do a reveal to set the initial state for the animation. (And any
// required state in case the animation cannot run because of a lock holding
// the top-of-window views open.)
MaybeStartReveal(ANIMATE_NO);
// Reset the located event so that it does not affect whether the
// top-of-window views are hidden.
located_event_revealed_lock_.reset();
// Try doing the animation.
MaybeEndReveal(ANIMATE_SLOW);
if (reveal_state_ == REVEALED) {
// Reveal was unsuccessful. Reacquire the revealed locks if appropriate.
UpdateLocatedEventRevealedLock();
if (immersive_focus_watcher_)
immersive_focus_watcher_->UpdateFocusRevealedLock();
}
delegate_->OnImmersiveFullscreenEntered();
} else {
// Stop cursor-at-top tracking.
top_edge_hover_timer_.Stop();
reveal_state_ = CLOSED;
widget_->GetNativeWindow()->SetEventTargeter(std::move(normal_targeter_));
delegate_->OnImmersiveFullscreenExited();
}
}
void ImmersiveFullscreenController::EnableTouchInsets(bool enable) {
if (!widget_->GetNativeWindow()->targeter())
return;
widget_->GetNativeWindow()->targeter()->SetInsets(
{}, gfx::Insets::TLBR(enable ? kImmersiveFullscreenTopEdgeInset : 0, 0, 0,
0));
}
void ImmersiveFullscreenController::CleanupOnWindowDestroy() {
EnableEventObservers(false);
EnableWindowObservers(false);
widget_observation_.Reset();
// Set `enabled_` to false such that any calls to MaybeStartReveal() and
// MaybeEndReveal() have no effect.
enabled_ = false;
widget_ = nullptr;
}
} // namespace chromeos
|