nsIAutoCompleteResult

IID:eb43e1dc-2060-4d8e-aebf-3efec4e21cf8
Inherits From:nsISupports

This interface is implemented by the following components:


Constants

Possible values for the searchResult attribute
PRUint16 RESULT_IGNORED = 1
PRUint16 RESULT_FAILURE = 2
PRUint16 RESULT_NOMATCH = 3
PRUint16 RESULT_SUCCESS = 4

Properties

readonly PRInt32 defaultIndex

Index of the default item that should be entered if none is selected

readonly AString errorDescription

A string describing the cause of a search failure

readonly PRUint32 matchCount

The number of matches

readonly PRUint16 searchResult

The result of the search

readonly AString searchString

The original search string


Methods

AString getCommentAt ( PRInt32 index ) AString getStyleAt ( PRInt32 index ) AString getValueAt ( PRInt32 index ) void removeValueAt ( PRInt32 rowIndex , PRBool removeFromDb )

AString getCommentAt ( PRInt32 index )

Get the comment of the result at the given index

Arguments:
index

AString getStyleAt ( PRInt32 index )

Get the style hint for the result at the given index

Arguments:
index

AString getValueAt ( PRInt32 index )

Get the value of the result at the given index

Arguments:
index

void removeValueAt ( PRInt32 rowIndex , PRBool removeFromDb )

Remove the value at the given index from the autocomplete results. If removeFromDb is set to true, the value should be removed from persistent storage as well.

Arguments:
rowIndex
removeFromDb

References

This interface is passed as an argument to the following methods:

nsIAutoCompleteObserver.onSearchResult, nsIAutoCompleteSearch.startSearch

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com