XspfData Class Reference

#include <XspfData.h>

Inheritance diagram for XspfData:

List of all members.

Public Member Functions

void giveImage (XML_Char const *image, bool copy)

void giveInfo (XML_Char const *info, bool copy)

void giveAnnotation (XML_Char const *annotation, bool copy)

void giveCreator (XML_Char const *creator, bool copy)

void giveTitle (XML_Char const *title, bool copy)

void giveAppendLink (XML_Char const *rel, bool copyRel, XML_Char const *content, bool copyContent)

void giveAppendMeta (XML_Char const *rel, bool copyRel, XML_Char const *content, bool copyContent)

void giveAppendExtension (XspfExtension const *extension, bool copy)

void lendImage (XML_Char const *image)

void lendInfo (XML_Char const *info)

void lendAnnotation (XML_Char const *annotation)

void lendCreator (XML_Char const *creator)

void lendTitle (XML_Char const *title)

void lendAppendLink (XML_Char const *rel, XML_Char const *content)

void lendAppendMeta (XML_Char const *rel, XML_Char const *content)

void lendAppendExtension (XspfExtension *extension)

XML_Char * stealImage ()

XML_Char * stealInfo ()

XML_Char * stealAnnotation ()

XML_Char * stealCreator ()

XML_Char * stealTitle ()

std::pair< XML_Char
*, XML_Char * > * stealFirstLink ()

std::pair< XML_Char
*, XML_Char * > * stealFirstMeta ()

XspfExtension * stealFirstExtension ()

XML_Char const * getImage () const

XML_Char const * getInfo () const

XML_Char const * getAnnotation () const

XML_Char const * getCreator () const

XML_Char const * getTitle () const

std::pair< XML_Char const
*, XML_Char const * > * getLink (int index) const

std::pair< XML_Char const
*, XML_Char const * > * getMeta (int index) const

XspfExtension const * getExtension (int index) const

int getLinkCount () const

int getMetaCount () const

int getExtensionCount () const

Static Public Attributes

static bool const COPY

static bool const TRANSFER

Memory ownership is transfered.

Protected Member Functions

XspfData ()

XspfData (XspfData const &source)

XspfData & operator= (XspfData const &source)

virtual ~XspfData ()

Static Protected Member Functions

static XML_Char * stealHelper (XML_Char const *&property, bool own)

Friends

class XspfDataPrivate

Detailed Description

Provides shared functionality for XspfTrack and XspfProps.

Definition at line 62 of file XspfData.h.

Constructor & Destructor Documentation

XspfData ( ) [protected]

Creates a new XspfData object.

XspfData ( XspfData const & source ) [protected]

Copy constructor.

Parameters:

source

Source to copy from

virtual ~XspfData ( ) [protected, virtual]

Destroys this XspfData object and deletes all memory associated with it that has not been stolen before.

Member Function Documentation

XML_Char const* getAnnotation ( ) const

Returns the annotation property.

Returns:: Annotation, can be NULL

XML_Char const* getCreator ( ) const

Returns the creator property.

Returns:: Creator, can be NULL

XspfExtension const* getExtension ( int index ) const

Gets a specific extension from the list. If the list is empty NULL is returned.

NOTE: The returned extension has to be deleted manually!

Returns:: Specified extension, can be NULL

int getExtensionCount ( ) const

Returns the number of extensions.

Returns:: Number of extensions

XML_Char const* getImage ( ) const

Returns the image property.

Returns:: Image URI, can be NULL

XML_Char const* getInfo ( ) const

Returns the info property.

Returns:: Info URI, can be NULL

std::pair<XML_Char const *, XML_Char const *>* getLink ( int index ) const

Gets a specific link pair from the list. If the list is empty NULL is returned.

NOTE: The returned pair has to be deleted manually!

Returns:: Specified link pair, can be NULL

int getLinkCount ( ) const

Returns the number of link pairs.

Returns:: Number of link pairs

std::pair<XML_Char const *, XML_Char const *>* getMeta ( int index ) const

Gets a specific meta pair from the list. If the list is empty NULL is returned.

NOTE: The returned pair has to be deleted manually!

Returns:: Specified meta pair, can be NULL

int getMetaCount ( ) const

Returns the number of meta pairs.

Returns:: Number of meta pairs

XML_Char const* getTitle ( ) const

Returns the title property.

Returns:: Title, can be NULL

void giveAnnotation	(	XML_Char const *	annotation,
		bool	copy
	)

Overwrites the annotation property. If copy is true the string will be copied, otherwise just assigned. In both cases the associated memory will be deleted on object destruction.

Parameters:

	annotation	Annotation string to set
	copy	Copy flag

void giveAppendExtension	(	XspfExtension const *	extension,
		bool	copy
	)

Appends an extension to the extension list.

Parameters:

	extension	Extension to append
	copy	Copy flag

void giveAppendLink	(	XML_Char const *	rel,
		bool	copyRel,
		XML_Char const *	content,
		bool	copyContent
	)

Appends a link to the link list.

Parameters:

	rel	Link rel to append
	copyRel	Rel copy flag
	content	Link content to append
	copyContent	Content copy flag

void giveAppendMeta	(	XML_Char const *	rel,
		bool	copyRel,
		XML_Char const *	content,
		bool	copyContent
	)

Appends a meta to the meta list.

Parameters:

	rel	Meta rel to append
	copyRel	Rel copy flag
	content	Meta content to append
	copyContent	Content copy flag

void giveCreator	(	XML_Char const *	creator,
		bool	copy
	)

Overwrites the creator property. If copy is true the string will be copied, otherwise just assigned. In both cases the associated memory will be deleted on object destruction.

Parameters:

	creator	Creator string to set
	copy	Copy flag

void giveImage	(	XML_Char const *	image,
		bool	copy
	)

Overwrites the image property. If copy is true the string will be copied, otherwise just assigned. In both cases the associated memory will be deleted on object destruction.

Parameters:

	image	Image string to set
	copy	Copy flag

void giveInfo	(	XML_Char const *	info,
		bool	copy
	)

Overwrites the info property. If copy is true the string will be copied, otherwise just assigned. In both cases the associated memory will be deleted on object destruction.

Parameters:

	info	Info string to set
	copy	Copy flag

void giveTitle	(	XML_Char const *	title,
		bool	copy
	)

Overwrites the title property. If copy is true the string will be copied, otherwise just assigned. In both cases the associated memory will be deleted on object destruction.

Parameters:

	title	Title string to set
	copy	Copy flag

void lendAnnotation ( XML_Char const * annotation )

Overwrites the annotation property. The string is only assigned not copied. The ownership is not transferred.

Parameters:

annotation

Annotation string to set

void lendAppendExtension ( XspfExtension * extension )

Appends an extension to the extension list. The associated memory is neither copied nor deleted on onject destruction.

Parameters:

extension

Extension to append

void lendAppendLink	(	XML_Char const *	rel,
		XML_Char const *	content
	)

Appends a link pair to the link list. The associated memory is neither copied nor deleted on onject destruction.

Parameters:

	rel	Link rel to append
	content	Link content to append

void lendAppendMeta	(	XML_Char const *	rel,
		XML_Char const *	content
	)

Appends a meta pair to the meta list. The associated memory is neither copied nor deleted on onject destruction.

Parameters:

	rel	Meta rel to append
	content	Meta content to append

void lendCreator ( XML_Char const * creator )

Overwrites the creator property. The string is only assigned not copied. The ownership is not transferred.

Parameters:

creator

Creator string to set

void lendImage ( XML_Char const * image )

Overwrites the image property. The string is only assigned not copied. The ownership is not transferred.

Parameters:

image

Image string to set

void lendInfo ( XML_Char const * info )

Overwrites the info property. The string is only assigned not copied. The ownership is not transferred.

Parameters:

info

Info string to set

void lendTitle ( XML_Char const * title )

Overwrites the title property. The string is only assigned not copied. The ownership is not transferred.

Parameters:

title

Title string to set

XspfData& operator= ( XspfData const & source ) [protected]

Assignment operator.

Parameters:

source

Source to copy from

XML_Char* stealAnnotation ( )

Steals the annotation property.

Returns:: Annotation, can be NULL

XML_Char* stealCreator ( )

Steals the creator property.

Returns:: Creator, can be NULL

XspfExtension* stealFirstExtension ( )

Steals the extension from the list. If the list is empty NULL is returned.

NOTE: Do not forget to delete the extension!

Returns:: First extension, can be NULL

std::pair<XML_Char *, XML_Char *>* stealFirstLink ( )

Steals the first link pair from the list. If the list is empty NULL is returned.

NOTE: Do not forget to delete the pair!

Returns:: First link pair, can be NULL

std::pair<XML_Char *, XML_Char *>* stealFirstMeta ( )

Steals the first meta pair from the list. If the list is empty NULL is returned.

NOTE: Do not forget to delete the pair!

Returns:: First meta pair, can be NULL

static XML_Char* stealHelper	(	XML_Char const *&	property,
		bool	own
	)			`[static, protected]`

Steals a property. If the property's memory is not owned a clone is returned. In any case you own the memory return and have to delete it.

Parameters:

	property	Property to steal
	own	Owner flag

Returns:: Stolen property value, can be NULL

XML_Char* stealImage ( )

Steals the image property.

Returns:: Image URI, can be NULL

XML_Char* stealInfo ( )

Steals the info property.

Returns:: Info URI, can be NULL

XML_Char* stealTitle ( )

Steals the title property.

Returns:: Title, can be NULL

Member Data Documentation

bool const COPY [static]

Memory is copied

Definition at line 503 of file XspfData.h.

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

XspfData.h


Public Member Functions
void	giveImage (XML_Char const *image, bool copy)
void	giveInfo (XML_Char const *info, bool copy)
void	giveAnnotation (XML_Char const *annotation, bool copy)
void	giveCreator (XML_Char const *creator, bool copy)
void	giveTitle (XML_Char const *title, bool copy)
void	giveAppendLink (XML_Char const rel, bool copyRel, XML_Char const content, bool copyContent)
void	giveAppendMeta (XML_Char const rel, bool copyRel, XML_Char const content, bool copyContent)
void	giveAppendExtension (XspfExtension const *extension, bool copy)
void	lendImage (XML_Char const *image)
void	lendInfo (XML_Char const *info)
void	lendAnnotation (XML_Char const *annotation)
void	lendCreator (XML_Char const *creator)
void	lendTitle (XML_Char const *title)
void	lendAppendLink (XML_Char const rel, XML_Char const content)
void	lendAppendMeta (XML_Char const rel, XML_Char const content)
void	lendAppendExtension (XspfExtension *extension)
XML_Char *	stealImage ()
XML_Char *	stealInfo ()
XML_Char *	stealAnnotation ()
XML_Char *	stealCreator ()
XML_Char *	stealTitle ()
std::pair< XML_Char , XML_Char > *	stealFirstLink ()
std::pair< XML_Char , XML_Char > *	stealFirstMeta ()
XspfExtension *	stealFirstExtension ()
XML_Char const *	getImage () const
XML_Char const *	getInfo () const
XML_Char const *	getAnnotation () const
XML_Char const *	getCreator () const
XML_Char const *	getTitle () const
std::pair< XML_Char const , XML_Char const > *	getLink (int index) const
std::pair< XML_Char const , XML_Char const > *	getMeta (int index) const
XspfExtension const *	getExtension (int index) const
int	getLinkCount () const
int	getMetaCount () const
int	getExtensionCount () const
Static Public Attributes
static bool const	COPY
static bool const	TRANSFER
	Memory ownership is transfered.
Protected Member Functions
	XspfData ()
	XspfData (XspfData const &source)
XspfData &	operator= (XspfData const &source)
virtual	~XspfData ()
Static Protected Member Functions
static XML_Char *	stealHelper (XML_Char const *&property, bool own)
Friends
class	XspfDataPrivate