Back to index

lightning-sunbird  0.9+nobinonly
nsISHistoryInternal.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 #include "nsIFactory.idl"
00041 #include "nsISHEntry.idl"
00042 #include "nsISHTransaction.idl"
00043 
00044 interface nsISHistoryListener;
00045 interface nsIDocShell;
00046 
00047 %{C++
00048 #define NS_SHISTORY_INTERNAL_CID \
00049 {0x5b4cba4c, 0xbf67, 0x499a, {0xae, 0x2c, 0x3f, 0x76, 0x65, 0x6f, 0x4a, 0x4e}}
00050 
00051 #define NS_SHISTORY_INTERNAL_CONTRACTID "@mozilla.org/browser/shistory-internal;1"
00052 %}
00053 
00054 [scriptable, uuid(494fac3c-64f4-41b8-b209-b4ada899613b)]
00055 interface nsISHistoryInternal: nsISupports
00056 {
00064    void  addEntry(in nsISHEntry aEntry, in boolean aPersist);
00065 
00069    readonly attribute nsISHTransaction rootTransaction;
00070 
00074    attribute nsIDocShell rootDocShell;
00075 
00079    void updateIndex();
00080 
00086    void replaceEntry(in long aIndex, in nsISHEntry aReplaceEntry);
00087 
00091    readonly attribute nsISHistoryListener listener;
00092 
00100    void evictContentViewers(in long previousIndex, in long index);
00101 
00108    readonly attribute long historyMaxTotalViewers;
00109 };