XspfReaderCallback Class Reference

#include <XspfReaderCallback.h>

List of all members.

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

Creates a new reader callback.

virtual ~XspfReaderCallback (  )  [virtual]

Destroys this reader callback.


Member Function Documentation

virtual void addTrack ( XspfTrack track  )  [protected, virtual]

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

Parameters:
track New track, never NULL

virtual bool handleError ( int  line,
int  column,
int  errorCode,
XML_Char const *  description 
) [protected, virtual]

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:
line Line of the input containing the error
column Column of the input containing the error
errorCode Code identifying the error
description Description of the error
Returns:
Continue parsing flag
Since:
1.0.0rc1

virtual bool handleWarning ( int  line,
int  column,
int  warningCode,
XML_Char const *  description 
) [protected, virtual]

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:
line Line of the input producing the warning
column Column of the input producing the warning
warningCode Code identifying the warning
description Description of the warning
Returns:
Continue parsing flag
Since:
1.0.0rc1

virtual void notifyFatalError ( int  line,
int  column,
int  errorCode,
XML_Char const *  description 
) [protected, virtual]

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

Parameters:
line Line of the input containing the error, can be < 1
column Column of the input containing the error, can be < 1
errorCode Code identifying the error
description Description of the error
Since:
1.0.0.rc3

virtual void notifySuccess (  )  [protected, virtual]

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

virtual void setProps ( XspfProps props  )  [protected, virtual]

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

Parameters:
props Playlist properties, never NULL


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