editor/nsIURIRefObject.idl
author Kris Maglione <maglione.k@gmail.com>
Wed, 22 Mar 2017 20:33:05 -0700
changeset 428214 c90ba1cf0de266a399896f541bb9bfb08257a4ba
parent 215305 faecfa9d0bb6c46e32934182e6154758190262ed
child 473934 96a208d3cceee2f0f0b7aac7fac3278d5a897330
permissions -rw-r--r--
Bug 1255894: Part 3 - Create skeleton IPDL framework for OOP stream filters. r=baku This interface will allow extensions running into a content process to attach a filtering stream listener to an HTTP request in the parent process. The content process attaches a listener by sending a message from the content process containing the ID of the request to filter, and the ID of the add-on making the request. The permissions and request mappings for this are handled by the web request service added in part 2. MozReview-Commit-ID: B7Dd3ywwCBX

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"
#include "domstubs.idl"

interface nsIDOMNode;

/** A class which can represent any node which points to an
  * external URI, e.g. <a>, <img>, <script> etc,
  * and has the capability to rewrite URLs to be
  * relative or absolute.
  * Used by the editor but not dependant on it.
  */

[scriptable, uuid(2226927e-1dd2-11b2-b57f-faab47288563)]

interface nsIURIRefObject  : nsISupports
{
  attribute nsIDOMNode node;

  /**
   * Go back to the beginning of the attribute list.
   */
  void Reset();

  /**
   * Return the next rewritable URI.
   */
  DOMString GetNextURI();

  /**
   * Go back to the beginning of the attribute list
   *
   * @param aOldPat  Old pattern to be replaced, e.g. file:///a/b/
   * @param aNewPat  New pattern to be replaced, e.g. http://mypage.aol.com/
   * @param aMakeRel Rewrite links as relative vs. absolute
   */
  void RewriteAllURIs(in DOMString aOldPat, in DOMString aNewPat,
                      in boolean aMakeRel);
};