ObjFW
Public Member Functions
<OFXMLParserDelegate> Protocol Reference

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

#import <OFXMLParser.h>

Inheritance diagram for <OFXMLParserDelegate>:
<OFObject> OFXMLElementBuilder

List of all members.

Public Member Functions

(void) - parser:foundProcessingInstructions:
 This callback is called when the XML parser found processing instructions.
(void) - parser:didStartElement:withPrefix:namespace:attributes:
 This callback is called when the XML parser found the start of a new tag.
(void) - parser:didEndElement:withPrefix:namespace:
 This callback is called when the XML parser found the end of a tag.
(void) - parser:foundCharacters:
 This callback is called when the XML parser found characters.
(void) - parser:foundCDATA:
 This callback is called when the XML parser found CDATA.
(void) - parser:foundComment:
 This callback is called when the XML parser found a comment.
(OFString *) - parser:foundUnknownEntityNamed:
 This callback is called when the XML parser found an entity it doesn't know.

Detailed Description

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


Member Function Documentation

- (void) parser: (OFXMLParser *)  parser
didEndElement: (OFString *)  name
withPrefix: (OFString *)  prefix
namespace: (OFString *)  ns 
[optional]

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) parser: (OFXMLParser *)  parser
didStartElement: (OFString *)  name
withPrefix: (OFString *)  prefix
namespace: (OFString *)  ns
attributes: (OFArray *)  attributes 
[optional]

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
attributesThe attributes included in the tag which just started or nil
- (void) parser: (OFXMLParser *)  parser
foundCDATA: (OFString *)  CDATA 
[optional]

This callback is called when the XML parser found CDATA.

Parameters:
parserThe parser which found a string
CDATAThe CDATA the XML parser found
- (void) parser: (OFXMLParser *)  parser
foundCharacters: (OFString *)  characters 
[optional]

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
charactersThe characters the XML parser found
- (void) parser: (OFXMLParser *)  parser
foundComment: (OFString *)  comment 
[optional]

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) parser: (OFXMLParser *)  parser
foundProcessingInstructions: (OFString *)  pi 
[optional]

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

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

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 Properties