blob: 1185c755153ad47dd10df9f4459358ea97792370 [file] [log] [blame]
// Copyright (c) 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.
#include "ui/views/widget/root_view.h"
#include <algorithm>
#include "base/logging.h"
#include "base/message_loop/message_loop.h"
#include "ui/base/accessibility/accessible_view_state.h"
#include "ui/base/dragdrop/drag_drop_types.h"
#include "ui/compositor/layer.h"
#include "ui/events/event.h"
#include "ui/events/keycodes/keyboard_codes.h"
#include "ui/gfx/canvas.h"
#include "ui/views/focus/view_storage.h"
#include "ui/views/layout/fill_layout.h"
#include "ui/views/widget/widget.h"
#include "ui/views/widget/widget_delegate.h"
#include "ui/views/widget/widget_deletion_observer.h"
#if defined(USE_AURA)
#include "ui/base/cursor/cursor.h"
#endif
namespace views {
namespace internal {
namespace {
enum EventType {
EVENT_ENTER,
EVENT_EXIT
};
class MouseEnterExitEvent : public ui::MouseEvent {
public:
MouseEnterExitEvent(const ui::MouseEvent& event, ui::EventType type)
: ui::MouseEvent(event,
static_cast<View*>(NULL),
static_cast<View*>(NULL)) {
DCHECK(type == ui::ET_MOUSE_ENTERED ||
type == ui::ET_MOUSE_EXITED);
SetType(type);
}
virtual ~MouseEnterExitEvent() {}
};
} // namespace
// static
const char RootView::kViewClassName[] = "RootView";
////////////////////////////////////////////////////////////////////////////////
// RootView, public:
// Creation and lifetime -------------------------------------------------------
RootView::RootView(Widget* widget)
: widget_(widget),
mouse_pressed_handler_(NULL),
mouse_move_handler_(NULL),
last_click_handler_(NULL),
explicit_mouse_handler_(false),
last_mouse_event_flags_(0),
last_mouse_event_x_(-1),
last_mouse_event_y_(-1),
touch_pressed_handler_(NULL),
gesture_handler_(NULL),
scroll_gesture_handler_(NULL),
focus_search_(this, false, false),
focus_traversable_parent_(NULL),
focus_traversable_parent_view_(NULL),
event_dispatch_target_(NULL) {
}
RootView::~RootView() {
// If we have children remove them explicitly so to make sure a remove
// notification is sent for each one of them.
if (has_children())
RemoveAllChildViews(true);
}
// Tree operations -------------------------------------------------------------
void RootView::SetContentsView(View* contents_view) {
DCHECK(contents_view && GetWidget()->native_widget()) <<
"Can't be called until after the native widget is created!";
// The ContentsView must be set up _after_ the window is created so that its
// Widget pointer is valid.
SetLayoutManager(new FillLayout);
if (has_children())
RemoveAllChildViews(true);
AddChildView(contents_view);
// Force a layout now, since the attached hierarchy won't be ready for the
// containing window's bounds. Note that we call Layout directly rather than
// calling the widget's size changed handler, since the RootView's bounds may
// not have changed, which will cause the Layout not to be done otherwise.
Layout();
}
View* RootView::GetContentsView() {
return child_count() > 0 ? child_at(0) : NULL;
}
void RootView::NotifyNativeViewHierarchyChanged() {
PropagateNativeViewHierarchyChanged();
}
// Input -----------------------------------------------------------------------
void RootView::DispatchKeyEvent(ui::KeyEvent* event) {
View* v = NULL;
if (GetFocusManager()) // NULL in unittests.
v = GetFocusManager()->GetFocusedView();
// Special case to handle right-click context menus triggered by the
// keyboard.
if (v && v->enabled() && ((event->key_code() == ui::VKEY_APPS) ||
(event->key_code() == ui::VKEY_F10 && event->IsShiftDown()))) {
v->ShowContextMenu(v->GetKeyboardContextMenuLocation(),
ui::MENU_SOURCE_KEYBOARD);
event->StopPropagation();
return;
}
DispatchKeyEventStartAt(v, event);
}
void RootView::DispatchScrollEvent(ui::ScrollEvent* event) {
for (View* v = GetEventHandlerForPoint(event->location());
v && v != this && !event->stopped_propagation(); v = v->parent()) {
DispatchEventToTarget(v, event);
}
if (event->handled() || event->type() != ui::ET_SCROLL)
return;
// Convert unprocessed scroll events into mouse-wheel events.
ui::MouseWheelEvent wheel(*event);
if (OnMouseWheel(wheel))
event->SetHandled();
}
void RootView::DispatchTouchEvent(ui::TouchEvent* event) {
// TODO: this looks all wrong. On a TOUCH_PRESSED we should figure out the
// view and target that view with all touches with the same id until the
// release (or keep it if captured).
// If touch_pressed_handler_ is non null, we are currently processing
// a touch down on the screen situation. In that case we send the
// event to touch_pressed_handler_
if (touch_pressed_handler_) {
ui::TouchEvent touch_event(*event, static_cast<View*>(this),
touch_pressed_handler_);
DispatchEventToTarget(touch_pressed_handler_, &touch_event);
if (touch_event.handled())
event->SetHandled();
if (touch_event.stopped_propagation())
event->StopPropagation();
return;
}
// Walk up the tree until we find a view that wants the touch event.
for (touch_pressed_handler_ = GetEventHandlerForPoint(event->location());
touch_pressed_handler_ && (touch_pressed_handler_ != this);
touch_pressed_handler_ = touch_pressed_handler_->parent()) {
if (!touch_pressed_handler_->enabled()) {
// Disabled views eat events but are treated as not handled.
break;
}
// See if this view wants to handle the touch
ui::TouchEvent touch_event(*event, static_cast<View*>(this),
touch_pressed_handler_);
DispatchEventToTarget(touch_pressed_handler_, &touch_event);
if (touch_event.handled())
event->SetHandled();
if (touch_event.stopped_propagation())
event->StopPropagation();
// The view could have removed itself from the tree when handling
// OnTouchEvent(). So handle as per OnMousePressed. NB: we
// assume that the RootView itself cannot be so removed.
if (!touch_pressed_handler_)
break;
// The touch event wasn't processed. Go up the view hierarchy and dispatch
// the touch event.
if (!event->handled())
continue;
// If a View consumed the event, that means future touch-events should go to
// that View. If the event wasn't consumed, then reset the handler.
if (!event->stopped_propagation())
touch_pressed_handler_ = NULL;
return;
}
// Reset touch_pressed_handler_ to indicate that no processing is occurring.
touch_pressed_handler_ = NULL;
return;
}
void RootView::DispatchGestureEvent(ui::GestureEvent* event) {
if (gesture_handler_) {
// |gesture_handler_| (or |scroll_gesture_handler_|) can be deleted during
// processing.
View* handler = scroll_gesture_handler_ &&
(event->IsScrollGestureEvent() || event->IsFlingScrollEvent()) ?
scroll_gesture_handler_ : gesture_handler_;
ui::GestureEvent handler_event(*event, static_cast<View*>(this), handler);
DispatchEventToTarget(handler, &handler_event);
if (event->type() == ui::ET_GESTURE_END &&
event->details().touch_points() <= 1) {
// In case a drag was in progress, reset all the handlers. Otherwise, just
// reset the gesture handler.
if (gesture_handler_ == mouse_pressed_handler_)
SetMouseHandler(NULL);
else
gesture_handler_ = NULL;
}
if (scroll_gesture_handler_ &&
(event->type() == ui::ET_GESTURE_SCROLL_END ||
event->type() == ui::ET_SCROLL_FLING_START)) {
scroll_gesture_handler_ = NULL;
}
if (handler_event.stopped_propagation()) {
event->StopPropagation();
return;
} else if (handler_event.handled()) {
event->SetHandled();
return;
}
if (event->type() == ui::ET_GESTURE_SCROLL_BEGIN &&
!scroll_gesture_handler_) {
// Some view started processing gesture events, however it does not
// process scroll-gesture events. In such case, we allow the event to
// bubble up, and install a different scroll-gesture handler different
// from the default gesture handler.
for (scroll_gesture_handler_ = gesture_handler_->parent();
scroll_gesture_handler_ && scroll_gesture_handler_ != this;
scroll_gesture_handler_ = scroll_gesture_handler_->parent()) {
ui::GestureEvent gesture_event(*event, static_cast<View*>(this),
scroll_gesture_handler_);
DispatchEventToTarget(scroll_gesture_handler_, &gesture_event);
if (gesture_event.stopped_propagation()) {
event->StopPropagation();
return;
} else if (gesture_event.handled()) {
event->SetHandled();
return;
}
}
scroll_gesture_handler_ = NULL;
}
return;
}
// If there was no handler for a SCROLL_BEGIN event, then subsequent scroll
// events are not dispatched to any views.
switch (event->type()) {
case ui::ET_GESTURE_SCROLL_UPDATE:
case ui::ET_GESTURE_SCROLL_END:
case ui::ET_SCROLL_FLING_START:
return;
default:
break;
}
// Walk up the tree until we find a view that wants the gesture event.
for (gesture_handler_ = GetEventHandlerForPoint(event->location());
gesture_handler_ && (gesture_handler_ != this);
gesture_handler_ = gesture_handler_->parent()) {
if (!gesture_handler_->enabled()) {
// Disabled views eat events but are treated as not handled.
return;
}
// See if this view wants to handle the Gesture.
ui::GestureEvent gesture_event(*event, static_cast<View*>(this),
gesture_handler_);
DispatchEventToTarget(gesture_handler_, &gesture_event);
// The view could have removed itself from the tree when handling
// OnGestureEvent(). So handle as per OnMousePressed. NB: we
// assume that the RootView itself cannot be so removed.
if (!gesture_handler_)
return;
if (gesture_event.handled()) {
if (gesture_event.type() == ui::ET_GESTURE_SCROLL_BEGIN)
scroll_gesture_handler_ = gesture_handler_;
if (gesture_event.stopped_propagation())
event->StopPropagation();
else
event->SetHandled();
return;
}
// The gesture event wasn't processed. Go up the view hierarchy and
// dispatch the gesture event.
}
gesture_handler_ = NULL;
}
// 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::LocaleChanged() {
View::PropagateLocaleChanged();
}
////////////////////////////////////////////////////////////////////////////////
// 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, 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 visible();
}
void RootView::Layout() {
View::Layout();
widget_->OnRootViewLayout();
}
const char* RootView::GetClassName() const {
return kViewClassName;
}
void RootView::SchedulePaintInRect(const gfx::Rect& rect) {
if (layer()) {
layer()->SchedulePaint(rect);
} else {
gfx::Rect xrect = ConvertRectToParent(rect);
gfx::Rect invalid_rect = gfx::IntersectRects(GetLocalBounds(), xrect);
if (!invalid_rect.IsEmpty())
widget_->SchedulePaintInRect(invalid_rect);
}
}
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_);
drag_info_.Reset();
DispatchEventToTarget(mouse_pressed_handler_, &mouse_pressed_event);
return true;
}
DCHECK(!explicit_mouse_handler_);
bool hit_disabled_view = false;
// Walk up the tree 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();
if (!mouse_pressed_handler_->enabled()) {
// Disabled views should eat events instead of propagating them upwards.
hit_disabled_view = true;
break;
}
// See if this view wants to handle the mouse press.
ui::MouseEvent mouse_pressed_event(event, static_cast<View*>(this),
mouse_pressed_handler_);
// 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.set_flags(event.flags() & ~ui::EF_IS_DOUBLE_CLICK);
drag_info_.Reset();
{
WidgetDeletionObserver widget_deletion_observer(widget_);
DispatchEventToTarget(mouse_pressed_handler_, &mouse_pressed_event);
if (!widget_deletion_observer.IsWidgetAlive())
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_ = NULL;
// 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.
if (last_click_handler_ && (event.flags() & ui::EF_IS_DOUBLE_CLICK))
hit_disabled_view = true;
last_click_handler_ = NULL;
return hit_disabled_view;
}
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_);
DispatchEventToTarget(mouse_pressed_handler_, &mouse_event);
}
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_);
// 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_;
SetMouseHandler(NULL);
DispatchEventToTarget(mouse_pressed_handler, &mouse_released);
// WARNING: we may have been deleted.
}
}
void RootView::OnMouseCaptureLost() {
// TODO: this likely needs to reset touch handler too.
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::ET_MOUSE_RELEASED,
last_point, last_point,
last_mouse_event_flags_);
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_;
SetMouseHandler(NULL);
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) {
View* v = GetEventHandlerForPoint(event.location());
// Find the first enabled view, or the existing move handler, whichever comes
// first. The check for the existing handler is because if a view becomes
// disabled while handling moves, it's wrong to suddenly send ET_MOUSE_EXITED
// and ET_MOUSE_ENTERED events, because the mouse hasn't actually exited yet.
while (v && !v->enabled() && (v != mouse_move_handler_))
v = v->parent();
if (v && v != this) {
if (v != mouse_move_handler_) {
if (mouse_move_handler_ != NULL &&
(!mouse_move_handler_->notify_enter_exit_on_child() ||
!mouse_move_handler_->Contains(v))) {
MouseEnterExitEvent exit(event, ui::ET_MOUSE_EXITED);
DispatchEventToTarget(mouse_move_handler_, &exit);
NotifyEnterExitOfDescendant(event, ui::ET_MOUSE_EXITED,
mouse_move_handler_, v);
}
View* old_handler = mouse_move_handler_;
mouse_move_handler_ = v;
if (!mouse_move_handler_->notify_enter_exit_on_child() ||
!mouse_move_handler_->Contains(old_handler)) {
MouseEnterExitEvent entered(event, ui::ET_MOUSE_ENTERED);
entered.ConvertLocationToTarget(static_cast<View*>(this),
mouse_move_handler_);
DispatchEventToTarget(mouse_move_handler_, &entered);
NotifyEnterExitOfDescendant(entered, ui::ET_MOUSE_ENTERED, v,
old_handler);
}
}
ui::MouseEvent moved_event(event, static_cast<View*>(this),
mouse_move_handler_);
mouse_move_handler_->OnMouseMoved(moved_event);
if (!(moved_event.flags() & ui::EF_IS_NON_CLIENT))
widget_->SetCursor(mouse_move_handler_->GetCursor(moved_event));
} else if (mouse_move_handler_ != NULL) {
MouseEnterExitEvent exited(event, ui::ET_MOUSE_EXITED);
DispatchEventToTarget(mouse_move_handler_, &exited);
NotifyEnterExitOfDescendant(event, ui::ET_MOUSE_EXITED,
mouse_move_handler_, v);
// 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(gfx::kNullCursor);
mouse_move_handler_ = NULL;
}
}
void RootView::OnMouseExited(const ui::MouseEvent& event) {
if (mouse_move_handler_ != NULL) {
MouseEnterExitEvent exited(event, ui::ET_MOUSE_EXITED);
DispatchEventToTarget(mouse_move_handler_, &exited);
NotifyEnterExitOfDescendant(event, ui::ET_MOUSE_EXITED,
mouse_move_handler_, NULL);
mouse_move_handler_ = NULL;
}
}
bool RootView::OnMouseWheel(const ui::MouseWheelEvent& event) {
for (View* v = GetEventHandlerForPoint(event.location());
v && v != this && !event.handled(); v = v->parent())
DispatchEventToTarget(v, const_cast<ui::MouseWheelEvent*>(&event));
return event.handled();
}
void RootView::SetMouseHandler(View* new_mh) {
// If we're clearing the mouse handler, clear explicit_mouse_handler_ as well.
explicit_mouse_handler_ = (new_mh != NULL);
mouse_pressed_handler_ = new_mh;
gesture_handler_ = new_mh;
scroll_gesture_handler_ = new_mh;
drag_info_.Reset();
}
void RootView::GetAccessibleState(ui::AccessibleViewState* state) {
state->name = widget_->widget_delegate()->GetAccessibleWindowTitle();
state->role = widget_->widget_delegate()->GetAccessibleWindowRole();
}
void RootView::UpdateParentLayer() {
if (layer())
ReparentLayer(gfx::Vector2d(GetMirroredX(), y()), widget_->GetLayer());
}
////////////////////////////////////////////////////////////////////////////////
// RootView, protected:
void RootView::ViewHierarchyChanged(
const ViewHierarchyChangedDetails& details) {
widget_->ViewHierarchyChanged(details);
if (!details.is_add) {
if (!explicit_mouse_handler_ && mouse_pressed_handler_ == details.child)
mouse_pressed_handler_ = NULL;
if (mouse_move_handler_ == details.child)
mouse_move_handler_ = NULL;
if (touch_pressed_handler_ == details.child)
touch_pressed_handler_ = NULL;
if (gesture_handler_ == details.child)
gesture_handler_ = NULL;
if (scroll_gesture_handler_ == details.child)
scroll_gesture_handler_ = NULL;
if (event_dispatch_target_ == details.child)
event_dispatch_target_ = NULL;
}
}
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.
mouse_pressed_handler_ = NULL;
mouse_move_handler_ = NULL;
touch_pressed_handler_ = NULL;
gesture_handler_ = NULL;
scroll_gesture_handler_ = NULL;
event_dispatch_target_ = NULL;
}
}
void RootView::OnPaint(gfx::Canvas* canvas) {
if (!layer() || !layer()->fills_bounds_opaquely())
canvas->DrawColor(SK_ColorBLACK, SkXfermode::kClear_Mode);
View::OnPaint(canvas);
}
gfx::Vector2d RootView::CalculateOffsetToAncestorWithLayer(
ui::Layer** layer_parent) {
gfx::Vector2d offset(View::CalculateOffsetToAncestorWithLayer(layer_parent));
if (!layer() && layer_parent)
*layer_parent = widget_->GetLayer();
return offset;
}
View::DragInfo* RootView::GetDragInfo() {
return &drag_info_;
}
////////////////////////////////////////////////////////////////////////////////
// RootView, private:
// Input -----------------------------------------------------------------------
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::DispatchEventToTarget(View* target, ui::Event* event) {
View* old_target = event_dispatch_target_;
event_dispatch_target_ = target;
if (DispatchEvent(target, event))
event_dispatch_target_ = old_target;
}
void RootView::NotifyEnterExitOfDescendant(const ui::MouseEvent& event,
ui::EventType type,
View* view,
View* sibling) {
for (View* p = view->parent(); p; p = p->parent()) {
if (!p->notify_enter_exit_on_child())
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);
DispatchEventToTarget(p, &notify_event);
}
}
void RootView::DispatchKeyEventStartAt(View* view, ui::KeyEvent* event) {
if (event->handled() || !view)
return;
for (; view && view != this; view = view->parent()) {
DispatchEventToTarget(view, event);
// Do this check here rather than in the if as |view| may have been deleted.
if (event->handled())
return;
}
}
bool RootView::CanDispatchToTarget(ui::EventTarget* target) {
return event_dispatch_target_ == target;
}
} // namespace internal
} // namespace views