Back to index

lightning-sunbird  0.9+nobinonly
nsITypeAheadFind.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Original Author: Aaron Leventhal (aaronl@netscape.com)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 #include "domstubs.idl"
00041 #include "nsISupportsPrimitives.idl"
00042 
00043 %{ C++
00044   #include "nsIDOMEvent.h"
00045 
00046   #define NS_TYPEAHEADFIND_CID \
00047     {0x46590685, 0xbc00, 0x4aac, {0xab, 0xed, 0x2c, 0x10, 0xa5, 0xb9, 0x45, 0xa4}}
00048 
00049   #define NS_TYPEAHEADFIND_CONTRACTID "@mozilla.org/typeaheadfind;1"
00050 %}
00051 
00052 interface nsIDOMEvent;
00053 
00054 [scriptable, uuid(AD1C62CC-72F4-4c5b-BE78-503854F9E0D8)]
00055 interface nsITypeAheadFind : nsISupports
00056 {
00058   readonly attribute boolean isActive;
00059 
00061   void startNewFind(in nsIDOMWindow aWindow, in boolean aLinksOnly);
00062 
00064   void cancelFind();
00065 
00072   void setAutoStart(in nsIDOMWindow aWindow, in boolean aIsAutoStartOn);
00073   boolean getAutoStart(in nsIDOMWindow aWindow);  
00074 
00080   void findNext(in boolean aReverse, in nsISupportsInterfacePointer aCallerWindowSupports);
00081 
00082   /*
00083    * Go back and remove one character from find string
00084    * Returns true if backspace used
00085    */
00086   boolean backOneChar();
00087 };
00088