/usr/share/idl/thunderbird/nsIAutoCompleteSimpleResult.idl is in thunderbird-dev 1:52.8.0-1~deb8u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | /* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsISupports.idl"
#include "nsIAutoCompleteResult.idl"
interface nsIAutoCompleteSimpleResultListener;
/**
* 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.
*/
[scriptable, uuid(23de9c96-becb-4d0d-a9bb-1d131ce361b5)]
interface nsIAutoCompleteSimpleResult : nsIAutoCompleteResult
{
/**
* A writer for the readonly attribute 'searchString' which should contain
* the string that the user typed.
*/
void setSearchString(in AString aSearchString);
/**
* A writer for the readonly attribute 'errorDescription'.
*/
void setErrorDescription(in AString aErrorDescription);
/**
* A writer for the readonly attribute 'defaultIndex' which should contain
* the index of the list that will be selected by default (normally 0).
*/
void setDefaultIndex(in long aDefaultIndex);
/**
* A writer for the readonly attribute 'searchResult' which should contain
* one of the constants nsIAutoCompleteResult.RESULT_* indicating the success
* of the search.
*/
void setSearchResult(in unsigned short aSearchResult);
/**
* Inserts a match consisting of the given value, comment, image, style and
* the value to use for defaultIndex completion at a given position.
* @param aIndex
* The index to insert at
* @param aValue
* The value to autocomplete to
* @param aComment
* Comment shown in the autocomplete widget to describe this match
* @param aImage
* Image shown in the autocomplete widget for this match.
* @param aStyle
* Describes how to style the match in the autocomplete widget
* @param aFinalCompleteValue
* Value used when the user confirms selecting this match. If not
* provided, aValue will be used.
*/
void insertMatchAt(in long aIndex,
in AString aValue,
in AString aComment,
[optional] in AString aImage,
[optional] in AString aStyle,
[optional] in AString aFinalCompleteValue,
[optional] in AString aLabel);
/**
* Appends a match consisting of the given value, comment, image, style and
* the value to use for defaultIndex completion.
* @param aValue
* The value to autocomplete to
* @param aComment
* Comment shown in the autocomplete widget to describe this match
* @param aImage
* Image shown in the autocomplete widget for this match.
* @param aStyle
* Describes how to style the match in the autocomplete widget
* @param aFinalCompleteValue
* Value used when the user confirms selecting this match. If not
* provided, aValue will be used.
*/
void appendMatch(in AString aValue,
in AString aComment,
[optional] in AString aImage,
[optional] in AString aStyle,
[optional] in AString aFinalCompleteValue,
[optional] in AString aLabel);
/**
* Gets the listener for changes in the result.
*/
nsIAutoCompleteSimpleResultListener getListener();
/**
* Sets a listener for changes in the result.
*/
void setListener(in nsIAutoCompleteSimpleResultListener aListener);
};
[scriptable, uuid(004efdc5-1989-4874-8a7a-345bf2fa33af)]
interface nsIAutoCompleteSimpleResultListener : nsISupports
{
/**
* Dispatched after a value is removed from the result.
* @param aResult
* The result from which aValue has been removed.
* @param aValue
* The removed value.
* @param aRemoveFromDb
* Whether the value should be removed from persistent storage as well.
*/
void onValueRemoved(in nsIAutoCompleteSimpleResult aResult, in AString aValue,
in boolean aRemoveFromDb);
};
|