ObjFW
Public Member Functions
<OFXMLParserDelegate> Protocol Reference

A protocol that needs to be implemented by delegates for OFXMLParser. More...

#include <OFXMLParser.h>

Inheritance diagram for <OFXMLParserDelegate>:
<OFObject>

List of all members.

Public Member Functions

void parser:foundProcessingInstructions: (OFXMLParser *parser,[foundProcessingInstructions] OFString *pi)
void parser:didStartElement:withPrefix:namespace:attributes: (OFXMLParser *parser,[didStartElement] OFString *name,[withPrefix] OFString *prefix,[namespace] OFString *ns,[attributes] OFArray *attrs)
void parser:didEndElement:withPrefix:namespace: (OFXMLParser *parser,[didEndElement] OFString *name,[withPrefix] OFString *prefix,[namespace] OFString *ns)
void parser:foundCharacters: (OFXMLParser *parser,[foundCharacters] OFString *string)
void parser:foundCDATA: (OFXMLParser *parser,[foundCDATA] OFString *cdata)
void parser:foundComment: (OFXMLParser *parser,[foundComment] OFString *comment)
OFStringparser:foundUnknownEntityNamed: (OFXMLParser *parser,[foundUnknownEntityNamed] OFString *entity)

Detailed Description

A protocol that needs to be implemented by delegates for OFXMLParser.


Member Function Documentation

void OFXMLParserDelegate-p::parser:didEndElement:withPrefix:namespace: ( OFXMLParser parser,
[didEndElement] OFString name,
[withPrefix] OFString prefix,
[namespace] OFString ns 
) [optional, virtual]

This callback is called when the XML parser found the end of a tag.

Parameters:
parserThe parser which found the end of a tag
nameThe name of the tag which just ended
prefixThe prefix of the tag which just ended or nil
nsThe namespace of the tag which just ended or nil
void OFXMLParserDelegate-p::parser:didStartElement:withPrefix:namespace:attributes: ( OFXMLParser parser,
[didStartElement] OFString name,
[withPrefix] OFString prefix,
[namespace] OFString ns,
[attributes] OFArray attrs 
) [optional, virtual]

This callback is called when the XML parser found the start of a new tag.

Parameters:
parserThe parser which found a new tag
nameThe name of the tag which just started
prefixThe prefix of the tag which just started or nil
nsThe namespace of the tag which just started or nil
attrsThe attributes included in the tag which just started or nil
void OFXMLParserDelegate-p::parser:foundCDATA: ( OFXMLParser parser,
[foundCDATA] OFString cdata 
) [optional, virtual]

This callback is called when the XML parser found CDATA.

Parameters:
parserThe parser which found a string
cdataThe CDATA the XML parser found
void OFXMLParserDelegate-p::parser:foundCharacters: ( OFXMLParser parser,
[foundCharacters] OFString string 
) [optional, virtual]

This callback is called when the XML parser found characters.

In case there are comments or CDATA, it is possible that this callback is called multiple times in a row.

Parameters:
parserThe parser which found a string
stringThe string the XML parser found
void OFXMLParserDelegate-p::parser:foundComment: ( OFXMLParser parser,
[foundComment] OFString comment 
) [optional, virtual]

This callback is called when the XML parser found a comment.

Parameters:
parserThe parser which found a comment
commentThe comment the XML parser found
void OFXMLParserDelegate-p::parser:foundProcessingInstructions: ( OFXMLParser parser,
[foundProcessingInstructions] OFString pi 
) [optional, virtual]

This callback is called when the XML parser found processing instructions.

Parameters:
parserThe parser which found processing instructions
piThe processing instructions
OFString* OFXMLParserDelegate-p::parser:foundUnknownEntityNamed: ( OFXMLParser parser,
[foundUnknownEntityNamed] OFString entity 
) [optional, virtual]

This callback is called when the XML parser found an entity it doesn't know. The callback is supposed to return a substitution for the entity or nil if it is not known to the callback as well, in which case an exception will be risen.

Parameters:
parserThe parser which found an unknown entity
entityThe name of the entity the XML parser didn't know
Returns:
A substitution for the entity or nil

The documentation for this protocol was generated from the following file:
 All Classes Functions Variables