PlayListManager Class Reference

The PlayListManager class is used to handle multiple playlists. More...

#include <playlistmanager.h>

List of all members.

Public Slots

void selectPlayList (PlayListModel *model)
void selectPlayList (int index)
void selectNextPlayList ()
void selectPreviousPlayList ()
void activatePlayList (PlayListModel *model)
PlayListModel * createPlayList (const QString &name=QString())
void removePlayList (PlayListModel *model)
void move (int i, int j)
void setRepeatableList (bool r)
void setShuffle (bool s)
void clear ()
void clearSelection ()
void removeSelected ()
void removeUnselected ()
void removeAt (int i)
void removeItem (PlayListItem *item)
void invertSelection ()
void selectAll ()
void showDetails ()
void addFile (const QString &path)
void addFiles (const QStringList &l)
void addDirectory (const QString &dir)
void randomizeList ()
void reverseList ()
void sortSelection (int mode)
void sort (int mode)
void addToQueue ()
void removeInvalidItems ()
void removeDuplicates ()

Signals

void currentPlayListChanged (PlayListModel *current, PlayListModel *previous)
void selectedPlayListChanged (PlayListModel *selected, PlayListModel *previous)
void playListAdded (int index)
void playListRemoved (int index)
void playListMoved (int i, int j)
void playListsChanged ()
void repeatableListChanged (bool state)
void shuffleChanged (bool state)
void settingsChanged ()

Public Member Functions

 PlayListManager (QObject *parent)
 ~PlayListManager ()
QList< PlayListModel * > playLists () const
QStringList playListNames () const
PlayListModel * selectedPlayList () const
PlayListModel * currentPlayList () const
int count ()
int indexOf (PlayListModel *model)
PlayListModel * playListAt (int i)
bool convertUnderscore ()
bool convertTwenty ()
bool useMetadata ()
const QString format () const
void setConvertUnderscore (bool enabled)
void setConvertTwenty (bool enabled)
void setUseMetadata (bool enabled)
void setFormat (const QString &format)
bool isRepeatableList () const
bool isShuffle () const

Detailed Description

The PlayListManager class is used to handle multiple playlists.

Author:
Ilya Kotov <forkotov02@hotmail.ru>

Constructor & Destructor Documentation

PlayListManager::PlayListManager ( QObject *  parent  ) 

Constructor.

Parameters:
parent Parent object.

PlayListManager::~PlayListManager (  ) 

Destructor.

Member Function Documentation

void PlayListManager::activatePlayList ( PlayListModel *  model  )  [slot]

Sets current playlist to model.

void PlayListManager::addDirectory ( const QString &  dir  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->addDirectory(dir)

void PlayListManager::addFile ( const QString &  path  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->addFile(path)

void PlayListManager::addFiles ( const QStringList &  l  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->addFiles(l)

void PlayListManager::addToQueue (  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->addToQueue()

void PlayListManager::clear (  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->clear()

void PlayListManager::clearSelection (  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->clearSelection()

bool PlayListManager::convertTwenty (  ) 

Returns state of the "Convert %20 to blanks" option (true - enabled, false - disabled).

bool PlayListManager::convertUnderscore (  ) 

Returns state of the "Convert underscores to blanks" option (true - enabled, false - disabled).

int PlayListManager::count (  ) 

Returns a number of playlists.

PlayListModel* PlayListManager::createPlayList ( const QString &  name = QString()  )  [slot]

Creates new playlist with the given name name.

PlayListModel* PlayListManager::currentPlayList (  )  const

Returns active playlist.

void PlayListManager::currentPlayListChanged ( PlayListModel *  current,
PlayListModel *  previous 
) [signal]

Emitted when current playlist changes.

Parameters:
current Current playlist.
previous Previous playlist.

const QString PlayListManager::format (  )  const

Returns title format string.

int PlayListManager::indexOf ( PlayListModel *  model  ) 

Returns the index position of the playlist model.

void PlayListManager::invertSelection (  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->invertSelection()

bool PlayListManager::isRepeatableList (  )  const

Returns state of "Repeat All" option.

bool PlayListManager::isShuffle (  )  const

Returns state of "Shuffle" option.

void PlayListManager::move ( int  i,
int  j 
) [slot]

Moves playlist with index i to index j.

void PlayListManager::playListAdded ( int  index  )  [signal]

Emitted when the playlist with index index is added.

PlayListModel* PlayListManager::playListAt ( int  i  ) 

Returns the playlist at index position i in the list. i must be a valid index position in the list (i.e., 0 <= i < count()).

void PlayListManager::playListMoved ( int  i,
int  j 
) [signal]

Emitted when playlist changes its position from i to j.

QStringList PlayListManager::playListNames (  )  const

Returns a names of all playlists.

void PlayListManager::playListRemoved ( int  index  )  [signal]

Emitted when the playlist with index index is removed.

QList<PlayListModel *> PlayListManager::playLists (  )  const

Returns a list of all playlists.

void PlayListManager::playListsChanged (  )  [signal]

Emitted when the list of playlists is changed.

void PlayListManager::randomizeList (  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->randomizeList()

void PlayListManager::removeAt ( int  i  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->removeAt(i)

void PlayListManager::removeDuplicates (  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->removeDuplicates()

void PlayListManager::removeInvalidItems (  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->clearInvalidItems()

void PlayListManager::removeItem ( PlayListItem *  item  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->removeItem(item)

void PlayListManager::removePlayList ( PlayListModel *  model  )  [slot]

Removes playlist model.

void PlayListManager::removeSelected (  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->removeSelected()

void PlayListManager::removeUnselected (  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->removeUnselected()

void PlayListManager::repeatableListChanged ( bool  state  )  [signal]

Emitted when state of the "Repeat All" option has changed.

Parameters:
state New state of the "Repeat All" option (true - enabled, false disabled)

void PlayListManager::reverseList (  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->reverseList()

void PlayListManager::selectAll (  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->selectAll()

PlayListModel* PlayListManager::selectedPlayList (  )  const

Returns selected playlist.

void PlayListManager::selectedPlayListChanged ( PlayListModel *  selected,
PlayListModel *  previous 
) [signal]

Emitted when selected playlist changes.

Parameters:
selected Selected playlist.
previous Previous selected playlist.

void PlayListManager::selectNextPlayList (  )  [slot]

Selects next playlist if possible.

void PlayListManager::selectPlayList ( int  index  )  [slot]

Selects playlist with index index.

void PlayListManager::selectPlayList ( PlayListModel *  model  )  [slot]

Selects playlist model.

void PlayListManager::selectPreviousPlayList (  )  [slot]

Selects previous playlist if possible.

void PlayListManager::setConvertTwenty ( bool  enabled  ) 

Sets the "Convert %20 to blanks" option state to enabled

Parameters:
enabled Option state (true - enabled, false - disabled)

void PlayListManager::setConvertUnderscore ( bool  enabled  ) 

Sets the "Convert underscores to blanks" option state to enabled

Parameters:
enabled Option state (true - enabled, false - disabled)

void PlayListManager::setFormat ( const QString &  format  ) 

Sets short title template.

Parameters:
format title template.
See also:
MetaDataFormatter

void PlayListManager::setRepeatableList ( bool  r  )  [slot]

Prepares all playlists for repeatable playing (loop mode).

Parameters:
r State of the repeatable mode (true - enabled, false - disabled)

void PlayListManager::setShuffle ( bool  s  )  [slot]

Prepares all playlists for shuffle playing.

Parameters:
s State of the shuffle mode (true - enabled, false - disabled)

void PlayListManager::settingsChanged (  )  [signal]

Emitted when other settings (format, metadata, etc) have changed.

void PlayListManager::setUseMetadata ( bool  enabled  ) 

Sets metadata usage option state to enabled

Parameters:
enabled Option state (true - enabled, false - disabled)

void PlayListManager::showDetails (  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->showDetails()

void PlayListManager::shuffleChanged ( bool  state  )  [signal]

Emitted when state of the "Shuffle" option has changed.

Parameters:
state New state of the "Shuffle" option (true - enabled, false disabled)

void PlayListManager::sort ( int  mode  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->sort(mode)

void PlayListManager::sortSelection ( int  mode  )  [slot]

This is a convenience function and is the same as calling selectedPlayList()->sortSelection(mode)

bool PlayListManager::useMetadata (  ) 

Returns the state of metadata usage (true - use, false - not use).

The documentation for this class was generated from the following file:
Generated on Sat Mar 27 19:43:01 2010 for Qmmp by  doxygen 1.5.9