Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

PlaylistSaver Class Reference

#include <playlistsaver.h>

List of all members.

Public Types

enum  Options { XMLPlaylist = 1, M3U = 2, PLS = 4 }

Public Member Functions

 PlaylistSaver ()
virtual ~PlaylistSaver ()
bool save (const KURL &file, int options=0)
bool load (const KURL &file, int options=0)
bool metalist (const KURL &url)
virtual void setGroup (const QString &)

Protected Member Functions

virtual void readItem (const QMap< QString, QString > &properties)=0
virtual PlaylistItem writeItem ()=0
virtual void changeGroup (const QString &)
virtual void reset ()

Friends

class Structure


Detailed Description

a simple one-group implementatio of the standard XML playlist format:

http://noatun.kde.org/formats/xmlplaylist.phtml

A custom implemenation like yours should have a different "client" attribute for the playlist tag

Definition at line 19 of file playlistsaver.h.


Member Enumeration Documentation

enum PlaylistSaver::Options
 

Enumeration values:
XMLPlaylist 
M3U 
PLS 

Definition at line 23 of file playlistsaver.h.


Constructor & Destructor Documentation

PlaylistSaver::PlaylistSaver  
 

virtual PlaylistSaver::~PlaylistSaver   [virtual]
 


Member Function Documentation

virtual void PlaylistSaver::changeGroup const QString &    [inline, protected, virtual]
 

unused, for future expansion

Definition at line 72 of file playlistsaver.h.

bool PlaylistSaver::load const KURL &    file,
int    options = 0
 

bool PlaylistSaver::metalist const KURL &    url
 

guess the list's content between M3U or PLS, and give it to you

this is also the way to make icecast work. you can also pass true icecast urls here and it'l do its magic.

This calls readItem

virtual void PlaylistSaver::readItem const QMap< QString, QString > &    properties [protected, pure virtual]
 

read the item, and add it to your list Given is a list of properties which coincide with the standard noatun ones

virtual void PlaylistSaver::reset   [inline, protected, virtual]
 

this is called when you should either clear your list, or start writing from the start of the list

You usually don't need to implement this, since it'l always be called immediately after load() or save()

Definition at line 81 of file playlistsaver.h.

bool PlaylistSaver::save const KURL &    file,
int    options = 0
 

virtual void PlaylistSaver::setGroup const QString &    [virtual]
 

unused, for future expansion, do not use

virtual PlaylistItem PlaylistSaver::writeItem   [protected, pure virtual]
 

add this item to the XML file or a null item if we're at the end


Friends And Related Function Documentation

friend class Structure [friend]
 

Definition at line 21 of file playlistsaver.h.


The documentation for this class was generated from the following file:
Generated on Sat May 24 15:10:28 2003 for Noatun by doxygen1.3-rc3