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 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ui/views/widget/root_view.h"
#include <algorithm>
#include <memory>
#include <string_view>
#include "base/logging.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/raw_ptr_exclusion.h"
#include "base/memory/raw_ref.h"
#include "base/scoped_observation.h"
#include "build/build_config.h"
#include "ui/accessibility/ax_enums.mojom.h"
#include "ui/accessibility/ax_node_data.h"
#include "ui/accessibility/platform/ax_platform_node.h"
#include "ui/base/cursor/cursor.h"
#include "ui/base/dragdrop/mojom/drag_drop_types.mojom-shared.h"
#include "ui/base/metadata/metadata_header_macros.h"
#include "ui/base/metadata/metadata_impl_macros.h"
#include "ui/base/mojom/menu_source_type.mojom.h"
#include "ui/base/ui_base_features.h"
#include "ui/compositor/layer.h"
#include "ui/events/event.h"
#include "ui/events/event_utils.h"
#include "ui/events/gestures/gesture_recognizer.h"
#include "ui/events/keycodes/keyboard_codes.h"
#include "ui/gfx/canvas.h"
#include "ui/views/accessibility/view_accessibility.h"
#include "ui/views/drag_controller.h"
#include "ui/views/view_class_properties.h"
#include "ui/views/view_targeter.h"
#include "ui/views/views_features.h"
#include "ui/views/widget/root_view_targeter.h"
#include "ui/views/widget/widget.h"
#include "ui/views/widget/widget_delegate.h"
#if BUILDFLAG(IS_MAC)
#include "ui/accessibility/accessibility_features.h"
#endif
using DispatchDetails = ui::EventDispatchDetails;
namespace views::internal {
namespace {
class MouseEnterExitEvent : public ui::MouseEvent {
public:
MouseEnterExitEvent(const ui::MouseEvent& event, ui::EventType type)
: ui::MouseEvent(event,
static_cast<View*>(nullptr),
static_cast<View*>(nullptr)) {
DCHECK(type == ui::EventType::kMouseEntered ||
type == ui::EventType::kMouseExited);
SetType(type);
}
~MouseEnterExitEvent() override = default;
// Event:
std::unique_ptr<ui::Event> Clone() const override {
return std::make_unique<MouseEnterExitEvent>(*this);
}
};
} // namespace
// Used by RootView to create a hidden child that can be used to make screen
// reader announcements on platforms that don't have a reliable system API call
// to do that.
//
// We use a separate view because the RootView itself supplies the widget's
// accessible name and cannot serve double-duty (the inability for views to make
// their own announcements without changing their accessible name or description
// is the reason this system exists at all).
class AnnounceTextView : public View {
METADATA_HEADER(AnnounceTextView, View)
public:
AnnounceTextView() {
// When constructed the view will have no name, but will change as soon as
// text needs to be announced.
UpdateAccessibleAttributes(std::u16string());
}
~AnnounceTextView() override = default;
void AnnounceTextAs(const std::u16string& text,
ui::AXPlatformNode::AnnouncementType announcement_type) {
UpdateAccessibleAttributes(text, announcement_type);
CHECK(HasValidRole());
NotifyAccessibilityEventDeprecated(AnnounceEventType(announcement_type),
/*send_native_event=*/true);
}
ax::mojom::Event AnnounceEventType(
ui::AXPlatformNode::AnnouncementType announcement_type) const {
CHECK(HasValidRole());
ax::mojom::Event event_type = ax::mojom::Event::kNone;
switch (announcement_type) {
case ui::AXPlatformNode::AnnouncementType::kAlert:
event_type = ax::mojom::Event::kAlert;
break;
case ui::AXPlatformNode::AnnouncementType::kPolite:
event_type = ax::mojom::Event::kLiveRegionChanged;
break;
}
CHECK(IsValidEvent(event_type));
return event_type;
}
void UpdateAccessibleAttributes(
const std::u16string& announce_text,
std::optional<ui::AXPlatformNode::AnnouncementType> announcement_type =
std::nullopt) {
// Since this view is a unique view that is hidden and only to provide a
// mechanism for Views to make their own announcements, we should not fire
// events that are not `announce_event_type_` which may otherwise be
// generated when we, for example, update the name of the view.
ScopedAccessibilityEventBlocker scoped_event_blocker(
GetViewAccessibility());
// View should have a initial accessible role, and it will later change
// depending on the `announce_role` accordingly.
ax::mojom::Role announce_role = ax::mojom::Role::kStatus;
if (announcement_type.has_value()) {
switch (announcement_type.value()) {
case ui::AXPlatformNode::AnnouncementType::kAlert:
announce_role = ax::mojom::Role::kAlert;
break;
case ui::AXPlatformNode::AnnouncementType::kPolite:
announce_role = ax::mojom::Role::kStatus;
break;
}
}
UpdateAccessibleRole(announce_role);
GetViewAccessibility().SetIsInvisible(true);
GetViewAccessibility().SetLiveAtomic(true);
GetViewAccessibility().SetLiveStatus("polite");
if (announce_text.empty()) {
GetViewAccessibility().SetName(
announce_text, ax::mojom::NameFrom::kAttributeExplicitlyEmpty);
} else {
GetViewAccessibility().SetName(announce_text);
}
if (base::FeatureList::IsEnabled(
features::kAnnounceTextAdditionalAttributes)) {
GetViewAccessibility().SetContainerLiveStatus("polite");
GetViewAccessibility().SetLiveRelevant("additions text");
GetViewAccessibility().SetContainerLiveRelevant("additions text");
} else {
GetViewAccessibility().RemoveContainerLiveStatus();
GetViewAccessibility().RemoveLiveRelevant();
GetViewAccessibility().RemoveContainerLiveRelevant();
}
}
void UpdateAccessibleRole(ax::mojom::Role announce_role) {
#if BUILDFLAG(IS_CHROMEOS)
// On ChromeOS, kAlert role can invoke an unnecessary event on reparenting.
GetViewAccessibility().SetRole(ax::mojom::Role::kStaticText);
#elif BUILDFLAG(IS_LINUX)
// TODO(crbug.com/40658933): Use live regions (do not use alerts).
// May require setting kLiveStatus, kContainerLiveStatus to "polite".
GetViewAccessibility().SetRole(ax::mojom::Role::kAlert);
#else
GetViewAccessibility().SetRole(announce_role);
#endif
}
bool HasValidRole() const {
return GetViewAccessibility().GetCachedRole() ==
ax::mojom::Role::kStaticText ||
GetViewAccessibility().GetCachedRole() == ax::mojom::Role::kAlert ||
GetViewAccessibility().GetCachedRole() == ax::mojom::Role::kStatus;
}
bool IsValidEvent(ax::mojom::Event announce_event_type) const {
return announce_event_type == ax::mojom::Event::kAlert ||
announce_event_type == ax::mojom::Event::kLiveRegionChanged;
}
};
BEGIN_METADATA(AnnounceTextView)
END_METADATA
// This event handler receives events in the pre-target phase and takes care of
// the following:
// - Shows keyboard-triggered context menus.
class PreEventDispatchHandler : public ui::EventHandler {
public:
explicit PreEventDispatchHandler(View* owner) : owner_(owner) {
owner_->AddPreTargetHandler(this);
}
PreEventDispatchHandler(const PreEventDispatchHandler&) = delete;
PreEventDispatchHandler& operator=(const PreEventDispatchHandler&) = delete;
~PreEventDispatchHandler() override { owner_->RemovePreTargetHandler(this); }
private:
// ui::EventHandler:
void OnKeyEvent(ui::KeyEvent* event) override {
CHECK_EQ(ui::EP_PRETARGET, event->phase());
// macOS doesn't have keyboard-triggered context menus.
#if !BUILDFLAG(IS_MAC)
if (event->handled()) {
return;
}
View* v = nullptr;
if (owner_->GetFocusManager()) { // Can be NULL in unittests.
v = owner_->GetFocusManager()->GetFocusedView();
}
// Special case to handle keyboard-triggered context menus.
if (v && v->GetEnabled() &&
((event->key_code() == ui::VKEY_APPS) ||
(event->key_code() == ui::VKEY_F10 && event->IsShiftDown()))) {
// Clamp the menu location within the visible bounds of each ancestor view
// to avoid showing the menu over a completely different view or window.
gfx::Point location = v->GetKeyboardContextMenuLocation();
for (View* parent = v->parent(); parent; parent = parent->parent()) {
const gfx::Rect& parent_bounds = parent->GetBoundsInScreen();
location.SetToMax(parent_bounds.origin());
location.SetToMin(parent_bounds.bottom_right());
}
v->ShowContextMenu(location, ui::mojom::MenuSourceType::kKeyboard);
event->StopPropagation();
}
#endif
}
std::string_view GetLogContext() const override {
return "PreEventDispatchHandler";
}
raw_ptr<View> owner_;
};
// This event handler receives events in the post-target phase and takes care of
// the following:
// - Generates context menu, or initiates drag-and-drop, from gesture events.
class PostEventDispatchHandler : public ui::EventHandler {
public:
PostEventDispatchHandler()
: touch_dnd_enabled_(::features::IsTouchDragAndDropEnabled()) {}
PostEventDispatchHandler(const PostEventDispatchHandler&) = delete;
PostEventDispatchHandler& operator=(const PostEventDispatchHandler&) = delete;
~PostEventDispatchHandler() override = default;
private:
// Overridden from ui::EventHandler:
void OnGestureEvent(ui::GestureEvent* event) override {
DCHECK_EQ(ui::EP_POSTTARGET, event->phase());
if (event->handled()) {
return;
}
View* target = static_cast<View*>(event->target());
gfx::Point location = event->location();
if (touch_dnd_enabled_ &&
event->type() == ui::EventType::kGestureLongPress &&
(!target->drag_controller() ||
target->drag_controller()->CanStartDragForView(target, location,
location))) {
if (target->DoDrag(*event, location,
ui::mojom::DragEventSource::kTouch)) {
event->StopPropagation();
return;
}
}
if (target->context_menu_controller() &&
(event->type() == ui::EventType::kGestureLongPress ||
event->type() == ui::EventType::kGestureLongTap ||
event->type() == ui::EventType::kGestureTwoFingerTap)) {
gfx::Point screen_location(location);
View::ConvertPointToScreen(target, &screen_location);
target->ShowContextMenu(screen_location,
ui::mojom::MenuSourceType::kTouch);
event->StopPropagation();
}
}
std::string_view GetLogContext() const override {
return "PostEventDispatchHandler";
}
bool touch_dnd_enabled_;
};
////////////////////////////////////////////////////////////////////////////////
// RootView, public:
// Creation and lifetime -------------------------------------------------------
RootView::RootView(Widget* widget)
: widget_(widget),
pre_dispatch_handler_(
std::make_unique<internal::PreEventDispatchHandler>(this)),
post_dispatch_handler_(
std::make_unique<internal::PostEventDispatchHandler>()) {
AddPostTargetHandler(post_dispatch_handler_.get());
SetEventTargeter(
std::unique_ptr<ViewTargeter>(new RootViewTargeter(this, this)));
auto* widget_delegate = widget->widget_delegate();
if (widget_delegate) {
if (ax::mojom::Role::kUnknown == GetViewAccessibility().GetCachedRole()) {
GetViewAccessibility().SetRole(
widget_delegate->GetAccessibleWindowRole());
UpdateAccessibleName();
}
widget_delegate->SetTitleChangedCallback(base::BindRepeating(
&RootView::UpdateAccessibleName, weak_factory_.GetWeakPtr()));
widget_delegate->SetAccessibleTitleChangedCallback(base::BindRepeating(
&RootView::UpdateAccessibleName, weak_factory_.GetWeakPtr()));
}
}
RootView::~RootView() {
// If we have children remove them explicitly so to make sure a remove
// notification is sent for each one of them.
RemoveAllChildViews();
}
// Tree operations -------------------------------------------------------------
void RootView::SetContentsView(View* contents_view) {
DCHECK(contents_view && GetWidget()->native_widget())
<< "Can't be called because the widget is not initialized or is "
"destroyed";
// The ContentsView must be set up _after_ the window is created so that its
// Widget pointer is valid.
SetUseDefaultFillLayout(true);
if (!children().empty()) {
RemoveAllChildViews();
}
AddChildViewRaw(contents_view);
}
View* RootView::GetContentsView() {
return children().empty() ? nullptr : children().front();
}
void RootView::NotifyNativeViewHierarchyChanged() {
PropagateNativeViewHierarchyChanged();
}
// Focus -----------------------------------------------------------------------
void RootView::SetFocusTraversableParent(FocusTraversable* focus_traversable) {
DCHECK(focus_traversable != this);
focus_traversable_parent_ = focus_traversable;
}
void RootView::SetFocusTraversableParentView(View* view) {
focus_traversable_parent_view_ = view;
}
// System events ---------------------------------------------------------------
void RootView::ThemeChanged() {
View::PropagateThemeChanged();
}
void RootView::ResetEventHandlers() {
explicit_mouse_handler_ = false;
mouse_pressed_handler_ = nullptr;
mouse_move_handler_ = nullptr;
gesture_handler_ = nullptr;
event_dispatch_target_ = nullptr;
old_dispatch_target_ = nullptr;
}
void RootView::DeviceScaleFactorChanged(float old_device_scale_factor,
float new_device_scale_factor) {
View::PropagateDeviceScaleFactorChanged(old_device_scale_factor,
new_device_scale_factor);
}
// Accessibility ---------------------------------------------------------------
AnnounceTextView* RootView::GetOrCreateAnnounceView() {
if (!announce_view_) {
announce_view_ = AddChildView(std::make_unique<AnnounceTextView>());
announce_view_->SetProperty(kViewIgnoredByLayoutKey, true);
}
return announce_view_.get();
}
void RootView::AnnounceTextAs(
const std::u16string& text,
ui::AXPlatformNode::AnnouncementType announcement_type) {
if (text.empty()) {
return;
}
#if BUILDFLAG(IS_MAC)
gfx::NativeViewAccessible native = GetViewAccessibility().GetNativeObject();
if (auto* ax_node = ui::AXPlatformNode::FromNativeViewAccessible(native)) {
ax_node->AnnounceTextAs(text, announcement_type);
}
#else
CHECK(GetWidget());
CHECK(GetContentsView());
GetOrCreateAnnounceView()->AnnounceTextAs(text, announcement_type);
#endif
}
View* RootView::GetAnnounceViewForTesting() {
return GetOrCreateAnnounceView();
}
////////////////////////////////////////////////////////////////////////////////
// RootView, FocusTraversable implementation:
FocusSearch* RootView::GetFocusSearch() {
return &focus_search_;
}
FocusTraversable* RootView::GetFocusTraversableParent() {
return focus_traversable_parent_;
}
View* RootView::GetFocusTraversableParentView() {
return focus_traversable_parent_view_;
}
////////////////////////////////////////////////////////////////////////////////
// RootView, ui::EventProcessor overrides:
ui::EventTarget* RootView::GetRootForEvent(ui::Event* event) {
return this;
}
ui::EventTargeter* RootView::GetDefaultEventTargeter() {
return this->GetEventTargeter();
}
void RootView::OnEventProcessingStarted(ui::Event* event) {
VLOG(5) << "RootView::OnEventProcessingStarted(" << event->ToString() << ")";
if (!event->IsGestureEvent()) {
return;
}
ui::GestureEvent* gesture_event = event->AsGestureEvent();
// Do not process ui::EventType::kGestureBegin events.
if (gesture_event->type() == ui::EventType::kGestureBegin) {
event->SetHandled();
return;
}
// Do not process ui::EventType::kGestureEnd events if they do not correspond
// to the removal of the final touch point or if no gesture handler has
// already been set.
if (gesture_event->type() == ui::EventType::kGestureEnd &&
(gesture_event->details().touch_points() > 1 || !gesture_handler_)) {
event->SetHandled();
return;
}
// Do not process subsequent gesture scroll events if no handler was set for
// a ui::EventType::kGestureScrollBegin event.
if (!gesture_handler_ &&
(gesture_event->type() == ui::EventType::kGestureScrollUpdate ||
gesture_event->type() == ui::EventType::kGestureScrollEnd ||
gesture_event->type() == ui::EventType::kScrollFlingStart)) {
event->SetHandled();
return;
}
gesture_handler_set_before_processing_ = !!gesture_handler_;
}
void RootView::OnEventProcessingFinished(ui::Event* event) {
VLOG(5) << "RootView::OnEventProcessingFinished(" << event->ToString() << ")";
// If |event| was not handled and |gesture_handler_| was not set by the
// dispatch of a previous gesture event, then no default gesture handler
// should be set prior to the next gesture event being received.
if (event->IsGestureEvent() && !event->handled() &&
!gesture_handler_set_before_processing_) {
gesture_handler_ = nullptr;
}
}
////////////////////////////////////////////////////////////////////////////////
// RootView, View overrides:
const Widget* RootView::GetWidget() const {
return widget_;
}
Widget* RootView::GetWidget() {
return const_cast<Widget*>(const_cast<const RootView*>(this)->GetWidget());
}
bool RootView::IsDrawn() const {
return GetVisible();
}
bool RootView::OnMousePressed(const ui::MouseEvent& event) {
UpdateCursor(event);
SetMouseLocationAndFlags(event);
// If mouse_pressed_handler_ is non null, we are currently processing
// a pressed -> drag -> released session. In that case we send the
// event to mouse_pressed_handler_
if (mouse_pressed_handler_) {
ui::MouseEvent mouse_pressed_event(event, static_cast<View*>(this),
mouse_pressed_handler_.get());
drag_info_.Reset();
ui::EventDispatchDetails dispatch_details =
DispatchEvent(mouse_pressed_handler_, &mouse_pressed_event);
if (dispatch_details.dispatcher_destroyed) {
return true;
}
return true;
}
DCHECK(!explicit_mouse_handler_);
// Walk up the tree from the target until we find a view that wants
// the mouse event.
for (mouse_pressed_handler_ = GetEventHandlerForPoint(event.location());
mouse_pressed_handler_ && (mouse_pressed_handler_ != this);
mouse_pressed_handler_ = mouse_pressed_handler_->parent()) {
DVLOG(1) << "OnMousePressed testing "
<< mouse_pressed_handler_->GetClassName();
DCHECK(mouse_pressed_handler_->GetEnabled());
// See if this view wants to handle the mouse press.
ui::MouseEvent mouse_pressed_event(event, static_cast<View*>(this),
mouse_pressed_handler_.get());
// Remove the double-click flag if the handler is different than the
// one which got the first click part of the double-click.
if (mouse_pressed_handler_ != last_click_handler_) {
mouse_pressed_event.SetFlags(event.flags() & ~ui::EF_IS_DOUBLE_CLICK);
}
drag_info_.Reset();
ui::EventDispatchDetails dispatch_details =
DispatchEvent(mouse_pressed_handler_, &mouse_pressed_event);
if (dispatch_details.dispatcher_destroyed) {
return mouse_pressed_event.handled();
}
// The view could have removed itself from the tree when handling
// OnMousePressed(). In this case, the removal notification will have
// reset mouse_pressed_handler_ to NULL out from under us. Detect this
// case and stop. (See comments in view.h.)
//
// NOTE: Don't return true here, because we don't want the frame to
// forward future events to us when there's no handler.
if (!mouse_pressed_handler_) {
break;
}
// If the view handled the event, leave mouse_pressed_handler_ set and
// return true, which will cause subsequent drag/release events to get
// forwarded to that view.
if (mouse_pressed_event.handled()) {
last_click_handler_ = mouse_pressed_handler_;
DVLOG(1) << "OnMousePressed handled by "
<< mouse_pressed_handler_->GetClassName();
return true;
}
}
// Reset mouse_pressed_handler_ to indicate that no processing is occurring.
mouse_pressed_handler_ = nullptr;
const bool last_click_was_handled = (last_click_handler_ != nullptr);
last_click_handler_ = nullptr;
// In the event that a double-click is not handled after traversing the
// entire hierarchy (even as a single-click when sent to a different view),
// it must be marked as handled to avoid anything happening from default
// processing if it the first click-part was handled by us.
return last_click_was_handled && (event.flags() & ui::EF_IS_DOUBLE_CLICK);
}
bool RootView::OnMouseDragged(const ui::MouseEvent& event) {
if (mouse_pressed_handler_) {
SetMouseLocationAndFlags(event);
ui::MouseEvent mouse_event(event, static_cast<View*>(this),
mouse_pressed_handler_.get());
ui::EventDispatchDetails dispatch_details =
DispatchEvent(mouse_pressed_handler_, &mouse_event);
if (dispatch_details.dispatcher_destroyed) {
return false;
}
return true;
}
return false;
}
void RootView::OnMouseReleased(const ui::MouseEvent& event) {
UpdateCursor(event);
if (mouse_pressed_handler_) {
ui::MouseEvent mouse_released(event, static_cast<View*>(this),
mouse_pressed_handler_.get());
// We allow the view to delete us from the event dispatch callback. As such,
// configure state such that we're done first, then call View.
View* mouse_pressed_handler = mouse_pressed_handler_;
// During mouse event handling, `SetMouseAndGestureHandler()` may be called
// to set the gesture handler. Therefore we should reset the gesture handler
// when mouse is released.
SetMouseAndGestureHandler(nullptr);
ui::EventDispatchDetails dispatch_details =
DispatchEvent(mouse_pressed_handler, &mouse_released);
if (dispatch_details.dispatcher_destroyed) {
return;
}
}
}
void RootView::OnMouseCaptureLost() {
if (mouse_pressed_handler_ || gesture_handler_) {
// Synthesize a release event for UpdateCursor.
if (mouse_pressed_handler_) {
gfx::Point last_point(last_mouse_event_x_, last_mouse_event_y_);
ui::MouseEvent release_event(ui::EventType::kMouseReleased, last_point,
last_point, ui::EventTimeForNow(),
last_mouse_event_flags_, 0);
UpdateCursor(release_event);
}
// We allow the view to delete us from OnMouseCaptureLost. As such,
// configure state such that we're done first, then call View.
View* mouse_pressed_handler = mouse_pressed_handler_;
View* gesture_handler = gesture_handler_;
SetMouseAndGestureHandler(nullptr);
if (mouse_pressed_handler) {
mouse_pressed_handler->OnMouseCaptureLost();
} else {
gesture_handler->OnMouseCaptureLost();
}
// WARNING: we may have been deleted.
}
}
void RootView::OnMouseMoved(const ui::MouseEvent& event) {
HandleMouseEnteredOrMoved(event);
}
void RootView::OnMouseEntered(const ui::MouseEvent& event) {
HandleMouseEnteredOrMoved(event);
}
void RootView::OnMouseExited(const ui::MouseEvent& event) {
if (mouse_move_handler_ != nullptr) {
MouseEnterExitEvent exited(event, ui::EventType::kMouseExited);
ui::EventDispatchDetails dispatch_details =
DispatchEvent(mouse_move_handler_, &exited);
if (dispatch_details.dispatcher_destroyed) {
return;
}
// The mouse_move_handler_ could have been destroyed in the context of the
// mouse exit event. b/312400341
if (!dispatch_details.target_destroyed && mouse_move_handler_) {
dispatch_details = NotifyEnterExitOfDescendant(
event, ui::EventType::kMouseExited, mouse_move_handler_, nullptr);
if (dispatch_details.dispatcher_destroyed) {
return;
}
}
mouse_move_handler_ = nullptr;
}
}
bool RootView::OnMouseWheel(const ui::MouseWheelEvent& event) {
for (View* v = GetEventHandlerForPoint(event.location());
v && v != this && !event.handled(); v = v->parent()) {
ui::EventDispatchDetails dispatch_details =
DispatchEvent(v, const_cast<ui::MouseWheelEvent*>(&event));
if (dispatch_details.dispatcher_destroyed ||
dispatch_details.target_destroyed) {
return event.handled();
}
}
return event.handled();
}
void RootView::MaybeNotifyGestureHandlerBeforeReplacement() {
#if defined(USE_AURA)
ui::GestureRecognizer* gesture_recognizer =
(gesture_handler_ && widget_ ? widget_->GetGestureRecognizer() : nullptr);
if (!gesture_recognizer) {
return;
}
ui::GestureConsumer* gesture_consumer = widget_->GetGestureConsumer();
if (!gesture_recognizer->DoesConsumerHaveActiveTouch(gesture_consumer)) {
return;
}
gesture_recognizer->SendSynthesizedEndEvents(gesture_consumer);
#endif
}
void RootView::SetMouseAndGestureHandler(View* new_handler) {
SetMouseHandler(new_handler);
if (new_handler == gesture_handler_) {
return;
}
MaybeNotifyGestureHandlerBeforeReplacement();
gesture_handler_ = new_handler;
}
void RootView::SetMouseHandler(View* new_mouse_handler) {
// If we're clearing the mouse handler, clear explicit_mouse_handler_ as well.
explicit_mouse_handler_ = (new_mouse_handler != nullptr);
mouse_pressed_handler_ = new_mouse_handler;
drag_info_.Reset();
}
void RootView::UpdateParentLayer() {
if (layer()) {
ReparentLayer(widget_->GetLayer());
}
}
void RootView::UpdateAccessibleName() {
auto* widget_delegate = GetWidget()->widget_delegate();
if (widget_delegate) {
std::u16string name = widget_delegate->GetAccessibleWindowTitle();
if (name.empty()) {
GetViewAccessibility().SetName(
std::string(), ax::mojom::NameFrom::kAttributeExplicitlyEmpty);
} else {
// TODO (crbug.com/380927771). Once VoiceOver has incorporated the name
// change event, remove below Mac specific code.
#if BUILDFLAG(IS_MAC)
if (::features::IsBlockRootWindowAccessibleNameChangeEventEnabled()) {
ScopedAccessibilityEventBlocker scoped_event_blocker(
GetViewAccessibility());
GetViewAccessibility().SetName(name);
} else {
GetViewAccessibility().SetName(name);
}
#endif
#if !BUILDFLAG(IS_MAC)
GetViewAccessibility().SetName(name);
#endif
}
}
}
void RootView::UpdateAccessibleURL(const GURL& url) {
GetViewAccessibility().SetRootViewURL(url.spec());
}
////////////////////////////////////////////////////////////////////////////////
// RootView, protected:
void RootView::ViewHierarchyChanged(
const ViewHierarchyChangedDetails& details) {
widget_->ViewHierarchyChanged(details);
if (!details.is_add && !details.move_view) {
if (mouse_pressed_handler_ == details.child) {
SetMouseHandler(nullptr);
}
if (mouse_move_handler_ == details.child) {
mouse_move_handler_ = nullptr;
}
if (gesture_handler_ == details.child) {
gesture_handler_ = nullptr;
}
if (event_dispatch_target_ == details.child) {
event_dispatch_target_ = nullptr;
}
if (old_dispatch_target_ == details.child) {
old_dispatch_target_ = nullptr;
}
}
}
void RootView::VisibilityChanged(View* /*starting_from*/, bool is_visible) {
if (!is_visible) {
// When the root view is being hidden (e.g. when widget is minimized)
// handlers are reset, so that after it is reshown, events are not captured
// by old handlers.
ResetEventHandlers();
}
}
void RootView::OnDidSchedulePaint(const gfx::Rect& rect) {
if (!layer()) {
gfx::Rect xrect = ConvertRectToParent(rect);
gfx::Rect invalid_rect = gfx::IntersectRects(GetLocalBounds(), xrect);
if (!invalid_rect.IsEmpty()) {
widget_->SchedulePaintInRect(invalid_rect);
}
}
}
void RootView::OnPaint(gfx::Canvas* canvas) {
if (!layer() || !layer()->fills_bounds_opaquely()) {
canvas->DrawColor(SK_ColorTRANSPARENT, SkBlendMode::kClear);
}
View::OnPaint(canvas);
}
View::LayerOffsetData RootView::CalculateOffsetToAncestorWithLayer(
ui::Layer** layer_parent) {
if (layer() || !widget_->GetLayer()) {
return View::CalculateOffsetToAncestorWithLayer(layer_parent);
}
if (layer_parent) {
*layer_parent = widget_->GetLayer();
}
return LayerOffsetData(widget_->GetLayer()->device_scale_factor());
}
View::DragInfo* RootView::GetDragInfo() {
return &drag_info_;
}
////////////////////////////////////////////////////////////////////////////////
// RootView, private:
void RootView::UpdateCursor(const ui::MouseEvent& event) {
if (!(event.flags() & ui::EF_IS_NON_CLIENT)) {
View* v = GetEventHandlerForPoint(event.location());
ui::MouseEvent me(event, static_cast<View*>(this), v);
widget_->SetCursor(v->GetCursor(me));
}
}
void RootView::SetMouseLocationAndFlags(const ui::MouseEvent& event) {
last_mouse_event_flags_ = event.flags();
last_mouse_event_x_ = event.x();
last_mouse_event_y_ = event.y();
}
void RootView::HandleMouseEnteredOrMoved(const ui::MouseEvent& event) {
View* v = GetEventHandlerForPoint(event.location());
// Check for a disabled move handler. If the move handler became
// disabled while handling moves, it's wrong to suddenly send
// EventType::kMouseExited and EventType::kMouseEntered events, because the
// mouse hasn't actually exited yet.
if (mouse_move_handler_ && !mouse_move_handler_->GetEnabled() &&
v->Contains(mouse_move_handler_)) {
v = mouse_move_handler_;
}
if (v && v != this) {
if (v != mouse_move_handler_) {
if (mouse_move_handler_ != nullptr &&
(!mouse_move_handler_->GetNotifyEnterExitOnChild() ||
!mouse_move_handler_->Contains(v))) {
MouseEnterExitEvent exit(event, ui::EventType::kMouseExited);
exit.ConvertLocationToTarget(static_cast<View*>(this),
mouse_move_handler_.get());
ui::EventDispatchDetails dispatch_details =
DispatchEvent(mouse_move_handler_, &exit);
if (dispatch_details.dispatcher_destroyed) {
return;
}
// The mouse_move_handler_ could have been destroyed in the context of
// the mouse exit event.
if (!dispatch_details.target_destroyed) {
// View was removed by EventType::kMouseExited, or
// |mouse_move_handler_| was cleared, perhaps by a nested event
// handler, so return and wait for the next mouse move event.
if (!mouse_move_handler_) {
return;
}
dispatch_details = NotifyEnterExitOfDescendant(
event, ui::EventType::kMouseExited, mouse_move_handler_, v);
if (dispatch_details.dispatcher_destroyed) {
return;
}
}
}
View* old_handler = mouse_move_handler_;
mouse_move_handler_ = v;
// TODO(crbug.com/40821061): This is for debug purpose only.
// Remove it after resolving the issue.
if (!mouse_move_handler_->GetNotifyEnterExitOnChild() ||
!mouse_move_handler_->Contains(old_handler)) {
MouseEnterExitEvent entered(event, ui::EventType::kMouseEntered);
entered.ConvertLocationToTarget(static_cast<View*>(this),
mouse_move_handler_.get());
ui::EventDispatchDetails dispatch_details =
DispatchEvent(mouse_move_handler_, &entered);
if (dispatch_details.dispatcher_destroyed ||
dispatch_details.target_destroyed) {
return;
}
// View was removed by EventType::kMouseEntered, or
// |mouse_move_handler_| was cleared, perhaps by a nested event handler,
// so return and wait for the next mouse move event.
if (!mouse_move_handler_) {
return;
}
dispatch_details =
NotifyEnterExitOfDescendant(event, ui::EventType::kMouseEntered,
mouse_move_handler_, old_handler);
if (dispatch_details.dispatcher_destroyed ||
dispatch_details.target_destroyed) {
return;
}
}
}
if (event.type() == ui::EventType::kMouseMoved) {
ui::MouseEvent moved_event(event, static_cast<View*>(this),
mouse_move_handler_.get());
mouse_move_handler_->OnMouseMoved(moved_event);
// TODO(tdanderson): It may be possible to avoid setting the cursor twice
// (once here and once from CompoundEventFilter) on a
// mousemove. See crbug.com/351469.
if (!(moved_event.flags() & ui::EF_IS_NON_CLIENT)) {
widget_->SetCursor(mouse_move_handler_->GetCursor(moved_event));
}
}
} else if (mouse_move_handler_ != nullptr) {
MouseEnterExitEvent exited(event, ui::EventType::kMouseExited);
ui::EventDispatchDetails dispatch_details =
DispatchEvent(mouse_move_handler_, &exited);
if (dispatch_details.dispatcher_destroyed) {
return;
}
// The mouse_move_handler_ could have been destroyed in the context of the
// mouse exit event.
if (!dispatch_details.target_destroyed) {
// View was removed by EventType::kMouseExited, or |mouse_move_handler_|
// was cleared, perhaps by a nested event handler, so return and wait for
// the next mouse move event.
if (!mouse_move_handler_) {
return;
}
dispatch_details = NotifyEnterExitOfDescendant(
event, ui::EventType::kMouseExited, mouse_move_handler_, v);
if (dispatch_details.dispatcher_destroyed) {
return;
}
}
// On Aura the non-client area extends slightly outside the root view for
// some windows. Let the non-client cursor handling code set the cursor
// as we do above.
if (!(event.flags() & ui::EF_IS_NON_CLIENT)) {
widget_->SetCursor(ui::Cursor());
}
mouse_move_handler_ = nullptr;
}
}
ui::EventDispatchDetails RootView::NotifyEnterExitOfDescendant(
const ui::MouseEvent& event,
ui::EventType type,
View* view,
View* sibling) {
for (View* p = view->parent(); p; p = p->parent()) {
if (!p->GetNotifyEnterExitOnChild()) {
continue;
}
if (sibling && p->Contains(sibling)) {
break;
}
// It is necessary to recreate the notify-event for each dispatch, since one
// of the callbacks can mark the event as handled, and that would cause
// incorrect event dispatch.
MouseEnterExitEvent notify_event(event, type);
ui::EventDispatchDetails dispatch_details = DispatchEvent(p, ¬ify_event);
if (dispatch_details.dispatcher_destroyed ||
dispatch_details.target_destroyed) {
return dispatch_details;
}
}
return ui::EventDispatchDetails();
}
bool RootView::CanDispatchToTarget(ui::EventTarget* target) {
return event_dispatch_target_ == target;
}
ui::EventDispatchDetails RootView::PreDispatchEvent(ui::EventTarget* target,
ui::Event* event) {
View* view = static_cast<View*>(target);
if (event->IsGestureEvent()) {
// Update |gesture_handler_| to indicate which View is currently handling
// gesture events.
// TODO(tdanderson): Look into moving this to PostDispatchEvent() and
// using |event_dispatch_target_| instead of
// |gesture_handler_| to detect if the view has been
// removed from the tree.
gesture_handler_ = view;
}
old_dispatch_target_ = event_dispatch_target_;
event_dispatch_target_ = view;
return DispatchDetails();
}
ui::EventDispatchDetails RootView::PostDispatchEvent(ui::EventTarget* target,
const ui::Event& event) {
// The GESTURE_END event corresponding to the removal of the final touch
// point marks the end of a gesture sequence, so reset |gesture_handler_|
// to NULL.
if (event.type() == ui::EventType::kGestureEnd) {
// In case a drag was in progress, reset all the handlers. Otherwise, just
// reset the gesture handler.
if (gesture_handler_ && gesture_handler_ == mouse_pressed_handler_) {
SetMouseAndGestureHandler(nullptr);
} else {
gesture_handler_ = nullptr;
}
}
DispatchDetails details;
if (target != event_dispatch_target_) {
details.target_destroyed = true;
}
event_dispatch_target_ = old_dispatch_target_;
old_dispatch_target_ = nullptr;
#ifndef NDEBUG
DCHECK(!event_dispatch_target_ || Contains(event_dispatch_target_));
#endif
return details;
}
BEGIN_METADATA(RootView)
END_METADATA
} // namespace views::internal
|