libxspf  1.2.0
Public Member Functions | Protected Member Functions | Friends | List of all members
XspfReaderCallback Class Reference

#include <XspfReaderCallback.h>

Public Member Functions

 XspfReaderCallback ()
 
virtual ~XspfReaderCallback ()
 

Protected Member Functions

virtual void addTrack (XspfTrack *track)
 
virtual void setProps (XspfProps *props)
 
virtual void notifyFatalError (int line, int column, int errorCode, XML_Char const *description)
 
virtual bool handleError (int line, int column, int errorCode, XML_Char const *description)
 
virtual bool handleWarning (int line, int column, int warningCode, XML_Char const *description)
 
virtual void notifySuccess ()
 

Friends

class XspfReader
 

Detailed Description

Is called by a XspfReader when new pieces of information become available.

Definition at line 64 of file XspfReaderCallback.h.

Constructor & Destructor Documentation

◆ XspfReaderCallback()

Creates a new reader callback.

◆ ~XspfReaderCallback()

virtual ~XspfReaderCallback ( )
virtual

Destroys this reader callback.

Member Function Documentation

◆ addTrack()

virtual void addTrack ( XspfTrack track)
protectedvirtual

Is called when a new, complete track is available. Deleting track is up to you.

Parameters
trackNew track, never NULL

◆ handleError()

virtual bool handleError ( int  line,
int  column,
int  errorCode,
XML_Char const *  description 
)
protectedvirtual

Is called when a XSPF content error occurs. Return true to continue parsing or to abort. Please note that line and column might not be precise.

Parameters
lineLine of the input containing the error
columnColumn of the input containing the error
errorCodeCode identifying the error
descriptionDescription of the error
Returns
Continue parsing flag
Since
1.0.0rc1

◆ handleWarning()

virtual bool handleWarning ( int  line,
int  column,
int  warningCode,
XML_Char const *  description 
)
protectedvirtual

Is called when a warning occurs. Return true to continue parsing or to abort. Please note that the precision of the line and column values in part is the responsibility of Expat.

Parameters
lineLine of the input producing the warning
columnColumn of the input producing the warning
warningCodeCode identifying the warning
descriptionDescription of the warning
Returns
Continue parsing flag
Since
1.0.0rc1

◆ notifyFatalError()

virtual void notifyFatalError ( int  line,
int  column,
int  errorCode,
XML_Char const *  description 
)
protectedvirtual

Is called when a fatal error occurs. This includes errors on XML level which cannot be skipped due to the nature of XML.

Parameters
lineLine of the input containing the error, can be < 1
columnColumn of the input containing the error, can be < 1
errorCodeCode identifying the error
descriptionDescription of the error
Since
1.0.0.rc3

◆ notifySuccess()

virtual void notifySuccess ( )
protectedvirtual

Notifies this reader callback, that reading this file has finished successfully. 'Success' here means that either no errors occured at all or that all errors have been ignored/skipped.

Since
1.0.0.rc3

◆ setProps()

virtual void setProps ( XspfProps props)
protectedvirtual

Is called when all playlist properties are available. Deleting props is up to you.

Parameters
propsPlaylist properties, never NULL

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