mozIPlacesAutoComplete

by 2 contributors:

This interface provides some constants used by the Places AutoComplete search provider as well as methods to track opened pages for AutoComplete purposes.
1.0
28
Introduced
Gecko 1.9.2
Inherits from: nsISupports Last changed in Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

Method overview

void registerOpenPage(in nsIURI aURI);
void unregisterOpenPage(in nsIURI aURI);

Constants

Constant Value Description
MATCH_ANYWHERE 0 Match anywhere in each searchable term.
MATCH_BOUNDARY_ANYWHERE 1 Match first on word boundaries, and if we do not get enough results, then match anywhere in each searchable term.
MATCH_BOUNDARY 2 Match on word boundaries in each searchable term.
MATCH_BEGINNING 3 Match only the beginning of each search term.
BEHAVIOR_HISTORY 1 << 0 Search through history.
BEHAVIOR_BOOKMARK 1 << 1 Search though bookmarks.
BEHAVIOR_TAG 1 << 2 Search through tags.
BEHAVIOR_TITLE 1 << 3 Search the title of pages.
BEHAVIOR_URL 1 << 4 Search the URL of pages.
BEHAVIOR_TYPED 1 << 5 Search for typed pages.
BEHAVIOR_JAVASCRIPT 1 << 6 Search javascript: URLs.
BEHAVIOR_OPENPAGE 1 << 7 Search for pages that have been marked as being opened, such as a tab in a tabbrowser.

Methods

Requires Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

registerOpenPage()

Mark a page as being currently open.

Note: Pages will not be automatically unregistered when Private Browsing mode is entered or exited. Therefore, consumers must unregister or register themselves.

void registerOpenPage(
  in nsIURI aURI
);
Parameters
aURI
The URI to register as an open page.

Requires Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

unregisterOpenPage()

Mark a page as no longer being open (either by closing the window or tab, or by navigating away from that page).

Note: Pages will not be automatically unregistered when Private Browsing mode is entered or exited. Therefore, consumers must unregister or register themselves.

void unregisterOpenPage(
  in nsIURI aURI
);
Parameters
aURI
The URI to unregister as an open page.

Document Tags and Contributors

Contributors to this page: Sheppy, trevorh
Last updated by: Sheppy,