RetroZilla/embedding/components/find/public/nsIWebBrowserFind.idl
2015-10-20 23:03:22 -04:00

182 lines
5.5 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 2001
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Conrad Carlen <ccarlen@netscape.com>
* Simon Fraser <sfraser@netscape.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
#include "domstubs.idl"
/* 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.
*
* @status FROZEN
*/
[scriptable, uuid(2f977d44-5485-11d4-87e2-0010a4e75ef2)]
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.
*
* @status FROZEN
*/
[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 nsIDOMWindow 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 nsIDOMWindow 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;
};