1
/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
3
* The contents of this file are subject to the Mozilla Public
4
* License Version 1.1 (the "License"); you may not use this file
5
* except in compliance with the License. You may obtain a copy of
6
* the License at http://www.mozilla.org/MPL/
8
* Software distributed under the License is distributed on an "AS
9
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
10
* implied. See the License for the specific language governing
11
* rights and limitations under the License.
13
* The Original Code is the Mozilla browser.
15
* The Initial Developer of the Original Code is Netscape
16
* Communications, Inc. Portions created by Netscape are
17
* Copyright (C) 1999, Mozilla. All Rights Reserved.
20
* Travis Bogard <travis@netscape.com>
21
* Viswanath Ramachandran <vishy@netscape.com>
24
#include "nsISupports.idl"
27
* The nsIDocShellLoadInfo interface defines an interface for specifying
28
* setup information used in a nsIDocShell::loadURI call.
32
interface nsIInputStream;
35
typedef long nsDocShellInfoLoadType;
37
[scriptable, uuid(4f813a88-7aca-4607-9896-d97270cdf15e)]
38
interface nsIDocShellLoadInfo : nsISupports
40
/** This is the referrer for the load. */
41
attribute nsIURI referrer;
43
/** The owner of the load, that is, the entity responsible for
44
* causing the load to occur. This should be a nsIPrincipal typically.
46
attribute nsISupports owner;
48
/** If this attribute is true and no owner is specified, copy
49
* the owner from the referring document.
51
attribute boolean inheritOwner;
53
/* these are load type enums... */
54
const long loadNormal = 0; // Normal Load
55
const long loadNormalReplace = 1; // Normal Load but replaces current history slot
56
const long loadHistory = 2; // Load from history
57
const long loadReloadNormal = 3; // Reload
58
const long loadReloadBypassCache = 4;
59
const long loadReloadBypassProxy = 5;
60
const long loadReloadBypassProxyAndCache = 6;
61
const long loadLink = 7;
62
const long loadRefresh = 8;
63
const long loadReloadCharsetChange = 9;
64
const long loadBypassHistory = 10;
66
/** Contains a load type as specified by the load* constants */
67
attribute nsDocShellInfoLoadType loadType;
69
/** SHEntry for this page */
70
attribute nsISHEntry SHEntry;
72
/** Target for load, like _content, _blank etc. */
73
attribute wstring target;
76
attribute nsIInputStream postDataStream;
78
/** Additional headers */
79
attribute nsIInputStream headersStream;
81
/** True if the referrer should be sent, false if it shouldn't be
82
* sent, even if it's available. This attribute defaults to true.
84
attribute boolean sendReferrer;