toolkit/components/feeds/public/nsIScriptableUnescapeHTML.idl

   1 /* -*- Mode: C++; tab-width: 8; 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 Robert Sayre.
  18  * Portions created by the Initial Developer are Copyright (C) 2006
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #include "nsISupports.idl"
  38
  39 interface nsIDOMElement;
  40 interface nsIDOMDocumentFragment;
  41 interface nsIURI;
  42
  43 /**
  44  * A utility class that unescapes HTML strings.
  45  */
  46 [scriptable, uuid(3ab244a9-f09d-44da-9e3f-ee4d67367f2d)]
  47 interface nsIScriptableUnescapeHTML : nsISupports
  48 {
  49   /**
  50    * Converts all entities to Unicode.
  51    *
  52    * @param src The HTML string to escape.
  53    */
  54   AString unescape(in AString src);
  55
  56   /**
  57    * Appends the text to the element.
  58    */
  59   nsIDOMDocumentFragment parseFragment(in AString fragment,
  60                                        in PRBool isXML,
  61                                        in nsIURI baseURI,
  62                                        in nsIDOMElement element);
  63 };