721512 - Widgets: Use EventUtils sendChar() and sendKey(), instead of calling synthesizeKey() directly

Status: RESOLVED FIXED

(Toolkit :: UI Widgets, defect)

Description

[Karun Dambiec]

Referencing bug Bug 720087, Use EventUtils sendChar() and sendKey(), instead of calling synthesizeKey() directly.

Comment 1

[Mario Alvarado [:marioalv]]

Hi everyone.
I'm going to work on this bug.

I've been checking the code to be changed and spotted some replacement scenarios.
Also, I noticed that the function EventUtils.sendKey used in bugs related to this one takes only two parameters.
I'm using this bug as an example: https://bugzilla.mozilla.org/show_bug.cgi?id=721495

Here's the patch:
https://bugzilla.mozilla.org/attachment.cgi?id=591941&action=diff

Where is this EventUtils.sendKey definition?
Is it this one? http://mxr.mozilla.org/mozilla-central/source/testing/mochitest/tests/SimpleTest/EventUtils.js#116 

These are the replacement scenarios, according to the examples:
1.
{ synthesizeKey("VK_DOWN", { }); },

converts to:
{ sendKey("DOWN"); },


2. 
synthesizeKey("VK_RETURN", { }, win);

converts to:
{ sendKey("RETURN", win); },

3. 
{ synthesizeKey("V", { altKey: true }); },

converts to? I suppose the function stays the same.

4.
{ synthesizeKey("V", { altKey: true }, win); },

converts to? I suppose the function stays the same.

I was curious about why we are using that function definition with two parameters, which will prevent us to change scenarios 3 and 4.

Thanks.

Comment 2

[Mario Alvarado [:marioalv]]

Attachment: First patch to replace synthesizeKey() calls for sendKey() and sendChar()

This is my first approach to solve this bug. 
I changed the calls to synthesizeKey() for calls to sendKey() and sendChar() where possible. 
Please let me know if some corrections need to be made.
Thanks.

Comment 3

[Philip Chee]

Hi! I don't think Serge isn't a toolkit peer. This page has a list of toolkit peers you could use: https://wiki.mozilla.org/Modules/Toolkit

Comment 4

[Neil Deakin]

> +  test: function() { sendChar("H");; },

This line has two semicolons. Remove one of them.

In all the cases where sendChar is called, you should call it with the lowercase letter for the key. For example use sendChar("h") which sends the 'h' key instead of sendChar("H") which sends shift+h and could have otherwise lead to subtly differently behaviour.

Comment 5

[Mario Alvarado [:marioalv]]

Attachment: Patch to replace synthesizeKey() calls for sendKey() and sendChar()

Hi.
Thanks for your review. 
I've made the changes you suggested. Please let me know if I need to change something else.

Thanks.

Comment 6

[Andres Hernandez [:andreshm]]

Pushed to try: https://tbpl.mozilla.org/?tree=Try&rev=0cfbf095c737

Comment 7

[Mario Alvarado [:marioalv]]

All try tests passed: https://tbpl.mozilla.org/?tree=Try&rev=0cfbf095c737 .

Comment 8

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/ab8ef7a28e2e

Comment 9

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/ab8ef7a28e2e