pjs/docshell/base/nsIDocShellLoadInfo.idl

/* -*- 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>
 *   Viswanath Ramachandran <vishy@netscape.com>
 */

#include "nsISupports.idl"
#include "domstubs.idl"

/**
 * The nsIDocShellLoadInfo interface defines an interface for specifying
 * setup information used in a nsIDocShell::loadURI call.
 */
 
interface nsIURI;
interface nsISHEntry;

typedef long nsDocShellInfoLoadType;

[scriptable, uuid(33636F98-0635-11d4-9877-00C04FA0D27A)]
interface nsIDocShellLoadInfo : nsISupports
{
	/*
		This is the referrer for the load.
	*/
	attribute nsIURI referrer;

    /*
      The owner of the load, that is, the entity responsible for 
      causing the load to occur. This should be a nsIPrincipal typically.
    */
    attribute nsISupports owner;

    /*
      If this attribute is true and no owner is specified, copy the owner from
      the referring document. 
    */
    attribute boolean inheritOwner;

    attribute boolean stopActiveDocument;

    /* these are load type enums... */
   const long loadNormal = 0;					// Normal Load
   const long loadNormalReplace = 1;			// Normal Load but replaces current history slot
   const long loadHistory = 2;					// Load from history
   const long loadReloadNormal = 3;				// Reload
   const long loadReloadBypassCache = 4;
   const long loadReloadBypassProxy = 5;
   const long loadReloadBypassProxyAndCache = 6;
   const long loadLink = 7;
   const long loadRefresh = 8;

   attribute nsDocShellInfoLoadType loadType;

	/*
	   SHEntry for this page
	 */
	 attribute nsISHEntry SHEntry;

  attribute string target; // like _content, _blank etc
};