michael@0: /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* vim:set tw=80 expandtab softtabstop=2 ts=2 sw=2: */
michael@0: 
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
michael@0:  * You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsIDOMMozBrowserFrame.idl"
michael@0: 
michael@0: interface nsITabParent;
michael@0: 
michael@0: [scriptable, builtinclass, uuid(929AED00-3E15-49B7-8CA2-75003715B7E7)]
michael@0: interface nsIMozBrowserFrame : nsIDOMMozBrowserFrame
michael@0: {
michael@0:   /**
michael@0:    * Gets whether this frame really is a browser or app frame.
michael@0:    *
michael@0:    * In order to really be a browser frame, this frame's
michael@0:    * nsIDOMMozBrowserFrame::mozbrowser attribute must be true, and the frame
michael@0:    * may have to pass various security checks.
michael@0:    */
michael@0:   [infallible] readonly attribute boolean reallyIsBrowserOrApp;
michael@0: 
michael@0:   /**
michael@0:    * Gets whether this frame really is an app frame.
michael@0:    *
michael@0:    * In order to really be an app frame, this frame must really be a browser
michael@0:    * frame (this requirement will go away eventually), and the frame's mozapp
michael@0:    * attribute must point to the manifest of a valid app.
michael@0:    */
michael@0:   [infallible] readonly attribute boolean reallyIsApp;
michael@0: 
michael@0:   /**
michael@0:    * This corresponds to the expecting-system-message attribute, which tells us
michael@0:    * whether we should expect that this frame will receive a system message once
michael@0:    * it starts up.
michael@0:    *
michael@0:    * It's the embedder's job to set this attribute on a frame.  Its presence
michael@0:    * might cause us to increase the priority of the frame's process.
michael@0:    */
michael@0:   [infallible] readonly attribute boolean isExpectingSystemMessage;
michael@0: 
michael@0:   /**
michael@0:    * Gets this frame's app manifest URL, if the frame really is an app frame.
michael@0:    * Otherwise, returns the empty string.
michael@0:    *
michael@0:    * This method is guaranteed not to fail.
michael@0:    */
michael@0:   readonly attribute AString appManifestURL;
michael@0: 
michael@0:   /**
michael@0:    * Normally, a frame tries to create its frame loader when its src is
michael@0:    * modified, or its contentWindow is accessed.
michael@0:    *
michael@0:    * disallowCreateFrameLoader prevents the frame element from creating its
michael@0:    * frame loader (in the same way that not being inside a document prevents the
michael@0:    * creation of a frame loader).  allowCreateFrameLoader lifts this restriction.
michael@0:    *
michael@0:    * These methods are not re-entrant -- it is an error to call
michael@0:    * disallowCreateFrameLoader twice without first calling allowFrameLoader.
michael@0:    *
michael@0:    * It's also an error to call either method if we already have a frame loader.
michael@0:    */
michael@0:   void disallowCreateFrameLoader();
michael@0:   void allowCreateFrameLoader();
michael@0: 
michael@0:   /**
michael@0:    * Create a remote (i.e., out-of-process) frame loader attached to the given
michael@0:    * tab parent.
michael@0:    *
michael@0:    * It is an error to call this method if we already have a frame loader.
michael@0:    */
michael@0:   void createRemoteFrameLoader(in nsITabParent aTabParent);
michael@0: };