Public Member Functions

nsIAutoCompleteSimpleResult Interface Reference

This class implements nsIAutoCompleteResult and provides simple methods for setting the value and result items. More...

import "nsIAutoCompleteSimpleResult.idl";

Inheritance diagram for nsIAutoCompleteSimpleResult:
Collaboration diagram for nsIAutoCompleteSimpleResult:

List of all members.

Public Member Functions

void setSearchString (in AString aSearchString)
 A writer for the readonly attribute 'searchString' which should contain the string that the user typed.
void setErrorDescription (in AString aErrorDescription)
 A writer for the readonly attribute 'errorDescription'.
void setDefaultIndex (in long aDefaultIndex)
 A writer for the readonly attribute 'defaultIndex' which should contain the index of the list that will be selected by default (normally 0).
void setSearchResult (in unsigned short aSearchResult)
 A writer for the readonly attribute 'searchResult' which should contain one of the constants nsIAutoCompleteResult.RESULT_* indicating the success of the search.
void appendMatch (in AString aValue, in AString aComment,[optional] in AString aImage,[optional] in AString aStyle)
 Appends a result item consisting of the given value, comment, image and style.
void setListener (in nsIAutoCompleteSimpleResultListener aListener)
 Sets a listener for changes in the result.

Detailed Description

This class implements nsIAutoCompleteResult and provides simple methods for setting the value and result items.

It can be used whenever some basic auto complete results are needed that can be pre-generated and filled into an array.


Member Function Documentation

void nsIAutoCompleteSimpleResult::appendMatch ( in AString  aValue,
in AString  aComment,
[optional] in AString  aImage,
[optional] in AString  aStyle 
)

Appends a result item consisting of the given value, comment, image and style.

This is how you add results. Note: image and style are optional.

void nsIAutoCompleteSimpleResult::setDefaultIndex ( in long  aDefaultIndex  ) 

A writer for the readonly attribute 'defaultIndex' which should contain the index of the list that will be selected by default (normally 0).

void nsIAutoCompleteSimpleResult::setErrorDescription ( in AString  aErrorDescription  ) 

A writer for the readonly attribute 'errorDescription'.

void nsIAutoCompleteSimpleResult::setListener ( in nsIAutoCompleteSimpleResultListener  aListener  ) 

Sets a listener for changes in the result.

void nsIAutoCompleteSimpleResult::setSearchResult ( in unsigned short  aSearchResult  ) 

A writer for the readonly attribute 'searchResult' which should contain one of the constants nsIAutoCompleteResult.RESULT_* indicating the success of the search.

void nsIAutoCompleteSimpleResult::setSearchString ( in AString  aSearchString  ) 

A writer for the readonly attribute 'searchString' which should contain the string that the user typed.


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