RecentFiles Class Reference

Detailed Description

The RecentFiles class provides functionality to store information about recently used files (e.g. loaded or saved files). Example Usage:

 RecentFiles* recentFiles = new RecentFiles(this, SLOT(openRecentFile()), "recentFileList", "OpenGeoSys");
connect(this, SIGNAL(fileUsed(QString)), recentFiles, SLOT(setCurrentFile(QString)));
menu_File->addMenu( recentFiles->menu() ); 

with:

 void MainWindow::openRecentFile()
{
  QAction* action = qobject_cast<QAction*>(sender());
  if (action)
  loadFile(action->data().toString());
} 

Definition at line 38 of file RecentFiles.h.

#include <RecentFiles.h>

Inheritance diagram for RecentFiles:

Collaboration diagram for RecentFiles:

Public Slots
void	setCurrentFile (const QString &filename)
	Should be called from the application when a file was used.

Public Member Functions
	RecentFiles (QObject *parent, const char *slot, QString settingsName)
	~RecentFiles () override
QMenu *	menu ()
	Returns the created menu. Add this menu to your QMainWindow menu.

Private Types
enum	{ _maxFiles = 5 }

Private Member Functions
void	updateRecentFileActions ()
	Updates the recent files list and writes it to the settings.
QString	strippedName (const QString &fullFileName)
	Returns the filename from a full file path.

Private Attributes
QMenu *	_filesMenu
QString	_currentFile
QString	_settingsName
QAction *	_fileActions [_maxFiles]

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
_maxFiles

Definition at line 71 of file RecentFiles.h.

{ _maxFiles = 5 };

Constructor & Destructor Documentation

RecentFiles()

RecentFiles::RecentFiles	(	QObject *	parent,
		const char *	slot,
		QString	settingsName )

Constructor. Example Usage:

RecentFiles recentFiles = new RecentFiles(this, SLOT(mySlot(QString)), "recentFileList"); 

Parameters

parent	The parent object. Normally the QMainWindow instance
slot	A slot on parent which is called when a recent file is clicked. Use this with Qts SLOT() macro!
settingsName	The setting key

Definition at line 22 of file RecentFiles.cpp.

    : QObject(parent), _settingsName(std::move(settingsName))
{
    _filesMenu = new QMenu(tr("Recent files"));
    for (auto& fileAction : _fileActions)
    {
        fileAction = new QAction(this);
        fileAction->setVisible(false);
        connect(fileAction, SIGNAL(triggered()), parent, slot);
        _filesMenu->addAction(fileAction);
    }
    updateRecentFileActions();
}

References _fileActions, _filesMenu, and updateRecentFileActions().

~RecentFiles()

RecentFiles::~RecentFiles ( )

override

Definition at line 37 of file RecentFiles.cpp.

{
    delete _filesMenu;
}

References _filesMenu.

Member Function Documentation

menu()

QMenu * RecentFiles::menu

(

)

Returns the created menu. Add this menu to your QMainWindow menu.

Definition at line 42 of file RecentFiles.cpp.

{
    return _filesMenu;
}

References _filesMenu.

Referenced by MainWindow::MainWindow().

setCurrentFile

void RecentFiles::setCurrentFile ( const QString & filename )

slot

Should be called from the application when a file was used.

Definition at line 46 of file RecentFiles.cpp.

{
    _currentFile = filename;
 
    QSettings settings;
    QStringList files = settings.value(_settingsName).toStringList();
    files.removeAll(filename);
    files.prepend(filename);
    while (files.size() > _maxFiles)
    {
        files.removeLast();
    }
 
    settings.setValue("recentFileList", files);
 
    updateRecentFileActions();
}

References _currentFile, _maxFiles, _settingsName, and updateRecentFileActions().

strippedName()

QString RecentFiles::strippedName ( const QString & fullFileName )

private

Returns the filename from a full file path.

Definition at line 84 of file RecentFiles.cpp.

{
    return QFileInfo(fullFileName).fileName();
}

Referenced by updateRecentFileActions().

updateRecentFileActions()

void RecentFiles::updateRecentFileActions ( )

private

Updates the recent files list and writes it to the settings.

Definition at line 63 of file RecentFiles.cpp.

{
    QSettings settings;
    QStringList files = settings.value(_settingsName).toStringList();
 
    int numFiles = qMin(files.size(), static_cast<int>(_maxFiles));
 
    for (int i = 0; i < numFiles; ++i)
    {
        QString text = tr("&%1 %2").arg(i + 1).arg(strippedName(files[i]));
        _fileActions[i]->setText(text);
        _fileActions[i]->setData(files[i]);
        _fileActions[i]->setVisible(true);
    }
 
    for (int i = numFiles; i < _maxFiles; ++i)
    {
        _fileActions[i]->setVisible(false);
    }
}

References _fileActions, _maxFiles, _settingsName, and strippedName().

Referenced by RecentFiles(), and setCurrentFile().

Member Data Documentation

_currentFile

QString RecentFiles::_currentFile

private

Definition at line 69 of file RecentFiles.h.

Referenced by setCurrentFile().

_fileActions

QAction* RecentFiles::_fileActions[_maxFiles]

private

Definition at line 72 of file RecentFiles.h.

Referenced by RecentFiles(), and updateRecentFileActions().

_filesMenu

QMenu* RecentFiles::_filesMenu

private

Definition at line 68 of file RecentFiles.h.

Referenced by RecentFiles(), ~RecentFiles(), and menu().

_settingsName

QString RecentFiles::_settingsName

private

Definition at line 70 of file RecentFiles.h.

Referenced by setCurrentFile(), and updateRecentFileActions().

---

The documentation for this class was generated from the following files:

• Applications/DataExplorer/Base/RecentFiles.h
• Applications/DataExplorer/Base/RecentFiles.cpp