Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIFragmentContentSink Class Reference

The fragment sink allows a client to parse a fragment of sink, possibly surrounded in context. More...

#include <nsIFragmentContentSink.h>

Inheritance diagram for nsIFragmentContentSink:
Inheritance graph
[legend]
Collaboration diagram for nsIFragmentContentSink:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_IMETHOD GetFragment (nsIDOMDocumentFragment **aFragment)=0
 This method is used to obtain the fragment created by a fragment content sink.
NS_IMETHOD SetTargetDocument (nsIDocument *aDocument)=0
 This method is used to set the target document for this fragment sink.
NS_IMETHOD WillBuildContent ()=0
 This method is used to indicate to the sink that we're done building the context and should start paying attention to the incoming content.
NS_IMETHOD DidBuildContent ()=0
 This method is used to indicate to the sink that we're done building The real content.
NS_IMETHOD IgnoreFirstContainer ()=0
 This method is a total hack to help with parsing fragments.

Detailed Description

The fragment sink allows a client to parse a fragment of sink, possibly surrounded in context.

Also see nsIParser::ParseFragment(). Note: once you've parsed a fragment, the fragment sink must be re-set on the parser in order to parse another fragment.

Definition at line 55 of file nsIFragmentContentSink.h.


Member Function Documentation

This method is used to indicate to the sink that we're done building The real content.

This is useful if you want to parse additional context (such as an end context).

Implemented in nsHTMLFragmentContentSink, and nsXMLFragmentContentSink.

This method is used to obtain the fragment created by a fragment content sink.

The value returned will be null if the content sink hasn't yet received parser notifications.

Implemented in nsHTMLFragmentContentSink, and nsXMLFragmentContentSink.

This method is a total hack to help with parsing fragments.

It is called to tell the fragment sink that a container from the context will be delivered after the call to WillBuildContent(). This is only relevent for HTML fragments that use nsHTMLTokenizer/CNavDTD.

Implemented in nsHTMLFragmentContentSink, and nsXMLFragmentContentSink.

This method is used to set the target document for this fragment sink.

This document's nodeinfo manager will be used to create the content objects. This MUST be called before the sink is used.

Parameters:
aDocumentthe document the new nodes will belong to (should not be null)

Implemented in nsHTMLFragmentContentSink, and nsXMLFragmentContentSink.

This method is used to indicate to the sink that we're done building the context and should start paying attention to the incoming content.

Implemented in nsHTMLFragmentContentSink, and nsXMLFragmentContentSink.


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