123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148 |
- // Copyright 2013 The Chromium Authors. All rights reserved.
- // Use of this source code is governed by a BSD-style license that can be
- // found in the LICENSE file.
- #ifndef UI_BASE_TEST_UI_CONTROLS_H_
- #define UI_BASE_TEST_UI_CONTROLS_H_
- #include "base/callback_forward.h"
- #include "build/build_config.h"
- #include "build/chromeos_buildflags.h"
- #include "ui/events/keycodes/keyboard_codes.h"
- #include "ui/gfx/native_widget_types.h"
- namespace ui_controls {
- // A set of utility functions to generate native events in platform
- // independent way. Note that since the implementations depend on a window being
- // top level, these can only be called from test suites that are not sharded.
- // For aura tests, please look into |aura::test:EventGenerator| first. This
- // class provides a way to emulate events in synchronous way and it is often
- // easier to write tests with this class than using |ui_controls|.
- //
- // Many of the functions in this class include a variant that takes a Closure.
- // The version that takes a Closure waits until the generated event is
- // processed. Once the generated event is processed the Closure is Run (and
- // deleted). Note that this is a somewhat fragile process in that any event of
- // the correct type (key down, mouse click, etc.) will trigger the Closure to be
- // run. Hence a usage such as
- //
- // SendKeyPress(...);
- // SendKeyPressNotifyWhenDone(..., task);
- //
- // might trigger |task| early.
- //
- // Note: Windows does not currently do anything with the |window| argument for
- // these functions, so passing NULL is ok.
- // Per the above comment, these methods can only be called from non-sharded test
- // suites. This method ensures that they're not accidently called by sharded
- // tests.
- void EnableUIControls();
- #if BUILDFLAG(IS_APPLE)
- bool IsUIControlsEnabled();
- #endif
- // Send a key press with/without modifier keys.
- //
- // If you're writing a test chances are you want the variant in ui_test_utils.
- // See it for details.
- bool SendKeyPress(gfx::NativeWindow window,
- ui::KeyboardCode key,
- bool control,
- bool shift,
- bool alt,
- bool command);
- bool SendKeyPressNotifyWhenDone(gfx::NativeWindow window,
- ui::KeyboardCode key,
- bool control,
- bool shift,
- bool alt,
- bool command,
- base::OnceClosure task);
- // Simulate a mouse move.
- bool SendMouseMove(int screen_x, int screen_y);
- // Returns false on Windows if the desired position is not over a window
- // belonging to the current process.
- bool SendMouseMoveNotifyWhenDone(int screen_x,
- int screen_y,
- base::OnceClosure task);
- enum MouseButton {
- LEFT = 0,
- MIDDLE,
- RIGHT,
- };
- // Used to indicate the state of the button when generating events.
- enum MouseButtonState {
- UP = 1,
- DOWN = 2
- };
- // The keys that may be held down while generating a mouse event.
- enum AcceleratorState {
- kNoAccelerator = 0,
- kShift = 1 << 0,
- kControl = 1 << 1,
- kAlt = 1 << 2,
- kCommand = 1 << 3,
- };
- enum TouchType { PRESS = 1 << 0, RELEASE = 1 << 1, MOVE = 1 << 2 };
- // Sends a mouse down and/or up message with optional one or multiple
- // accelerator keys. The click will be sent to wherever the cursor
- // currently is, so be sure to move the cursor before calling this
- // (and be sure the cursor has arrived!).
- // |accelerator_state| is a bitmask of AcceleratorState.
- bool SendMouseEvents(MouseButton type,
- int button_state,
- int accelerator_state = kNoAccelerator);
- bool SendMouseEventsNotifyWhenDone(MouseButton type,
- int button_state,
- base::OnceClosure task,
- int accelerator_state = kNoAccelerator);
- // Same as SendMouseEvents with UP | DOWN.
- bool SendMouseClick(MouseButton type);
- #if BUILDFLAG(IS_WIN)
- // Send WM_POINTER messages to generate touch events. There is no way to detect
- // when events are received by chrome, it's up to users of this API to detect
- // when events arrive. |action| is a bitmask of the TouchType constants that
- // indicate what events are generated, |num| is the number of the touch
- // pointers, |screen_x| and |screen_y| are the screen coordinates of a touch
- // pointer.
- bool SendTouchEvents(int action, int num, int screen_x, int screen_y);
- #elif BUILDFLAG(IS_CHROMEOS)
- // Sends a TouchEvent to the window system. |action| is a bitmask of the
- // TouchType constants that indicates what events are generated, |id| identifies
- // the touch point.
- // TODO(mukai): consolidate this interface with the Windows SendTouchEvents.
- bool SendTouchEvents(int action, int id, int x, int y);
- bool SendTouchEventsNotifyWhenDone(int action,
- int id,
- int x,
- int y,
- base::OnceClosure task);
- #endif
- #if defined(USE_AURA)
- class UIControlsAura;
- void InstallUIControlsAura(UIControlsAura* instance);
- #endif
- #if BUILDFLAG(IS_APPLE)
- // Returns true when tests need to use extra Tab and Shift-Tab key events
- // to traverse to the desired item; because the application is configured to
- // traverse more elements for accessibility reasons.
- bool IsFullKeyboardAccessEnabled();
- #endif
- } // namespace ui_controls
- #endif // UI_BASE_TEST_UI_CONTROLS_H_
|