nsIWebBrowserFind.idl
上传用户:goldcmy89
上传日期:2017-12-03
资源大小:2246k
文件大小:6k
源码类别:

PlugIns编程

开发平台:

Visual C++

  1. /* -*- Mode: IDL; tab-width: 4; 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.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 2001
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   Conrad Carlen <ccarlen@netscape.com>
  24.  *   Simon Fraser <sfraser@netscape.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. #include "nsISupports.idl"
  41. #include "domstubs.idl"
  42. /* THIS IS A PUBLIC EMBEDDING API */
  43. /**
  44.  * nsIWebBrowserFind
  45.  *
  46.  * Searches for text in a web browser.
  47.  *
  48.  * Get one by doing a GetInterface on an nsIWebBrowser.
  49.  *
  50.  * By default, the implementation will search the focussed frame, or
  51.  * if there is no focussed frame, the web browser content area. It
  52.  * does not by default search subframes or iframes. To change this
  53.  * behaviour, and to explicitly set the frame to search, 
  54.  * QueryInterface to nsIWebBrowserFindInFrames.
  55.  *
  56.  * @status FROZEN
  57.  */
  58. [scriptable, uuid(2f977d44-5485-11d4-87e2-0010a4e75ef2)]
  59. interface nsIWebBrowserFind : nsISupports
  60. {
  61.     /**
  62.      * findNext
  63.      *
  64.      * Finds, highlights, and scrolls into view the next occurrence of the
  65.      * search string, using the current search settings. Fails if the
  66.      * search string is empty.
  67.      *
  68.      * @return  Whether an occurrence was found
  69.      */
  70. boolean findNext();
  71.     /**
  72.      * searchString
  73.      *
  74.      * The string to search for. This must be non-empty to search.
  75.      */
  76.     attribute wstring searchString;
  77.     
  78.     /**
  79.      * findBackwards
  80.      *
  81.      * Whether to find backwards (towards the beginning of the document).
  82.      * Default is false (search forward).
  83.      */
  84.     attribute boolean findBackwards;
  85.     /**
  86.      * wrapFind
  87.      *
  88.      * Whether the search wraps around to the start (or end) of the document
  89.      * if no match was found between the current position and the end (or
  90.      * beginning). Works correctly when searching backwards. Default is
  91.      * false.
  92.      */
  93.     attribute boolean wrapFind;
  94.     /**
  95.      * entireWord
  96.      *
  97.      * Whether to match entire words only. Default is false.
  98.      */
  99.     attribute boolean entireWord;
  100.     /**
  101.      * matchCase
  102.      *
  103.      * Whether to match case (case sensitive) when searching. Default is false.
  104.      */
  105.     attribute boolean matchCase;
  106.     /**
  107.      * searchFrames
  108.      *
  109.      * Whether to search through all frames in the content area. Default is true.
  110.      * 
  111.      * Note that you can control whether the search propagates into child or
  112.      * parent frames explicitly using nsIWebBrowserFindInFrames, but if one,
  113.      * but not both, of searchSubframes and searchParentFrames are set, this
  114.      * returns false.
  115.      */
  116.     attribute boolean searchFrames;
  117. };
  118. /**
  119.  * nsIWebBrowserFindInFrames
  120.  *
  121.  * Controls how find behaves when multiple frames or iframes are present.
  122.  *
  123.  * Get by doing a QueryInterface from nsIWebBrowserFind.
  124.  *
  125.  * @status FROZEN
  126.  */
  127.  
  128. [scriptable, uuid(e0f5d182-34bc-11d5-be5b-b760676c6ebc)]
  129. interface nsIWebBrowserFindInFrames : nsISupports
  130. {
  131.     /**
  132.      * currentSearchFrame
  133.      *
  134.      * Frame at which to start the search. Once the search is done, this will
  135.      * be set to be the last frame searched, whether or not a result was found.
  136.      * Has to be equal to or contained within the rootSearchFrame.
  137.      */
  138.     attribute nsIDOMWindow  currentSearchFrame;
  139.     /**
  140.      * rootSearchFrame
  141.      *
  142.      * Frame within which to confine the search (normally the content area frame).
  143.      * Set this to only search a subtree of the frame hierarchy.
  144.      */
  145.     attribute nsIDOMWindow  rootSearchFrame;
  146.         
  147.     /**
  148.      * searchSubframes
  149.      *
  150.      * Whether to recurse down into subframes while searching. Default is true.
  151.      *
  152.      * Setting nsIWebBrowserfind.searchFrames to true sets this to true.
  153.      */
  154.     attribute boolean searchSubframes;
  155.     
  156.     /**
  157.      * searchParentFrames
  158.      *
  159.      * Whether to allow the search to propagate out of the currentSearchFrame into its
  160.      * parent frame(s). Search is always confined within the rootSearchFrame. Default
  161.      * is true.
  162.      *
  163.      * Setting nsIWebBrowserfind.searchFrames to true sets this to true.
  164.      */
  165.     attribute boolean searchParentFrames;
  166. };