| /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| /* ***** BEGIN LICENSE BLOCK ***** |
| * Version: MPL 1.1/GPL 2.0/LGPL 2.1 |
| * |
| * The contents of this file are subject to the Mozilla Public License Version |
| * 1.1 (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * http://www.mozilla.org/MPL/ |
| * |
| * Software distributed under the License is distributed on an "AS IS" basis, |
| * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License |
| * for the specific language governing rights and limitations under the |
| * License. |
| * |
| * The Original Code is mozilla.org code. |
| * |
| * The Initial Developer of the Original Code is Robert Sayre. |
| * Portions created by the Initial Developer are Copyright (C) 2006 |
| * the Initial Developer. All Rights Reserved. |
| * |
| * Contributor(s): |
| * |
| * Alternatively, the contents of this file may be used under the terms of |
| * either the GNU General Public License Version 2 or later (the "GPL"), or |
| * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), |
| * in which case the provisions of the GPL or the LGPL are applicable instead |
| * of those above. If you wish to allow use of your version of this file only |
| * under the terms of either the GPL or the LGPL, and not to allow others to |
| * use your version of this file under the terms of the MPL, indicate your |
| * decision by deleting the provisions above and replace them with the notice |
| * and other provisions required by the GPL or the LGPL. If you do not delete |
| * the provisions above, a recipient may use your version of this file under |
| * the terms of any one of the MPL, the GPL or the LGPL. |
| * |
| * ***** END LICENSE BLOCK ***** */ |
| |
| #include "nsISupports.idl" |
| |
| interface nsIURI; |
| interface nsIDOMElement; |
| interface nsIDOMDocumentFragment; |
| |
| /** |
| * nsIFeedTextConstructs represent feed text fields that can contain |
| * one of text, HTML, or XHTML. Some extension elements also have "type" |
| * parameters, and this interface could be used there as well. |
| */ |
| [scriptable, uuid(fc97a2a9-d649-4494-931e-db81a156c873)] |
| interface nsIFeedTextConstruct : nsISupports |
| { |
| /** |
| * If the text construct contains (X)HTML, relative references in |
| * the content should be resolved against this base URI. |
| */ |
| attribute nsIURI base; |
| |
| /** |
| * The language of the text. For example, "en-US" for US English. |
| */ |
| attribute AString lang; |
| |
| /** |
| * One of "text", "html", or "xhtml". If the type is (x)html, a '<' |
| * character represents markup. To display that character, an escape |
| * such as < must be used. If the type is "text", the '<' |
| * character represents the character itself, and such text should |
| * not be embedded in markup without escaping it first. |
| */ |
| attribute AString type; |
| |
| /** |
| * The content of the text construct. |
| */ |
| attribute AString text; |
| |
| /** |
| * Returns the text of the text construct, with all markup stripped |
| * and all entities decoded. If the type attribute's value is "text", |
| * this function returns the value of the text attribute unchanged. |
| */ |
| AString plainText(); |
| |
| /** |
| * Return an nsIDocumentFragment containing the text and markup. |
| */ |
| nsIDOMDocumentFragment createDocumentFragment(in nsIDOMElement element); |
| }; |
| |