more linux automation porting: SendKeyPressNotifyWhenDone...

chrome/browser/automation/ui_controls.h

 // Copyright (c) 2009 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 CHROME_BROWSER_AUTOMATION_UI_CONTROLS_H_
 #define CHROME_BROWSER_AUTOMATION_UI_CONTROLS_H_
 
 #include "build/build_config.h"
 
 #include <string>
 
 #if defined(OS_WIN)
 #include <wtypes.h>
 #endif
 
 #include "base/gfx/native_widget_types.h"
 #include "base/gfx/point.h"
 
 namespace views {
 class View;
 }
 
 class Task;
 
 namespace ui_controls {
 
 // Many of the functions in this class include a variant that takes a Task.
 // The version that takes a Task waits until the generated event is processed.
-// Once the generated event is processed the Task is Run (and deleted).
+// Once the generated event is processed the Task 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 Task 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.
 
 // Send a key press with/without modifier keys.
 bool SendKeyPress(gfx::NativeWindow window, wchar_t key, bool control,
                   bool shift, bool alt);
-bool SendKeyPressNotifyWhenDone(wchar_t key, bool control, bool shift,
+bool SendKeyPressNotifyWhenDone(gfx::NativeWindow window, wchar_t key,
+                                bool control, bool shift,
                                 bool alt, Task* task);
 
 // Send a key down event. Use VK_CONTROL for ctrl key,
 // VK_MENU for alt key and VK_SHIFT for shift key.
 // Refer MSDN for more virtual key codes.
 bool SendKeyDown(wchar_t key);
 bool SendKeyUp(wchar_t key);
 
 // Simulate a mouse move. (x,y) are absolute screen coordinates.
 bool SendMouseMove(long x, long y);
@@ skipping 22 matching lines @@
 // A combination of SendMouseMove to the middle of the view followed by
 // SendMouseEvents.
 void MoveMouseToCenterAndPress(views::View* view,
                                MouseButton button,
                                int state,
                                Task* task);
 
 }  // ui_controls
 
 #endif  // CHROME_BROWSER_AUTOMATION_UI_CONTROLS_H_