1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either the GNU General Public License Version 2 or later (the "GPL"), or
26 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38 /*
39 * browser-specific interface to global history
40 */
41
42 #include "nsISupports.idl"
43 #include "nsIGlobalHistory2.idl"
44
45 [scriptable, uuid(c43079c3-3d8d-4b7c-af14-0e30ab46865f)]
46 interface nsIBrowserHistory : nsIGlobalHistory2
47 {
48 /**
49 * addPageWithDetails
50 * Adds a page to history with specific time stamp information. This is used in
51 * the History migrator.
52 */
53 void addPageWithDetails(in nsIURI aURI, in wstring aTitle, in long long aLastVisited);
54
55 /**
56 * lastPageVisited
57 * The last page that was visited in a top-level window.
58 */
59 readonly attribute AUTF8String lastPageVisited;
60
61 /**
62 * count
63 * The number of entries in global history
64 */
65 readonly attribute PRUint32 count;
66
67 /**
68 * remove a page from history
69 */
70 void removePage(in nsIURI aURI);
71
72 /**
73 * removePagesFromHost
74 * Remove all pages from the given host.
75 * If aEntireDomain is true, will assume aHost is a domain,
76 * and remove all pages from the entire domain.
77 */
78 void removePagesFromHost(in AUTF8String aHost, in boolean aEntireDomain);
79
80 /**
81 * removeAllPages
82 * Remove all pages from global history
83 */
84 void removeAllPages();
85
86 /**
87 * hidePage
88 * Hide the specified URL from being enumerated (and thus
89 * displayed in the UI)
90 *
91 * if the page hasn't been visited yet, then it will be added
92 * as if it was visited, and then marked as hidden
93 */
94 void hidePage(in nsIURI aURI);
95
96 /**
97 * This is just like markPageAsFollowedBookmark (in nsINavHistory,
98 * also implemented by the history service), but for URLs that a
99 * user visits from the chrome that are not bookmarks, such as a
100 * URL that is typed in the URL bar or clicking on a link in the
101 * history menu or history sidebar. It declares that the given URI
102 * is treated as if they typed the URL into the URL bar (which
103 * get more weight in our URL bar autocomplete algorithm.)
104 * If this URI is loaded soon after this message has been received,
105 * that transition will be marked as typed.
106 */
107 void markPageAsTyped(in nsIURI aURI);
108 };