1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* 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 the Mozilla browser.
*
* The Initial Developer of the Original Code is Netscape
* Communications, Inc. Portions created by Netscape are
* Copyright (C) 1999, Mozilla. All Rights Reserved.
*
* Contributor(s):
* Travis Bogard <travis@netscape.com>
*/
#include "nsISupports.idl"
/**
* The nsIWebNavigation interface defines an interface for navigating the web.
* It provides methods and attributes to direct an object to navigate to a new
* location, stop or restart an in process load or determine where the object,
* has previously gone.
*
* @status UNDER_REVIEW
*/
interface nsIDOMDocument;
interface nsIInputStream;
interface nsISHistory;
interface nsISHEntry;
interface nsIURI;
[scriptable, uuid(F5D9E7B0-D930-11d3-B057-00A024FFC08C)]
interface nsIWebNavigation : nsISupports
{
/**
* Indicates if the object can go back. If true this indicates that
* there is back session history available for navigation.
*/
readonly attribute boolean canGoBack;
/**
* Indicates if the object can go forward. If true this indicates that
* there is forward session history available for navigation
*/
readonly attribute boolean canGoForward;
/**
* Tells the object to navigate to the previous session history item. When
* a page is loaded from session history, all content is loaded from the
* cache (if available) and page state (such as form values, scroll position)
* is restored.
*
* @return NS_OK - Backward navigation was successful.
* NS_ERROR_UNEXPECTED - This call was unexpected at this time. Most
* likely you can't go back right now.
*/
void goBack();
/**
* Tells the object to navigate to the next Forward session history item.
* When a page is loaded from session history, all content is loaded from
* the cache (if available) and page state (such as form values, scroll
* position) is restored.
*
* @return NS_OK - Forward was successful.
* NS_ERROR_UNEXPECTED - This call was unexpected at this time. Most
* likely you can't go forward right now.
*/
void goForward();
/**
* Tells the object to navigate to the session history item at index.
*
* @return NS_OK - GotoIndex was successful.
* NS_ERROR_UNEXPECTED - This call was unexpected at this time. Most
* likely you can't goto that index
*/
void gotoIndex(in long index);
/**
* Load flags for use with loadURI() and reload()
*/
const unsigned long LOAD_FLAGS_MASK = 0xffff;
/**
* loadURI() specific flags
*/
/**
* Normal load flag.
*/
const unsigned long LOAD_FLAGS_NONE = 0x0000;
/**
* Meta-refresh flag. The cache is bypassed. This type of load is
* usually the result of a meta-refresh tag, or a HTTP
* 'refresh' header.
*/
const unsigned long LOAD_FLAGS_IS_REFRESH = 0x0010;
/**
* Link-click flag.
*/
const unsigned long LOAD_FLAGS_IS_LINK = 0x0020;
/**
* Bypass history flag.
*/
const unsigned long LOAD_FLAGS_BYPASS_HISTORY = 0x0040;
/**
* Replace history entry flag.
*/
const unsigned long LOAD_FLAGS_REPLACE_HISTORY = 0x0080;
/* loadURI() & reload() specific flags */
const unsigned long LOAD_FLAGS_BYPASS_CACHE = 0x0100; // Bypass the cache
const unsigned long LOAD_FLAGS_BYPASS_PROXY = 0x0200; // Bypass the proxy
const unsigned long LOAD_FLAGS_CHARSET_CHANGE = 0x0400; // Reload because of charset change,
/**
* A hint this load was prompted by an external program: take care!
*/
const unsigned long LOAD_FLAGS_FROM_EXTERNAL = 0x1000;
/**
* Loads a given URI. This will give priority to loading the requested URI
* in the object implementing this interface. If it can't be loaded here
* however, the URL dispatcher will go through its normal process of content
* loading.
*
* @param uri - The URI string to load.
* @param loadFlags - Flags modifying load behaviour. Generally you will pass
* LOAD_FLAGS_NONE for this parameter.
* @param referrer - The referring URI. If this argument is NULL, the
* referring URI will be inferred internally.
* @param postData - nsIInputStream containing POST data for the request.
*/
void loadURI(in wstring uri,
in unsigned long loadFlags,
in nsIURI referrer,
in nsIInputStream postData,
in nsIInputStream headers);
/**
* Tells the Object to reload the current page.
*
* @param reloadFlags - Flags modifying reload behaviour. Generally you will
* pass LOAD_FLAGS_NONE for this parameter.
*/
void reload(in unsigned long reloadFlags);
/**
* Stop() flags:
*/
/**
* Stop all network activity. This includes both active network loads and
* pending meta-refreshes.
*/
const unsigned long STOP_NETWORK = 0x01;
/**
* Stop all content activity. This includes animated images, plugins and
* pending Javascript timeouts.
*/
const unsigned long STOP_CONTENT = 0x02;
/**
* Stop all activity.
*/
const unsigned long STOP_ALL = 0x03;
/**
* Stops a load of a URI.
*
* @param stopFlags - Flags indicating the stop behavior.
*/
void stop(in unsigned long stopFlags);
/**
* Retrieves the current DOM document for the frame, or lazily creates a
* blank document if there is none. This attribute never returns null except
* for unexpected error situations.
*/
readonly attribute nsIDOMDocument document;
/**
* The currently loaded URI or null.
*/
readonly attribute nsIURI currentURI;
/**
* The referring URI.
*/
readonly attribute nsIURI referringURI;
/**
* The session history object used to store the session history for the
* session.
*/
attribute nsISHistory sessionHistory;
};
|
