From 765b3a9ba1a59ec3248c8948d4cf5a53f92b40d5 Mon Sep 17 00:00:00 2001 From: trialuser02 Date: Thu, 12 Mar 2009 13:27:44 +0000 Subject: file dialog plugin api documentation git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@841 90c681e8-e032-0410-971d-27865f9a5e38 --- src/qmmpui/fileloader.h | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) (limited to 'src/qmmpui/fileloader.h') diff --git a/src/qmmpui/fileloader.h b/src/qmmpui/fileloader.h index 72ee07a90..c3031b2f7 100644 --- a/src/qmmpui/fileloader.h +++ b/src/qmmpui/fileloader.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2006 by Ilya Kotov * + * Copyright (C) 2006-2009 by Ilya Kotov * * forkotov02@hotmail.ru * * * * This program is free software; you can redistribute it and/or modify * @@ -26,41 +26,51 @@ class PlayListItem; -/*! +/*! @brief File loader class. + * * This class represents fileloader object that * processes file list in separate thread and emits * \b newPlayListItem(PlayListItem*) signal for every newly * created media file. - @author Ilya Kotov -*/ + * @author Ilya Kotov + */ class FileLoader : public QThread { Q_OBJECT public: + /*! + * Constructs FileLoader object. + * @param parent QObject parent + */ FileLoader(QObject *parent = 0); - + /*! + * Object destructor. + */ ~FileLoader(); - virtual void run(); - /*! * Call this method when you want to notify the thread about finishing */ void finish(); - /*! * Sets filelist to load( directory to load will be cleaned ) */ void setFilesToLoad(const QStringList&); - /*! * Sets directory to load( filelist to load will be cleaned ) */ void setDirectoryToLoad(const QString&); signals: - void newPlayListItem(PlayListItem*); + /*! + * Emited when new playlist item is available. + * @param item Pointer of the new PlayListItem object. + */ + void newPlayListItem(PlayListItem *item); + protected: + virtual void run(); void addFiles(const QStringList &files); void addDirectory(const QString& s); + private: QStringList m_filters; QStringList m_files_to_load; -- cgit v1.2.3-13-gbd6f