XspfProps Class Reference

#include <XspfProps.h>

Inheritance diagram for XspfProps:

[legend]

Collaboration diagram for XspfProps:

[legend]

List of all members.

Public Member Functions
	XspfProps ()
	XspfProps (XspfProps const &source)
XspfProps &	operator= (XspfProps const &source)
	~XspfProps ()
void	giveIdentifier (XML_Char const *identifier, bool copy)
void	giveLicense (XML_Char const *license, bool copy)
void	giveLocation (XML_Char const *location, bool copy)
void	giveAppendAttributionIdentifier (XML_Char const *identifier, bool copy)
void	giveAppendAttributionLocation (XML_Char const *location, bool copy)
void	giveDate (XspfDateTime const *date, bool copy)
void	lendIdentifier (XML_Char const *identifier)
void	lendLicense (XML_Char const *license)
void	lendLocation (XML_Char const *location)
void	lendAppendAttributionIdentifier (XML_Char const *identifier)
void	lendAppendAttributionLocation (XML_Char const *location)
void	lendDate (XspfDateTime const *date)
void	setVersion (int version)
XML_Char *	stealLicense ()
XML_Char *	stealLocation ()
XML_Char *	stealIdentifier ()
std::pair< bool, XML_Char * > *	stealFirstAttribution ()
XspfDateTime *	stealDate ()
XML_Char const *	getLicense () const
XML_Char const *	getLocation () const
XML_Char const *	getIdentifier () const
std::pair< bool, XML_Char const * > *	getAttribution (int index) const
int	getAttributionCount () const
XspfDateTime const *	getDate () const
int	getVersion () const
Friends
class	XspfPropsPrivate

---

Detailed Description

Represents the properties of playlist without extensions. This includes all information except the track list.

Definition at line 64 of file XspfProps.h.

---

Constructor & Destructor Documentation

XspfProps

(

)

Creates a new, blank playlist property package.

XspfProps

(

XspfProps const &

source

)

Copy constructor.

Parameters:

source

Source to copy from

~XspfProps

(

)

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

---

Member Function Documentation

std::pair<bool, XML_Char const *>* getAttribution

(

int

index

)

const

Gets the specific attribution entry from the list. If the list is empty NULL is returned.

NOTE: The returned pair has to be deleted manually!

Returns:

Specified attribution entry, can be NULL

int getAttributionCount

(

)

const

Returns the number of attributions.

Returns:

Number of attributions

XspfDateTime const* getDate

(

)

const

Returns the date object property.

Returns:

Date object, can be NULL

XML_Char const* getIdentifier

(

)

const

Returns the identifier property.

Returns:

Identifier, can be NULL

XML_Char const* getLicense

(

)

const

Returns the license property.

Returns:

License, can be NULL

XML_Char const* getLocation

(

)

const

Returns the location property.

Returns:

Location, can be NULL

int getVersion

(

)

const

Returns the XSPF version property.

Returns:

XSPF version (0 or 1)

void giveAppendAttributionIdentifier	(	XML_Char const *	identifier,
		bool	copy
	)

Appends an identifier to the attribution list.

Parameters:

	identifier	Identifier to append
	copy	Copy flag

void giveAppendAttributionLocation	(	XML_Char const *	location,
		bool	copy
	)

Appends an location to the attribution list.

Parameters:

	location	Location to append
	copy	Copy flag

void giveDate	(	XspfDateTime const *	date,
		bool	copy
	)

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

Parameters:

	date	Date object to set
	copy	Copy flag

void giveIdentifier	(	XML_Char const *	identifier,
		bool	copy
	)

Overwrites the identifier 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:

	identifier	Identifier string to set
	copy	Copy flag

void giveLicense	(	XML_Char const *	license,
		bool	copy
	)

Overwrites the license 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:

	license	License string to set
	copy	Copy flag

void giveLocation	(	XML_Char const *	location,
		bool	copy
	)

Overwrites the location 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:

	location	Location string to set
	copy	Copy flag

void lendAppendAttributionIdentifier

(

XML_Char const *

identifier

)

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

Parameters:

identifier

Identifier to append

void lendAppendAttributionLocation

(

XML_Char const *

location

)

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

Parameters:

location

Location to append

void lendDate

(

XspfDateTime const *

date

)

Overwrites the date property. The date object is only assigned not copied. The ownership is not transferred.

Parameters:

date

Date object to set

void lendIdentifier

(

XML_Char const *

identifier

)

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

Parameters:

identifier

Identifier string to set

void lendLicense

(

XML_Char const *

license

)

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

Parameters:

license

License string to set

void lendLocation

(

XML_Char const *

location

)

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

Parameters:

location

Location string to set

XspfProps& operator=

(

XspfProps const &

source

)

Assignment operator.

Parameters:

source

Source to copy from

void setVersion

(

int

version

)

Overwrites the XSPF version property.

Parameters:

version

XSPF version (0 or 1)

XspfDateTime* stealDate

(

)

Steals the date object property.

Returns:

Date object, can be NULL

std::pair<bool, XML_Char *>* stealFirstAttribution

(

)

Steals the first attribution entry from the list. If the list is empty NULL is returned.

NOTE: Do not forget to delete the pair!

Returns:

First attribution entry, can be NULL

XML_Char* stealIdentifier

(

)

Steals the identifier property.

Returns:

Identifier URI, can be NULL

XML_Char* stealLicense

(

)

Steals the license property.

Returns:

License URI, can be NULL

XML_Char* stealLocation

(

)

Steals the location property.

Returns:

Location URI, can be NULL

---

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

• XspfProps.h