Back to index

lightning-sunbird  0.9+nobinonly
nsISHistory.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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) 1999
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Radha Kulkarni (radha@netscape.com)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or 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 
00041 interface nsIHistoryEntry;
00042 interface nsISHistoryListener;
00043 interface nsISimpleEnumerator;
00058 %{C++
00059 #define NS_SHISTORY_CID \
00060 {0x7294fe9c, 0x14d8, 0x11d5, {0x98, 0x82, 0x00, 0xC0, 0x4f, 0xa0, 0x2f, 0x40}}
00061 
00062 #define NS_SHISTORY_CONTRACTID "@mozilla.org/browser/shistory;1"
00063 %}
00064 
00065 [scriptable, uuid(7294FE9B-14D8-11D5-9882-00C04FA02F40)]
00066 interface nsISHistory: nsISupports
00067 {
00073    readonly attribute long count;
00074 
00079    readonly attribute long index;
00080 
00086    attribute long maxLength;
00087 
00102    nsIHistoryEntry getEntryAtIndex(in long index, in boolean modifyIndex);
00103 
00104 
00121    void PurgeHistory(in long numEntries);
00122 
00136    void addSHistoryListener(in nsISHistoryListener aListener);
00137 
00150    void removeSHistoryListener(in nsISHistoryListener aListener);
00151 
00173    readonly attribute nsISimpleEnumerator SHistoryEnumerator;
00174 };