import FIREFOX_52_6_0esr_RELEASE from mozilla-esr52 hg repo

embedding/components/find/nsIWebBrowserFind.idl

@@ -0,0 +1,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;
+
+};