/* -*- Mode: C++; tab-width: 2; 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) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Original Author: Aaron Leventhal (aaronl@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"
#include "nsISupportsPrimitives.idl"

%{ C++
  #include "nsIDOMEvent.h"

  #define NS_TYPEAHEADFIND_CID \
    {0x46590685, 0xbc00, 0x4aac, {0xab, 0xed, 0x2c, 0x10, 0xa5, 0xb9, 0x45, 0xa4}}

  #define NS_TYPEAHEADFIND_CONTRACTID "@mozilla.org/typeaheadfind;1"
%}

interface nsIDOMEvent;

[scriptable, uuid(AD1C62CC-72F4-4c5b-BE78-503854F9E0D8)]
interface nsITypeAheadFind : nsISupports
{
  /** Is type ahead find mode currently on? */
  readonly attribute boolean isActive;

  /** Manually start type ahead find mode */
  void startNewFind(in nsIDOMWindow aWindow, in boolean aLinksOnly);

  /** Manually cancel type ahead find mode */
  void cancelFind();

  /**
    * Will find as you type start automatically if the user
    * types with the focus on page content other than a textfield or select?
    * If autostart is off, the startNewFind() method can be used to enact
    * type ahead find, as well as cmd_findTypeLinks or cmd_findTypeText.
    */
  void setAutoStart(in nsIDOMWindow aWindow, in boolean aIsAutoStartOn);
  boolean getAutoStart(in nsIDOMWindow aWindow);  

  /**
    * Find next recurrence if typeaheadfind was the last used find, 
    * as opposed to regular find. Returns false in nsISupportsPRBool if we
    * don't handle the request.
    */
  void findNext(in boolean aReverse, in nsISupportsInterfacePointer aCallerWindowSupports);

  /*
   * Go back and remove one character from find string
   * Returns true if backspace used
   */
  boolean backOneChar();
};