/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Netscape 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/NPL/
 *
 * 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 
 * Blake Ross.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 * Original Author:  Blake Ross      (blake@cs.stanford.edu)
 * Contributors:    
 *
 *
 * 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 NPL, 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 NPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"
#include "domstubs.idl"
#include "nsISupportsPrimitives.idl"

interface nsIDocShell;

[scriptable, uuid(1a834a64-3b06-4b75-b05b-96ca4e35a2a1)]
interface nsITypeAheadFind : nsISupports
{
  void init(in nsIDocShell aDocShell);

  const unsigned short FIND_FOUND    = 0;
  const unsigned short FIND_NOTFOUND = 1;
  const unsigned short FIND_WRAPPED  = 2;

  unsigned short find(in AString aSearchString, in boolean aLinksOnly);
  unsigned short findNext();
  unsigned short findPrevious();

  void setDocShell(in nsIDocShell aDocShell);

  readonly attribute AString searchString;
  attribute boolean focusLinks;
  attribute boolean caseSensitive;
};