editor/idl/nsIURIRefObject.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsIURIRefObject_h__
  39 #define nsIURIRefObject_h__
  40
  41 #include "nsISupports.idl"
  42 #include "domstubs.idl"
  43
  44 interface nsIDOMNode;
  45
  46 /** A class which can represent any node which points to an
  47   * external URI, e.g. <a>, <img>, <script> etc,
  48   * and has the capability to rewrite URLs to be
  49   * relative or absolute.
  50   * Used by the editor but not dependant on it.
  51   */
  52
  53 [scriptable, uuid(2226927e-1dd2-11b2-b57f-faab47288563)]
  54
  55 interface nsIURIRefObject  : nsISupports
  56 {
  57   attribute nsIDOMNode node;
  58
  59   /**
  60    * Go back to the beginning of the attribute list.
  61    */
  62   void Reset();
  63
  64   /**
  65    * Return the next rewritable URI.
  66    */
  67   DOMString GetNextURI();
  68
  69   /**
  70    * Go back to the beginning of the attribute list
  71    *
  72    * @param aOldPat  Old pattern to be replaced, e.g. file:///a/b/
  73    * @param aNewPat  New pattern to be replaced, e.g. http://mypage.aol.com/
  74    * @param aMakeRel Rewrite links as relative vs. absolute
  75    */
  76   void RewriteAllURIs(in DOMString aOldPat, in DOMString aNewPat,
  77                       in boolean aMakeRel);
  78 };
  79
  80 #endif /* nsIURIRefObject_h__ */
  81