editor/nsIURIRefObject.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7 #include "domstubs.idl"
   8
   9 webidl Node;
  10
  11 /** A class which can represent any node which points to an
  12   * external URI, e.g. <a>, <img>, <script> etc,
  13   * and has the capability to rewrite URLs to be
  14   * relative or absolute.
  15   * Used by the editor but not dependant on it.
  16   */
  17
  18 [scriptable, uuid(2226927e-1dd2-11b2-b57f-faab47288563)]
  19
  20 interface nsIURIRefObject  : nsISupports
  21 {
  22   attribute Node node;
  23
  24   /**
  25    * Go back to the beginning of the attribute list.
  26    */
  27   void Reset();
  28
  29   /**
  30    * Return the next rewritable URI.
  31    */
  32   DOMString GetNextURI();
  33
  34   /**
  35    * Go back to the beginning of the attribute list
  36    *
  37    * @param aOldPat  Old pattern to be replaced, e.g. file:///a/b/
  38    * @param aNewPat  New pattern to be replaced, e.g. http://mypage.aol.com/
  39    * @param aMakeRel Rewrite links as relative vs. absolute
  40    */
  41   void RewriteAllURIs(in DOMString aOldPat, in DOMString aNewPat,
  42                       in boolean aMakeRel);
  43 };