lbajardsilogic@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
lbajardsilogic@0: 
lbajardsilogic@0: /*
lbajardsilogic@0:     Sonic Visualiser
lbajardsilogic@0:     An audio file viewer and annotation editor.
lbajardsilogic@0:     Centre for Digital Music, Queen Mary, University of London.
lbajardsilogic@0:     This file copyright 2006 Chris Cannam.
lbajardsilogic@0:     
lbajardsilogic@0:     This program is free software; you can redistribute it and/or
lbajardsilogic@0:     modify it under the terms of the GNU General Public License as
lbajardsilogic@0:     published by the Free Software Foundation; either version 2 of the
lbajardsilogic@0:     License, or (at your option) any later version.  See the file
lbajardsilogic@0:     COPYING included with this distribution for more information.
lbajardsilogic@0: */
lbajardsilogic@0: 
lbajardsilogic@0: #ifndef _RECENT_FILES_H_
lbajardsilogic@0: #define _RECENT_FILES_H_
lbajardsilogic@0: 
lbajardsilogic@0: #include <QObject>
lbajardsilogic@0: #include <QString>
lbajardsilogic@0: #include <vector>
lbajardsilogic@0: #include <deque>
lbajardsilogic@0: 
lbajardsilogic@0: /**
lbajardsilogic@0:  * RecentFiles manages a list of the names of recently-used objects,
lbajardsilogic@0:  * saving and restoring that list via QSettings.  The names do not
lbajardsilogic@0:  * actually have to refer to files.
lbajardsilogic@0:  */
lbajardsilogic@0: 
lbajardsilogic@0: class RecentFiles : public QObject
lbajardsilogic@0: {
lbajardsilogic@0:     Q_OBJECT
lbajardsilogic@0: 
lbajardsilogic@0: public:
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Construct a RecentFiles object that saves and restores in the
lbajardsilogic@0:      * given QSettings group and truncates when the given count of
lbajardsilogic@0:      * strings is reached.
lbajardsilogic@0:      */
lbajardsilogic@0:     RecentFiles(QString settingsGroup = "RecentFiles", size_t maxCount = 10);
lbajardsilogic@0: 
lbajardsilogic@0:     virtual ~RecentFiles();
lbajardsilogic@0: 
lbajardsilogic@0:     QString getSettingsGroup() const { return m_settingsGroup; }
lbajardsilogic@0: 
lbajardsilogic@0:     int getMaxCount() const { return m_maxCount; }
lbajardsilogic@0: 
lbajardsilogic@0:     std::vector<QString> getRecent() const;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Add a name that should be treated as a literal string.
lbajardsilogic@0:      */
lbajardsilogic@0:     void add(QString name);
lbajardsilogic@0:     
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Add a name that is known to be either a file path or a URL.  If
lbajardsilogic@0:      * it looks like a URL, add it literally; otherwise treat it as a
lbajardsilogic@0:      * file path and canonicalise it appropriately.
lbajardsilogic@0:      */
lbajardsilogic@0:     void addFile(QString name);
lbajardsilogic@0: 
lbajardsilogic@0: signals:
lbajardsilogic@0:     void recentChanged();
lbajardsilogic@0: 
lbajardsilogic@0: protected:
lbajardsilogic@0:     QString m_settingsGroup;
lbajardsilogic@0:     size_t m_maxCount;
lbajardsilogic@0: 
lbajardsilogic@0:     std::deque<QString> m_names;
lbajardsilogic@0: 
lbajardsilogic@0:     void read();
lbajardsilogic@0:     void write();
lbajardsilogic@0:     void truncateAndWrite();
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: #endif