Struct xpcom::interfaces::nsISAXContentHandler
[−]
[src]
#[repr(C)]pub struct nsISAXContentHandler { /* fields omitted */ }
interface nsISAXContentHandler : nsISupports
/**
* Receive notification of the logical content of a document.
*
* This is the main interface that most SAX applications implement: if
* the application needs to be informed of basic parsing events, it
* implements this interface and registers an instance with the SAX
* parser. The parser uses the instance to report basic
* document-related events like the start and end of elements and
* character data.
*
* The order of events in this interface is very important, and
* mirrors the order of information in the document itself. For
* example, all of an element's content (character data, processing
* instructions, and/or subelements) will appear, in order, between
* the startElement event and the corresponding endElement event.
*/
Methods
impl nsISAXContentHandler
[src]
pub fn coerce<T: nsISAXContentHandlerCoerce>(&self) -> &T
[src]
Cast this nsISAXContentHandler
to one of its base interfaces.
impl nsISAXContentHandler
[src]
pub unsafe fn StartDocument(&self) -> nsresult
[src]
/**
* Receive notification of the beginning of a document.
*
* The SAX parser will invoke this method only once, before any
* other event callbacks.
*/
void startDocument ();
pub unsafe fn EndDocument(&self) -> nsresult
[src]
/**
* Receive notification of the end of a document.
*
* There is an apparent contradiction between the documentation for
* this method and the documentation for ErrorHandler.fatalError().
* Until this ambiguity is resolved in a future major release,
* clients should make no assumptions about whether endDocument()
* will or will not be invoked when the parser has reported a
* fatalError() or thrown an exception.
*
* The SAX parser will invoke this method only once, and it will be
* the last method invoked during the parse. The parser shall not
* invoke this method until it has either abandoned parsing (because
* of an unrecoverable error) or reached the end of input.
*/
void endDocument ();
pub unsafe fn StartElement(
&self,
uri: &nsAString,
localName: &nsAString,
qName: &nsAString,
attributes: *const nsISAXAttributes
) -> nsresult
[src]
&self,
uri: &nsAString,
localName: &nsAString,
qName: &nsAString,
attributes: *const nsISAXAttributes
) -> nsresult
/**
* Receive notification of the beginning of an element.
*
* The Parser will invoke this method at the beginning of every
* element in the XML document; there will be a corresponding
* endElement event for every startElement event (even when the
* element is empty). All of the element's content will be reported,
* in order, before the corresponding endElement event.
*
* This event allows up to three name components for each element:
*
* 1.) the Namespace URI;
* 2.) the local name; and
* 3.) the qualified (prefixed) name.
*
* Any or all of these may be provided, depending on the values of
* the http://xml.org/sax/features/namespaces and the
* http://xml.org/sax/features/namespace-prefixes properties:
*
* The Namespace URI and local name are required when the namespaces
* property is true (the default), and are optional when the
* namespaces property is false (if one is specified, both must be);
*
* The qualified name is required when the namespace-prefixes
* property is true, and is optional when the namespace-prefixes
* property is false (the default).
*
* Note that the attribute list provided will contain only
* attributes with explicit values (specified or defaulted):
* #IMPLIED attributes will be omitted. The attribute list will
* contain attributes used for Namespace declarations (xmlns*
* attributes) only if the
* http://xml.org/sax/features/namespace-prefixes property is true
* (it is false by default, and support for a true value is
* optional).
*
* @param uri the Namespace URI, or the empty string if the
* element has no Namespace URI or if Namespace
* processing is not being performed
* @param localName the local name (without prefix), or the
* empty string if Namespace processing is not being
* performed
* @param qName the qualified name (with prefix), or the
* empty string if qualified names are not available
* @param atts the attributes attached to the element. If
* there are no attributes, it shall be an empty
* SAXAttributes object. The value of this object after
* startElement returns is undefined
*/
void startElement (in AString uri, in AString localName, in AString qName, in nsISAXAttributes attributes);
pub unsafe fn EndElement(
&self,
uri: &nsAString,
localName: &nsAString,
qName: &nsAString
) -> nsresult
[src]
&self,
uri: &nsAString,
localName: &nsAString,
qName: &nsAString
) -> nsresult
/**
* Receive notification of the end of an element.
*
* The SAX parser will invoke this method at the end of every
* element in the XML document; there will be a corresponding
* startElement event for every endElement event (even when the
* element is empty).
*
* For information on the names, see startElement.
*
* @param uri the Namespace URI, or the empty string if the
* element has no Namespace URI or if Namespace
* processing is not being performed
* @param localName the local name (without prefix), or the
* empty string if Namespace processing is not being
* performed
* @param qName the qualified XML name (with prefix), or the
* empty string if qualified names are not available
*/
void endElement (in AString uri, in AString localName, in AString qName);
pub unsafe fn Characters(&self, value: &nsAString) -> nsresult
[src]
/**
* Receive notification of character data.
*
* The Parser will call this method to report each chunk of
* character data. SAX parsers may return all contiguous character
* data in a single chunk, or they may split it into several chunks;
* however, all of the characters in any single event must come from
* the same external entity so that the Locator provides useful
* information.
*
* Note that some parsers would report whitespace in element
* content using the ignorableWhitespace method rather than this one
* (validating parsers must do so). But this interface no longer has an
* ignorableWhitespace method, so in that case such whitespace is not
* reported at all.
*
* @param value the characters from the XML document
*/
void characters (in AString value);
pub unsafe fn ProcessingInstruction(
&self,
target: &nsAString,
data: &nsAString
) -> nsresult
[src]
&self,
target: &nsAString,
data: &nsAString
) -> nsresult
/**
* Receive notification of a processing instruction.
*
* The Parser will invoke this method once for each processing
* instruction found: note that processing instructions may occur
* before or after the main document element.
*
* A SAX parser must never report an XML declaration (XML 1.0,
* section 2.8) or a text declaration (XML 1.0, section 4.3.1) using
* this method.
*
* @param target the processing instruction target
* @param data the processing instruction data, or null if
* none was supplied. The data does not include any
* whitespace separating it from the target
*/
void processingInstruction (in AString target, in AString data);
Methods from Deref<Target = nsISupports>
pub fn coerce<T: nsISupportsCoerce>(&self) -> &T
[src]
Cast this nsISupports
to one of its base interfaces.
pub unsafe fn QueryInterface(
&self,
uuid: &nsIID,
result: *mut *mut c_void
) -> nsresult
[src]
&self,
uuid: &nsIID,
result: *mut *mut c_void
) -> nsresult
void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);
pub unsafe fn AddRef(&self) -> nsrefcnt
[src]
[noscript,notxpcom] nsrefcnt AddRef ();
pub unsafe fn Release(&self) -> nsrefcnt
[src]
[noscript,notxpcom] nsrefcnt Release ();
Trait Implementations
impl XpCom for nsISAXContentHandler
[src]
const IID: nsIID
IID: nsIID = nsID(714721111, 57326, 18438, [191, 243, 247, 33, 68, 4, 18, 224])
fn query_interface<T: XpCom>(&self) -> Option<RefPtr<T>>
[src]
Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more
impl RefCounted for nsISAXContentHandler
[src]
unsafe fn addref(&self)
[src]
Increment the reference count.
unsafe fn release(&self)
[src]
Decrement the reference count, potentially freeing backing memory.
impl Deref for nsISAXContentHandler
[src]
type Target = nsISupports
The resulting type after dereferencing.
fn deref(&self) -> &nsISupports
[src]
Dereferences the value.