WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIFeedTextConstruct

IID:fc97a2a9-d649-4494-931e-db81a156c873
Inherits From:nsISupports

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.

This interface is implemented by the following components:

Properties

nsIURI base

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

AString lang

The language of the text. For example, "en-US" for US English.

AString text

The content of the text construct.

AString 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.

Methods

nsIDOMDocumentFragment createDocumentFragment ( nsIDOMElement element ) AString plainText ( )

nsIDOMDocumentFragment createDocumentFragment ( nsIDOMElement element )

Return an nsIDocumentFragment containing the text and markup.

Arguments:
element

AString 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.

References

This interface is the type of the following properties:

nsIFeed.subtitle, nsIFeedContainer.rights, nsIFeedContainer.title, nsIFeedEntry.content, nsIFeedEntry.summary

Reference documentation is generated from Mozilla's source.