418712 - nsIAutoCompleteInput should fire an event when a search begins

Status: RESOLVED FIXED

(Toolkit :: Autocomplete, enhancement)

Description

[Justin Dolske [:Dolske]]

Attachment: Patch v.1

Currently, nsIAutoCompleteInput fires a "searchcomplete" event when the autocomplete search has finished.

There's no corresponding event for when a search begins. I had experimented with trying intercept the beginning with oninput, oncommand, onchange, etc, but because of the way input/searches can be delayed by timers, I wasn't getting right match. And, in any case, having a onsearchbegin event is semantically clearer.

[Adding late-compat, since this changes an existing interface that an extension might implement for some reason.]

Comment 1

[:Gavin Sharp [email: [e-mail]]]

Comment on attachment 304611 [details] [diff] [review]
Patch v.1

>Index: toolkit/components/autocomplete/public/nsIAutoCompleteInput.idl

Need to bump the UUID for this interface.

>   /*
>+   * Notification that the search has started
>+   */
>+  void onSearchBegin();

>Index: toolkit/components/autocomplete/src/nsAutoCompleteController.cpp

>+  // notify the input that the search is complete
>+  mInput->OnSearchBegin();

"That the search is starting"?

Comment 2

[Justin Dolske [:Dolske]]

Attachment: Patch v.2

Review nits fixed.

a1.9? -- Small, low risk, doesn't change existing code/behavior other than to fire a new event.

This does add a new method to nsIAutoCompleteInput, so any extensions implementing it would need to add a stub interface. Doesn't seem like a very common thing for extensions to do, and the the breakage should be obvious if they do.

Comment 3

[Justin Dolske [:Dolske]]

(note that the patch is 20K, but that's because I'm modifying a bunch of existing tests to also test this new interface :-)

Comment 4

[Mike Beltzner [:beltzner, not reading bugmail]]

Comment on attachment 304618 [details] [diff] [review]
Patch v.2

a=beltzner for 1.9

Comment 5

[Justin Dolske [:Dolske]]

Checking in toolkit/components/autocomplete/public/nsIAutoCompleteInput.idl;
  new revision: 1.10; previous revision: 1.9
Checking in toolkit/components/autocomplete/src/nsAutoCompleteController.cpp;
  new revision: 1.77; previous revision: 1.76
Checking in toolkit/components/autocomplete/tests/unit/test_378079.js;
  new revision: 1.3; previous revision: 1.2
Checking in toolkit/components/autocomplete/tests/unit/test_393191.js;
  new revision: 1.2; previous revision: 1.1
Checking in toolkit/components/autocomplete/tests
  new revision: 1.2; previous revision: 1.1
Checking in toolkit/components/places/tests/unit/test_000_frecency.js;
  new revision: 1.5; previous revision: 1.4
Checking in toolkit/components/places/tests/unit/test_408221.js;
  new revision: 1.2; previous revision: 1.1
Checking in toolkit/components/places/tests/unit/test_413784.js;
  new revision: 1.3; previous revision: 1.2
Checking in toolkit/components/places/tests/unit/test_416214.js;
  new revision: 1.2; previous revision: 1.1
Checking in toolkit/components/places/tests/unit/test_frecency.js;
  new revision: 1.2; previous revision: 1.1
Checking in toolkit/components/places/tests/unit/test_history_autocomplete_tags.js;
  new revision: 1.2; previous revision: 1.1
Checking in toolkit/components/places/tests/unit/test_multi_word_search.js;
  new revision: 1.2; previous revision: 1.1
Checking in toolkit/components/satchel/src/nsFormFillController.cpp;
  new revision: 1.98; previous revision: 1.97
Checking in toolkit/content/widgets/autocomplete.xml;
  new revision: 1.118; previous revision: 1.117