blob: 51fcf0e53ec38addf307ee4f3420c276def2d02e [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/wm/core/compound_event_filter.h"
#include "base/macros.h"
#include "build/build_config.h"
#include "ui/aura/client/cursor_client.h"
#include "ui/aura/env.h"
#include "ui/aura/test/aura_test_base.h"
#include "ui/aura/test/test_cursor_client.h"
#include "ui/aura/test/test_windows.h"
#include "ui/aura/window.h"
#include "ui/aura/window_event_dispatcher.h"
#include "ui/events/event.h"
#include "ui/events/event_utils.h"
#include "ui/events/keycodes/dom/dom_code.h"
#include "ui/events/test/event_generator.h"
#include "ui/wm/public/activation_client.h"
namespace {
#if defined(OS_CHROMEOS) || defined(OS_WIN)
base::TimeTicks GetTime() {
return ui::EventTimeForNow();
}
#endif // defined(OS_CHROMEOS) || defined(OS_WIN)
}
namespace wm {
namespace {
// An event filter that consumes all gesture events.
class ConsumeGestureEventFilter : public ui::EventHandler {
public:
ConsumeGestureEventFilter() {}
~ConsumeGestureEventFilter() override {}
private:
// Overridden from ui::EventHandler:
void OnGestureEvent(ui::GestureEvent* e) override { e->StopPropagation(); }
DISALLOW_COPY_AND_ASSIGN(ConsumeGestureEventFilter);
};
} // namespace
typedef aura::test::AuraTestBase CompoundEventFilterTest;
#if defined(OS_CHROMEOS)
// A keypress only hides the cursor on ChromeOS (crbug.com/304296).
TEST_F(CompoundEventFilterTest, CursorVisibilityChange) {
std::unique_ptr<CompoundEventFilter> compound_filter(new CompoundEventFilter);
aura::Env::GetInstance()->AddPreTargetHandler(compound_filter.get());
aura::test::TestWindowDelegate delegate;
std::unique_ptr<aura::Window> window(CreateTestWindowWithDelegate(
&delegate, 1234, gfx::Rect(5, 5, 100, 100), root_window()));
window->Show();
window->SetCapture();
aura::test::TestCursorClient cursor_client(root_window());
// Send key event to hide the cursor.
ui::KeyEvent key('a', ui::VKEY_A, ui::DomCode::NONE, ui::EF_NONE);
DispatchEventUsingWindowDispatcher(&key);
EXPECT_FALSE(cursor_client.IsCursorVisible());
// Synthesized mouse event should not show the cursor.
ui::MouseEvent enter(ui::ET_MOUSE_ENTERED, gfx::Point(10, 10),
gfx::Point(10, 10), ui::EventTimeForNow(), 0, 0);
enter.set_flags(enter.flags() | ui::EF_IS_SYNTHESIZED);
DispatchEventUsingWindowDispatcher(&enter);
EXPECT_FALSE(cursor_client.IsCursorVisible());
ui::MouseEvent move(ui::ET_MOUSE_MOVED, gfx::Point(10, 10),
gfx::Point(10, 10), ui::EventTimeForNow(), 0, 0);
move.set_flags(enter.flags() | ui::EF_IS_SYNTHESIZED);
DispatchEventUsingWindowDispatcher(&move);
EXPECT_FALSE(cursor_client.IsCursorVisible());
// A real mouse event should show the cursor.
ui::MouseEvent real_move(ui::ET_MOUSE_MOVED, gfx::Point(10, 10),
gfx::Point(10, 10), ui::EventTimeForNow(), 0, 0);
DispatchEventUsingWindowDispatcher(&real_move);
EXPECT_TRUE(cursor_client.IsCursorVisible());
// Disallow hiding the cursor on keypress.
cursor_client.set_should_hide_cursor_on_key_event(false);
key = ui::KeyEvent('a', ui::VKEY_A, ui::DomCode::NONE, ui::EF_NONE);
DispatchEventUsingWindowDispatcher(&key);
EXPECT_TRUE(cursor_client.IsCursorVisible());
// Allow hiding the cursor on keypress.
cursor_client.set_should_hide_cursor_on_key_event(true);
key = ui::KeyEvent('a', ui::VKEY_A, ui::DomCode::NONE, ui::EF_NONE);
DispatchEventUsingWindowDispatcher(&key);
EXPECT_FALSE(cursor_client.IsCursorVisible());
// Mouse synthesized exit event should not show the cursor.
ui::MouseEvent exit(ui::ET_MOUSE_EXITED, gfx::Point(10, 10),
gfx::Point(10, 10), ui::EventTimeForNow(), 0, 0);
exit.set_flags(enter.flags() | ui::EF_IS_SYNTHESIZED);
DispatchEventUsingWindowDispatcher(&exit);
EXPECT_FALSE(cursor_client.IsCursorVisible());
aura::Env::GetInstance()->RemovePreTargetHandler(compound_filter.get());
}
#endif // defined(OS_CHROMEOS)
#if defined(OS_CHROMEOS) || defined(OS_WIN)
// Touch visually hides the cursor on ChromeOS and Windows.
TEST_F(CompoundEventFilterTest, TouchHidesCursor) {
std::unique_ptr<CompoundEventFilter> compound_filter(new CompoundEventFilter);
aura::Env::GetInstance()->AddPreTargetHandler(compound_filter.get());
aura::test::TestWindowDelegate delegate;
std::unique_ptr<aura::Window> window(CreateTestWindowWithDelegate(
&delegate, 1234, gfx::Rect(5, 5, 100, 100), root_window()));
window->Show();
window->SetCapture();
aura::test::TestCursorClient cursor_client(root_window());
ui::MouseEvent mouse0(ui::ET_MOUSE_MOVED, gfx::Point(10, 10),
gfx::Point(10, 10), ui::EventTimeForNow(), 0, 0);
DispatchEventUsingWindowDispatcher(&mouse0);
EXPECT_TRUE(cursor_client.IsMouseEventsEnabled());
EXPECT_TRUE(cursor_client.IsCursorVisible());
// This press is required for the GestureRecognizer to associate a target
// with kTouchId
ui::TouchEvent press0(ui::ET_TOUCH_PRESSED, gfx::Point(90, 90), GetTime(),
ui::PointerDetails(ui::EventPointerType::kTouch, 1));
DispatchEventUsingWindowDispatcher(&press0);
EXPECT_FALSE(cursor_client.IsMouseEventsEnabled());
EXPECT_FALSE(cursor_client.IsCursorVisible());
ui::TouchEvent move(ui::ET_TOUCH_MOVED, gfx::Point(10, 10), GetTime(),
ui::PointerDetails(ui::EventPointerType::kTouch, 1));
DispatchEventUsingWindowDispatcher(&move);
EXPECT_FALSE(cursor_client.IsMouseEventsEnabled());
EXPECT_FALSE(cursor_client.IsCursorVisible());
ui::TouchEvent release(ui::ET_TOUCH_RELEASED, gfx::Point(10, 10), GetTime(),
ui::PointerDetails(ui::EventPointerType::kTouch, 1));
DispatchEventUsingWindowDispatcher(&release);
EXPECT_FALSE(cursor_client.IsMouseEventsEnabled());
EXPECT_FALSE(cursor_client.IsCursorVisible());
ui::MouseEvent mouse1(ui::ET_MOUSE_MOVED, gfx::Point(10, 10),
gfx::Point(10, 10), ui::EventTimeForNow(), 0, 0);
// Move the cursor again. The cursor should be visible.
DispatchEventUsingWindowDispatcher(&mouse1);
EXPECT_TRUE(cursor_client.IsMouseEventsEnabled());
EXPECT_TRUE(cursor_client.IsCursorVisible());
// Now activate the window and press on it again.
ui::TouchEvent press1(ui::ET_TOUCH_PRESSED, gfx::Point(90, 90), GetTime(),
ui::PointerDetails(ui::EventPointerType::kTouch, 1));
GetActivationClient(root_window())->ActivateWindow(window.get());
DispatchEventUsingWindowDispatcher(&press1);
EXPECT_FALSE(cursor_client.IsMouseEventsEnabled());
EXPECT_FALSE(cursor_client.IsCursorVisible());
aura::Env::GetInstance()->RemovePreTargetHandler(compound_filter.get());
}
#endif // defined(OS_CHROMEOS) || defined(OS_WIN)
// Tests that if an event filter consumes a gesture, then it doesn't focus the
// window.
TEST_F(CompoundEventFilterTest, FilterConsumedGesture) {
std::unique_ptr<CompoundEventFilter> compound_filter(new CompoundEventFilter);
std::unique_ptr<ui::EventHandler> gesure_handler(
new ConsumeGestureEventFilter);
compound_filter->AddHandler(gesure_handler.get());
aura::Env::GetInstance()->AddPreTargetHandler(compound_filter.get());
aura::test::TestWindowDelegate delegate;
DCHECK(root_window());
std::unique_ptr<aura::Window> window(CreateTestWindowWithDelegate(
&delegate, 1234, gfx::Rect(5, 5, 100, 100), root_window()));
window->Show();
EXPECT_TRUE(window->CanFocus());
EXPECT_FALSE(window->HasFocus());
// Tap on the window should not focus it since the filter will be consuming
// the gestures.
ui::test::EventGenerator generator(root_window(), gfx::Point(50, 50));
generator.PressTouch();
EXPECT_FALSE(window->HasFocus());
compound_filter->RemoveHandler(gesure_handler.get());
aura::Env::GetInstance()->RemovePreTargetHandler(compound_filter.get());
}
// Verifies we don't attempt to hide the mouse when the mouse is down and a
// touch event comes in.
TEST_F(CompoundEventFilterTest, DontHideWhenMouseDown) {
ui::test::EventGenerator event_generator(root_window());
std::unique_ptr<CompoundEventFilter> compound_filter(new CompoundEventFilter);
aura::Env::GetInstance()->AddPreTargetHandler(compound_filter.get());
aura::test::TestWindowDelegate delegate;
std::unique_ptr<aura::Window> window(CreateTestWindowWithDelegate(
&delegate, 1234, gfx::Rect(5, 5, 100, 100), root_window()));
window->Show();
aura::test::TestCursorClient cursor_client(root_window());
// Move and press the mouse over the window.
event_generator.MoveMouseTo(10, 10);
EXPECT_TRUE(cursor_client.IsMouseEventsEnabled());
event_generator.PressLeftButton();
EXPECT_TRUE(cursor_client.IsMouseEventsEnabled());
EXPECT_TRUE(aura::Env::GetInstance()->IsMouseButtonDown());
// Do a touch event. As the mouse button is down this should not disable mouse
// events.
event_generator.PressTouch();
EXPECT_TRUE(cursor_client.IsMouseEventsEnabled());
aura::Env::GetInstance()->RemovePreTargetHandler(compound_filter.get());
}
#if defined(OS_WIN)
// Windows synthesizes mouse messages for touch events. We should not be
// showing the cursor when we receive such messages.
TEST_F(CompoundEventFilterTest, DontShowCursorOnMouseMovesFromTouch) {
std::unique_ptr<CompoundEventFilter> compound_filter(new CompoundEventFilter);
aura::Env::GetInstance()->AddPreTargetHandler(compound_filter.get());
aura::test::TestWindowDelegate delegate;
std::unique_ptr<aura::Window> window(CreateTestWindowWithDelegate(
&delegate, 1234, gfx::Rect(5, 5, 100, 100), root_window()));
window->Show();
window->SetCapture();
aura::test::TestCursorClient cursor_client(root_window());
cursor_client.DisableMouseEvents();
EXPECT_FALSE(cursor_client.IsMouseEventsEnabled());
ui::MouseEvent mouse0(ui::ET_MOUSE_MOVED, gfx::Point(10, 10),
gfx::Point(10, 10), ui::EventTimeForNow(), 0, 0);
mouse0.set_flags(mouse0.flags() | ui::EF_FROM_TOUCH);
DispatchEventUsingWindowDispatcher(&mouse0);
EXPECT_FALSE(cursor_client.IsMouseEventsEnabled());
mouse0.set_flags(mouse0.flags() & ~ui::EF_FROM_TOUCH);
DispatchEventUsingWindowDispatcher(&mouse0);
EXPECT_TRUE(cursor_client.IsMouseEventsEnabled());
aura::Env::GetInstance()->RemovePreTargetHandler(compound_filter.get());
}
#endif
} // namespace wm