comparison recentfiles.h @ 63:2340b00561d2

* Add (but don't yet use) RecentFiles class to replace inline MRU logic

+/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
+
+/*
+    EasyMercurial
+
+    Based on HgExplorer by Jari Korhonen
+    Copyright (c) 2010 Jari Korhonen
+    Copyright (c) 2010 Chris Cannam
+    Copyright (c) 2010 Queen Mary, University of London
+    
+    This program is free software; you can redistribute it and/or
+    modify it under the terms of the GNU General Public License as
+    published by the Free Software Foundation; either version 2 of the
+    License, or (at your option) any later version.  See the file
+    COPYING included with this distribution for more information.
+*/
+
+#ifndef _RECENT_FILES_H_
+#define _RECENT_FILES_H_
+
+#include <QObject>
+#include <QString>
+#include <QStringList>
+#include <deque>
+
+/**
+ * RecentFiles manages a list of the names of recently-used objects,
+ * saving and restoring that list via QSettings.  The names do not
+ * actually have to refer to files.
+ */
+
+class RecentFiles : public QObject
+{
+    Q_OBJECT
+
+public:
+    /**
+     * Construct a RecentFiles object that saves and restores in the
+     * given QSettings group and truncates when the given count of
+     * strings is reached.
+     */
+    RecentFiles(QString settingsGroup = "RecentFiles",
+                size_t maxCount = 10,
+                bool ignoreTemporaries = true);
+    virtual ~RecentFiles();
+
+    QString getSettingsGroup() const { return m_settingsGroup; }
+
+    int getMaxCount() const { return m_maxCount; }
+
+    QStringList getRecent() const;
+
+    /**
+     * Add a name that should be treated as a literal string.
+     */
+    void add(QString name);
+    
+    /**
+     * Add a name that is known to be either a file path or a URL.  If
+     * it looks like a URL, add it literally; otherwise treat it as a
+     * file path and canonicalise it appropriately.  Also takes into
+     * account the user preference for whether to include temporary
+     * files in the recent files menu: the file will not be added if
+     * the preference is set and the file appears to be a temporary
+     * one.
+     */
+    void addFile(QString name);
+
+signals:
+    void recentChanged();
+
+protected:
+    QString m_settingsGroup;
+    size_t m_maxCount;
+    bool m_ignoreTemporaries;
+
+    std::deque<QString> m_names;
+
+    void read();
+    void write();
+    void truncateAndWrite();
+};
+
+#endif