content/base/public/nsISyncLoadDOMService.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2002
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Jonas Sicking <sicking@bigfoot.com> (Original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsIURI;
  42 interface nsIPrincipal;
  43 interface nsIDOMDocument;
  44 interface nsIChannel;
  45
  46 /*************************************************************************
  47  *                                                                       *
  48  *                          **** NOTICE ****                             *
  49  *                                                                       *
  50  *                                                                       *
  51  *    This interface is DEPRECATED!                                      *
  52  *    You should instead use XMLHttpRequest which now works both from    *
  53  *    Javascript and C++.                                                *
  54  *                                                                       *
  55  *    Additionally, synchronous network loads are evil.  Any delays      *
  56  *    from the server will appear as a hang in the mozilla UI.           *
  57  *    Therefore, they should be avoided as much as possible.             *
  58  *                                                                       *
  59  *    Don't make me come over there!!                                    *
  60  *                                                                       *
  61  *                                                                       *
  62  ************************************************************************/
  63
  64 /**
  65  * The nsISyncDOMLoadService interface can be used to synchronously load
  66  * a document.
  67  */
  68
  69 [scriptable, uuid(8095998d-ae1c-4cfa-9b43-0973e5d77eb0)]
  70 interface nsISyncLoadDOMService : nsISupports
  71 {
  72     /**
  73      * Synchronously load the document from the specified channel.
  74      *
  75      * @param aChannel   The channel to load the document from.
  76      * @param aLoaderPrincipal Principal of loading document. For security
  77      *                         checks null if no securitychecks should be done
  78      *
  79      * @returns The document loaded from the URI.
  80      */
  81     nsIDOMDocument loadDocument(in nsIChannel aChannel,
  82                                 in nsIPrincipal aLoaderPrincipal);
  83
  84     nsIDOMDocument loadDocumentAsXML(in nsIChannel aChannel,
  85                                      in nsIPrincipal aLoaderPrincipal);
  86
  87     /**
  88      * Synchronously load an XML document from the specified
  89      * channel. The channel must be possible to open synchronously.
  90      *
  91      * @param aChannel   The channel to load the document from.
  92      * @param aLoaderPrincipal Principal of loading document. For security
  93      *                         checks null if no securitychecks should be done
  94      *
  95      * @returns The document loaded from the URI.
  96      */
  97     nsIDOMDocument loadLocalDocument(in nsIChannel aChannel,
  98                                      in nsIPrincipal aLoaderPrincipal);
  99 };