docshell/base/nsIDocShellLoadInfo.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Mozilla browser.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications, Inc.
  20  * Portions created by the Initial Developer are Copyright (C) 1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Travis Bogard <travis@netscape.com>
  25  *   Viswanath Ramachandran <vishy@netscape.com>
  26  *
  27  * Alternatively, the contents of this file may be used under the terms of
  28  * either of the GNU General Public License Version 2 or later (the "GPL"),
  29  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30  * in which case the provisions of the GPL or the LGPL are applicable instead
  31  * of those above. If you wish to allow use of your version of this file only
  32  * under the terms of either the GPL or the LGPL, and not to allow others to
  33  * use your version of this file under the terms of the MPL, indicate your
  34  * decision by deleting the provisions above and replace them with the notice
  35  * and other provisions required by the GPL or the LGPL. If you do not delete
  36  * the provisions above, a recipient may use your version of this file under
  37  * the terms of any one of the MPL, the GPL or the LGPL.
  38  *
  39  * ***** END LICENSE BLOCK ***** */
  40
  41 #include "nsISupports.idl"
  42
  43 /**
  44  * The nsIDocShellLoadInfo interface defines an interface for specifying
  45  * setup information used in a nsIDocShell::loadURI call.
  46  */
  47
  48 interface nsIURI;
  49 interface nsIInputStream;
  50 interface nsISHEntry;
  51
  52 typedef long nsDocShellInfoLoadType;
  53
  54 [scriptable, uuid(92a0a637-373e-4647-9476-ead11e005c75)]
  55 interface nsIDocShellLoadInfo : nsISupports
  56 {
  57     /** This is the referrer for the load. */
  58     attribute nsIURI referrer;
  59
  60     /** The owner of the load, that is, the entity responsible for
  61      *  causing the load to occur. This should be a nsIPrincipal typically.
  62      */
  63     attribute nsISupports owner;
  64
  65     /** If this attribute is true and no owner is specified, copy
  66      *  the owner from the referring document.
  67      */
  68     attribute boolean inheritOwner;
  69
  70     /** If this attribute is true only ever use the owner specify by
  71      *  the owner and inheritOwner attributes.
  72      *  If there are security reasons for why this is unsafe, such
  73      *  as trying to use a systemprincipal owner for a content docshell
  74      *  the load fails.
  75      */
  76     attribute boolean ownerIsExplicit;
  77
  78     /* these are load type enums... */
  79     const long loadNormal = 0;                     // Normal Load
  80     const long loadNormalReplace = 1;              // Normal Load but replaces current history slot
  81     const long loadHistory = 2;                    // Load from history
  82     const long loadReloadNormal = 3;               // Reload
  83     const long loadReloadBypassCache = 4;
  84     const long loadReloadBypassProxy = 5;
  85     const long loadReloadBypassProxyAndCache = 6;
  86     const long loadLink = 7;
  87     const long loadRefresh = 8;
  88     const long loadReloadCharsetChange = 9;
  89     const long loadBypassHistory = 10;
  90     const long loadStopContent = 11;
  91     const long loadStopContentAndReplace = 12;
  92     const long loadNormalExternal = 13;
  93     const long loadNormalBypassCache = 14;
  94     const long loadNormalBypassProxy = 15;
  95     const long loadNormalBypassProxyAndCache = 16;
  96
  97     /** Contains a load type as specified by the load* constants */
  98     attribute nsDocShellInfoLoadType loadType;
  99
 100     /** SHEntry for this page */
 101     attribute nsISHEntry SHEntry;
 102
 103     /** Target for load, like _content, _blank etc. */
 104     attribute wstring target;
 105
 106     /** Post data */
 107     attribute nsIInputStream postDataStream;
 108
 109     /** Additional headers */
 110     attribute nsIInputStream headersStream;
 111
 112     /** True if the referrer should be sent, false if it shouldn't be
 113      *  sent, even if it's available. This attribute defaults to true.
 114      */
 115     attribute boolean sendReferrer;
 116 };