Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
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:
Inheritance graph
[legend]
Collaboration diagram for nsIAutoCompleteSimpleResult:
Collaboration graph
[legend]

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)
 Appends a result item consisting of the given value and comment.
AString getValueAt (in long index)
 Get the value of the result at the given index.
AString getCommentAt (in long index)
 Get the comment of the result at the given index.
AString getStyleAt (in long index)
 Get the style hint for the result at the given index.
void removeValueAt (in long rowIndex, in boolean removeFromDb)
 Remove the value at the given index from the autocomplete results.

Public Attributes

const unsigned short RESULT_IGNORED = 1
 Possible values for the searchResult attribute.
const unsigned short RESULT_FAILURE = 2
const unsigned short RESULT_NOMATCH = 3
const unsigned short RESULT_SUCCESS = 4
readonly attribute AString searchString
 The original search string.
readonly attribute unsigned short searchResult
 The result of the search.
readonly attribute long defaultIndex
 Index of the default item that should be entered if none is selected.
readonly attribute AString errorDescription
 A string describing the cause of a search failure.
readonly attribute unsigned long matchCount
 The number of matches.

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.

Definition at line 49 of file nsIAutoCompleteSimpleResult.idl.


Member Function Documentation

void nsIAutoCompleteSimpleResult::appendMatch ( in AString  aValue,
in AString  aComment 
)

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

This is how you add results.

AString nsIAutoCompleteResult::getCommentAt ( in long  index) [inherited]

Get the comment of the result at the given index.

AString nsIAutoCompleteResult::getStyleAt ( in long  index) [inherited]

Get the style hint for the result at the given index.

AString nsIAutoCompleteResult::getValueAt ( in long  index) [inherited]

Get the value of the result at the given index.

void nsIAutoCompleteResult::removeValueAt ( in long  rowIndex,
in boolean  removeFromDb 
) [inherited]

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.

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

A writer for the readonly attribute 'errorDescription'.

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.

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


Member Data Documentation

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

Definition at line 64 of file nsIAutoCompleteResult.idl.

readonly attribute AString nsIAutoCompleteResult::errorDescription [inherited]

A string describing the cause of a search failure.

Definition at line 69 of file nsIAutoCompleteResult.idl.

readonly attribute unsigned long nsIAutoCompleteResult::matchCount [inherited]

The number of matches.

Definition at line 74 of file nsIAutoCompleteResult.idl.

const unsigned short nsIAutoCompleteResult::RESULT_FAILURE = 2 [inherited]

Definition at line 47 of file nsIAutoCompleteResult.idl.

const unsigned short nsIAutoCompleteResult::RESULT_IGNORED = 1 [inherited]

Possible values for the searchResult attribute.

Definition at line 46 of file nsIAutoCompleteResult.idl.

const unsigned short nsIAutoCompleteResult::RESULT_NOMATCH = 3 [inherited]

Definition at line 48 of file nsIAutoCompleteResult.idl.

const unsigned short nsIAutoCompleteResult::RESULT_SUCCESS = 4 [inherited]

Definition at line 49 of file nsIAutoCompleteResult.idl.

readonly attribute unsigned short nsIAutoCompleteResult::searchResult [inherited]

The result of the search.

Definition at line 59 of file nsIAutoCompleteResult.idl.

readonly attribute AString nsIAutoCompleteResult::searchString [inherited]

The original search string.

Definition at line 54 of file nsIAutoCompleteResult.idl.


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