Public Member Functions | Public Attributes

nsIFeedTextConstruct Interface Reference

nsIFeedTextConstructs represent feed text fields that can contain one of text, HTML, or XHTML. More...

import "nsIFeedTextConstruct.idl";

Collaboration diagram for nsIFeedTextConstruct:

List of all members.

Public Member Functions

AString plainText ()
 Returns the text of the text construct, with all markup stripped and all entities decoded.
nsIDOMDocumentFragment createDocumentFragment (in nsIDOMElement element)
 Return an nsIDocumentFragment containing the text and markup.

Public Attributes

attribute nsIURI base
 If the text construct contains (X)HTML, relative references in the content should be resolved against this base URI.
attribute AString lang
 The language of the text.
attribute AString type
 One of "text", "html", or "xhtml".
attribute AString text
 The content of the text construct.

Detailed Description

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.


Member Function Documentation

nsIDOMDocumentFragment nsIFeedTextConstruct::createDocumentFragment ( in nsIDOMElement  element  ) 

Return an nsIDocumentFragment containing the text and markup.

AString nsIFeedTextConstruct::plainText (  ) 

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.


Member Data Documentation

If the text construct contains (X)HTML, relative references in the content should be resolved against this base URI.

attribute AString nsIFeedTextConstruct::lang

The language of the text.

For example, "en-US" for US English.

attribute AString nsIFeedTextConstruct::text

The content of the text construct.

attribute AString nsIFeedTextConstruct::type

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.


The documentation for this interface was generated from the following file: