/usr/share/idl/thunderbird/nsIWebBrowserFind.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 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 | /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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 "domstubs.idl"
interface mozIDOMWindowProxy;
/* THIS IS A PUBLIC EMBEDDING API */
/**
* nsIWebBrowserFind
*
* Searches for text in a web browser.
*
* Get one by doing a GetInterface on an nsIWebBrowser.
*
* By default, the implementation will search the focussed frame, or
* if there is no focussed frame, the web browser content area. It
* does not by default search subframes or iframes. To change this
* behaviour, and to explicitly set the frame to search,
* QueryInterface to nsIWebBrowserFindInFrames.
*/
[scriptable, uuid(e4920136-b3e0-49e0-b1cd-6c783d2591a8)]
interface nsIWebBrowserFind : nsISupports
{
/**
* findNext
*
* Finds, highlights, and scrolls into view the next occurrence of the
* search string, using the current search settings. Fails if the
* search string is empty.
*
* @return Whether an occurrence was found
*/
boolean findNext();
/**
* searchString
*
* The string to search for. This must be non-empty to search.
*/
attribute wstring searchString;
/**
* findBackwards
*
* Whether to find backwards (towards the beginning of the document).
* Default is false (search forward).
*/
attribute boolean findBackwards;
/**
* wrapFind
*
* Whether the search wraps around to the start (or end) of the document
* if no match was found between the current position and the end (or
* beginning). Works correctly when searching backwards. Default is
* false.
*/
attribute boolean wrapFind;
/**
* entireWord
*
* Whether to match entire words only. Default is false.
*/
attribute boolean entireWord;
/**
* matchCase
*
* Whether to match case (case sensitive) when searching. Default is false.
*/
attribute boolean matchCase;
/**
* searchFrames
*
* Whether to search through all frames in the content area. Default is true.
*
* Note that you can control whether the search propagates into child or
* parent frames explicitly using nsIWebBrowserFindInFrames, but if one,
* but not both, of searchSubframes and searchParentFrames are set, this
* returns false.
*/
attribute boolean searchFrames;
};
/**
* nsIWebBrowserFindInFrames
*
* Controls how find behaves when multiple frames or iframes are present.
*
* Get by doing a QueryInterface from nsIWebBrowserFind.
*/
[scriptable, uuid(e0f5d182-34bc-11d5-be5b-b760676c6ebc)]
interface nsIWebBrowserFindInFrames : nsISupports
{
/**
* currentSearchFrame
*
* Frame at which to start the search. Once the search is done, this will
* be set to be the last frame searched, whether or not a result was found.
* Has to be equal to or contained within the rootSearchFrame.
*/
attribute mozIDOMWindowProxy currentSearchFrame;
/**
* rootSearchFrame
*
* Frame within which to confine the search (normally the content area frame).
* Set this to only search a subtree of the frame hierarchy.
*/
attribute mozIDOMWindowProxy rootSearchFrame;
/**
* searchSubframes
*
* Whether to recurse down into subframes while searching. Default is true.
*
* Setting nsIWebBrowserfind.searchFrames to true sets this to true.
*/
attribute boolean searchSubframes;
/**
* searchParentFrames
*
* Whether to allow the search to propagate out of the currentSearchFrame into its
* parent frame(s). Search is always confined within the rootSearchFrame. Default
* is true.
*
* Setting nsIWebBrowserfind.searchFrames to true sets this to true.
*/
attribute boolean searchParentFrames;
};
|