XspfExtensionReader Class Reference

#include <XspfExtensionReader.h>

Inheritance diagram for XspfExtensionReader:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 XspfExtensionReader (XspfReader *reader)
 XspfExtensionReader (XspfExtensionReader const &source)
XspfExtensionReaderoperator= (XspfExtensionReader const &source)
virtual ~XspfExtensionReader ()

Protected Member Functions

bool handleError (int code, XML_Char const *text)
bool handleError (int code, XML_Char const *format, XML_Char const *param)
XspfStack< unsigned int > & getElementStack () const
XspfStack< std::basic_string
< XML_Char > > & 
getBaseUriStack () const
bool handleXmlBaseAttribute (XML_Char const *xmlBase)
virtual bool handleExtensionStart (XML_Char const *fullName, XML_Char const **atts)=0
virtual bool handleExtensionEnd (XML_Char const *fullName)=0
virtual bool handleExtensionCharacters (XML_Char const *s, int len)=0
virtual XspfExtensionwrap ()=0
virtual XspfExtensionReadercreateBrother (XspfReader *reader) const =0

Friends

class XspfReader
class XspfReaderPrivate
class XspfExtensionReaderFactory
class XspfExtensionReaderFactoryPrivate


Detailed Description

Provides the base for specific extention readers to derive from.

Definition at line 66 of file XspfExtensionReader.h.


Constructor & Destructor Documentation

XspfExtensionReader ( XspfReader reader  ) 

Creates a new XspfExtensionReader object.

Parameters:
reader XspfReader to interact with

XspfExtensionReader ( XspfExtensionReader const &  source  ) 

Copy constructor.

Parameters:
source Source to copy from

virtual ~XspfExtensionReader (  )  [virtual]

Destroys this XspfExtensionReader object and deletes all memory associated with it.


Member Function Documentation

virtual XspfExtensionReader* createBrother ( XspfReader reader  )  const [protected, pure virtual]

Creates new XspfExtensionReader of the very same type as this reader.

Parameters:
reader XspfReader to interact with, must not be NULL
Returns:
A new extension reader of the same type.

XspfStack<std::basic_string<XML_Char> >& getBaseUriStack (  )  const [protected]

Gives access to the Base URI stack in use.

Returns:
Base URI stack reference

XspfStack<unsigned int>& getElementStack (  )  const [protected]

Gives access to the element stack in use.

Returns:
Element stack reference

bool handleError ( int  code,
XML_Char const *  format,
XML_Char const *  param 
) [protected]

Passes error handling to the parent XspfReader.

Parameters:
code Error code
format Error description format string containg s
param Text parameter to insert for s

bool handleError ( int  code,
XML_Char const *  text 
) [protected]

Passes error handling to the parent XspfReader.

Parameters:
code Error code
text Error description

virtual bool handleExtensionCharacters ( XML_Char const *  s,
int  len 
) [protected, pure virtual]

Handles element content.

Parameters:
s Text content
len Characters allowed to read

virtual bool handleExtensionEnd ( XML_Char const *  fullName  )  [protected, pure virtual]

Handles tag closing inside an extension including the extension tag itself.

Parameters:
fullName Full tag name ("<namespace_uri> <localname>")
Returns:
Continue parsing flag

virtual bool handleExtensionStart ( XML_Char const *  fullName,
XML_Char const **  atts 
) [protected, pure virtual]

Handles tag opening inside an extension including the extension tag itself.

Parameters:
fullName Full tag name ("<namespace_uri> <localname>")
atts Alternating list of attribute keys and values
Returns:
Continue parsing flag

bool handleXmlBaseAttribute ( XML_Char const *  xmlBase  )  [protected]

Passes xml:base handling to the parent XspfReader.

Parameters:
xmlBase Value of xml:base attribute
Returns:
Continue parsing flag

XspfExtensionReader& operator= ( XspfExtensionReader const &  source  ) 

Assignment operator.

Parameters:
source Source to copy from

virtual XspfExtension* wrap (  )  [protected, pure virtual]

Makes a XspfExtension of the data collected.

Returns:
New built extension


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

Generated on Sat Mar 7 01:09:37 2009 for libxspf by  doxygen 1.5.8