nsISearchEngine Interface Reference

import "nsIBrowserSearchService.idl";

List of all members.

Public Member Functions
nsISearchSubmission	getSubmission (in AString data)
void	addParam (in AString name, in AString value)
Public Attributes
const unsigned long	TYPE_MOZSEARCH = 1
const unsigned long	TYPE_SHERLOCK = 2
const unsigned long	TYPE_OPENSEARCH = 3
const unsigned long	DATA_XML = 1
const unsigned long	DATA_TEXT = 2
attribute AString	alias
attribute boolean	hidden
readonly attribute nsIURI	iconURI
readonly attribute AString	name
readonly attribute long	type
readonly attribute AString	searchForm

---

Member Function Documentation

nsISearchSubmission nsISearchEngine::getSubmission (  in AString  data  )

Gets a nsISearchSubmission object that contains information about what to send to the search engine, including the URI and postData, if applicable. Parameters: data  Data to add to the submission object. i.e. the search terms. Returns: A nsISearchSubmission object that contains information about what to send to the search engine.

void nsISearchEngine::addParam (  in AString  name, in AString  value )

Adds a parameter to the search engine's submission data. This should only be called on engine's created via addEngineWithDetails. Parameters: name  The parameter's name. Must not be null. value  The value to pass. If value is "{searchTerms}", it will be substituted with the user-entered data when retrieving the submission. Must not be null. Exceptions: NS_ERROR_FAILURE  if the search engine is read-only. NS_ERROR_INVALID_ARG  if name or value are null.

---

Member Data Documentation

const unsigned long nsISearchEngine::TYPE_MOZSEARCH = 1

Supported search engine types.

const unsigned long nsISearchEngine::TYPE_SHERLOCK = 2

const unsigned long nsISearchEngine::TYPE_OPENSEARCH = 3

const unsigned long nsISearchEngine::DATA_XML = 1

Supported search engine data types.

const unsigned long nsISearchEngine::DATA_TEXT = 2

attribute AString nsISearchEngine::alias

The shortcut alias of the engine. This is a unique identifier.

attribute boolean nsISearchEngine::hidden

Whether the engine should be hidden from the user.

readonly attribute nsIURI nsISearchEngine::iconURI

A nsIURI corresponding to the engine's icon, stored locally. May be null.

readonly attribute AString nsISearchEngine::name

The display name of the search engine. This is a unique identifier.

readonly attribute long nsISearchEngine::type

The search engine type.

readonly attribute AString nsISearchEngine::searchForm

A URL string pointing to the engine's search form.

---

The documentation for this interface was generated from the following file:

• idl/nsIBrowserSearchService.idl

---