gecko-dev/docshell/base/nsIDocShell.idl

123 lines
3.5 KiB
Plaintext

/* -*- 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>
* Steve Clark <buster@netscape.com>
*/
#include "nsISupports.idl"
#include "domstubs.idl"
#include "nsIPref.idl"
%{ C++
#include "nsIPresContext.h"
%}
/**
* The nsIDocShell
*/
/*
{69E5DE00-7B8B-11d3-AF61-00A024FFC08C} -
{69E5DE99-7B8B-11d3-AF61-00A024FFC08C} have been reserved for DocShell
Interfaces.
Currently Used:
{69E5DE00-7B8B-11d3-AF61-00A024FFC08C} - nsIDocShell
{69E5DE01-7B8B-11d3-AF61-00A024FFC08C} - nsIDocShellFile
{69E5DE02-7B8B-11d3-AF61-00A024FFC08C} - nsIDocShellEdit
{69E5DE03-7B8B-11d3-AF61-00A024FFC08C} - nsIHTMLDocShell
{69E5DE04-7B8B-11d3-AF61-00A024FFC08C} - nsIDocShellContainer
*/
[ptr] native nsIPresContext(nsIPresContext);
[scriptable, uuid(69E5DE00-7B8B-11d3-AF61-00A024FFC08C)]
interface nsIDocShell : nsISupports
{
/*
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 to load.
*/
void LoadURI(in wstring uri);
/*
Loads a given URI through the specified adapter. 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 to load.
@param adapterBinding - The local IP address of the adapter to bind to.
*/
void LoadURIVia(in wstring uri, in unsigned long adapterBinding);
/*
The current document that is loaded in the DocShell. When setting this it
will will simulate the normal load process.
*/
attribute nsIDOMDocument document;
/*
name of the DocShell
*/
attribute wstring name;
/*
Presentation context
*/
attribute nsIPresContext presContext;
/*
Parent DocShell
*/
attribute nsIDocShell parent;
/*
Returns true if the given docshell can handle the requested content type.
*/
boolean canHandleContentType(in wstring contentType);
/*
Prefs to use for the DocShell.
*/
attribute nsIPref prefs;
/*
Returns the root DocShell instance. Since DocShells can be nested
(when frames are present for example) this instance represents the
outermost DocShell.
*/
readonly attribute nsIDocShell rootDocShell;
/**
* Set/Get the document scale factor. When setting this attribute, a
* NS_ERROR_NOT_IMPLEMENTED error may be returned by implementations
* not supporting zoom. Implementations not supporting zoom should return
* 1.0 all the time for the Get operation. 1.0 by the way is the default
* of zoom. This means 100% of normal scaling or in other words normal size
* no zoom.
*/
attribute float zoom;
};