1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Blake Ross.
19 * Portions created by the Initial Developer are Copyright (C) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Blake Ross <blake@cs.stanford.edu> (Original Author)
24 * Masayuki Nakano <masayuki@d-toybox.com>
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * either the GNU General Public License Version 2 or later (the "GPL"), or
28 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29 * in which case the provisions of the GPL or the LGPL are applicable instead
30 * of those above. If you wish to allow use of your version of this file only
31 * under the terms of either the GPL or the LGPL, and not to allow others to
32 * use your version of this file under the terms of the MPL, indicate your
33 * decision by deleting the provisions above and replace them with the notice
34 * and other provisions required by the GPL or the LGPL. If you do not delete
35 * the provisions above, a recipient may use your version of this file under
36 * the terms of any one of the MPL, the GPL or the LGPL.
37 *
38 * ***** END LICENSE BLOCK ***** */
39
40
41 /********************************* #includes *********************************/
42
43 #include "domstubs.idl" // nsIDOMElement, nsIDOMWindow
44 #include "nsISupports.idl" // nsISupports
45
46
47 /******************************** Declarations *******************************/
48
49 interface nsIDocShell;
50
51
52 /****************************** nsTypeAheadFind ******************************/
53
54 [scriptable, uuid(0749a445-19d3-4eb9-9d66-78eca8c6f604)]
55 interface nsITypeAheadFind : nsISupports
56 {
57 /****************************** Initializer ******************************/
58
59 /* Necessary initialization that can't happen in the constructor, either
60 * because function calls here may fail, or because the docShell is
61 * required. */
62 void init(in nsIDocShell aDocShell);
63
64
65 /***************************** Core functions ****************************/
66
67 /* Find aSearchString in page. If aLinksOnly is true, only search the page's
68 * hyperlinks for the string. */
69 unsigned short find(in AString aSearchString, in boolean aLinksOnly);
70
71 /* Find another match in the page. */
72 unsigned short findAgain(in boolean findBackwards, in boolean aLinksOnly);
73
74
75 /**************************** Helper functions ***************************/
76
77 /* Change searched docShell. This happens when e.g. we use the same
78 * nsITypeAheadFind object to search different tabs. */
79 void setDocShell(in nsIDocShell aDocShell);
80
81 /* Change the look of the the "found match" selection to aToggle, and repaint
82 * the selection. */
83 void setSelectionModeAndRepaint(in short toggle);
84
85 /* Collapse the "found match" selection to its start. Because not all
86 * matches are owned by the same selection controller, this doesn't
87 * necessarily happen automatically. */
88 void collapseSelection();
89
90
91 /******************************* Attributes ******************************/
92
93 readonly attribute AString searchString;
94 // Most recent search string
95 attribute boolean caseSensitive; // Searches are case sensitive
96 readonly attribute nsIDOMElement foundLink;
97 // Most recent elem found, if a link
98 readonly attribute nsIDOMElement foundEditable;
99 // Most recent elem found, if editable
100 readonly attribute nsIDOMWindow currentWindow;
101 // Window of most recent match
102
103
104 /******************************* Constants *******************************/
105
106 /* Find return codes */
107 const unsigned short FIND_FOUND = 0;
108 // Successful find
109 const unsigned short FIND_NOTFOUND = 1;
110 // Unsuccessful find
111 const unsigned short FIND_WRAPPED = 2;
112 // Successful find, but wrapped around
113
114
115 /*************************************************************************/
116
117 };
118
119
120 /*****************************************************************************/