omni::ui::RecentSessions Class Reference

Data structure and menu to store default sessions. More...

#include <RecentSessions.h>

Inheritance diagram for omni::ui::RecentSessions:

Collaboration diagram for omni::ui::RecentSessions:

Public Slots
void	clear ()
	Clear list of recent files. More...
void	addFile (QString const &)
	Add a new file to list. More...
void	setNumberOfFiles (int)
	Set maximum number of files. More...
void	setActionStates ()
	Disable action for which file does not exists. More...

Signals
void	fileToBeLoaded (QString const &)

Public Member Functions
	RecentSessions (QObject *=nullptr)
	~RecentSessions ()
QMenu *	menu ()
	Return pointer to menu. More...
void	readFromSettings ()
	Read recent files from settings. More...
void	writeToSettings () const
	Write recent files to settings. More...
int	numberOfFiles () const
	Return maximum number of files. More...

Private Member Functions
void	addFile (QString const &, bool _regenerateMenu)
	Add file and optionally regenerate menu. More...
int	fileInList (QString const &) const
	Return index of file if in list, return -1 if not. More...
void	generateMenu ()
	Generate menu from recent files, create new menu if necessary. More...

Private Attributes
std::deque< QString >	recentFiles_
std::vector< RecentFileAction * >	actions_
QUniquePtr< QMenu >	menu_
int	numberOfFiles_ = 16

Detailed Description

Data structure and menu to store default sessions.

Constructor & Destructor Documentation

omni::ui::RecentSessions::RecentSessions

(

QObject *

_parent = nullptr

)

                                                   : QObject(_parent) {
      generateMenu();
    }

omni::ui::RecentSessions::~RecentSessions

(

)

{}

Member Function Documentation

void omni::ui::RecentSessions::addFile ( QString const &  _file )

slot

Add a new file to list.

                                                     {
      addFile(_file,true);
    }

void omni::ui::RecentSessions::addFile ( QString const &  _file, bool  _regenerateMenu  )

private

Add file and optionally regenerate menu.

                                                                           {
      int _index = fileInList(_file);

      if (_index != -1) {
        recentFiles_.erase(recentFiles_.begin() + _index);
      }

      recentFiles_.push_front(_file);

      if (recentFiles_.size() > numberOfFiles_) {
        recentFiles_.pop_back();
      }

      if (_regenerateMenu) {
        generateMenu();
      }
    }

void omni::ui::RecentSessions::clear ( )

slot

Clear list of recent files.

                               {
      recentFiles_.clear();
      generateMenu();
    }

int omni::ui::RecentSessions::fileInList ( QString const &  _file ) const

private

Return index of file if in list, return -1 if not.

                                                             {
      int _index = 0;

      for (auto& _sessionFile : recentFiles_) {
        if (_sessionFile == _file) return _index;

        ++_index;
      }
      return -1;
    }

void omni::ui::RecentSessions::fileToBeLoaded ( QString const &  )

signal

void omni::ui::RecentSessions::generateMenu ( )

private

Generate menu from recent files, create new menu if necessary.

                                      {
      if (!menu_) {
        menu_.reset(new QMenu());
        connect(menu_.get(),SIGNAL(aboutToShow()),this,SLOT(setActionStates()));
      }

      menu_->clear();
      actions_.clear();

      for (auto& _file : recentFiles_) {
        auto* _action = new RecentFileAction(_file);
        connect(_action,SIGNAL(fileToBeLoaded(QString const&)),
                this,SIGNAL(fileToBeLoaded(QString const&)));
        menu_->addAction(_action);
        actions_.push_back(_action);
      }

      if (!recentFiles_.empty()) {
        menu_->addSeparator();
        auto *_clearAction = menu_->addAction("Clear menu");
        connect(_clearAction, SIGNAL(triggered()), this, SLOT(clear()));
      } else {
        auto *_placeholder = menu_->addAction("No recent files");
        _placeholder->setEnabled(false);
      }
    }

QMenu * omni::ui::RecentSessions::menu

(

)

Return pointer to menu.

                                 {
      return menu_.get();
    }

int omni::ui::RecentSessions::numberOfFiles

(

)

const

Return maximum number of files.

                                            {
      return numberOfFiles_;
    }

void omni::ui::RecentSessions::readFromSettings

(

)

Read recent files from settings.

                                          {

      auto& _settings = Application::settings();

      int _size = _settings.beginReadArray("recentFiles");
      for (int i = 0; i < _size; ++i) {
        _settings.setArrayIndex(i);
        addFile(_settings.value("file").toString(),false);
      }
      _settings.endArray();
      generateMenu();
    }

void omni::ui::RecentSessions::setActionStates ( )

slot

Disable action for which file does not exists.

                                         {
      for (auto& _action : actions_) {
        _action->setState();
      }
    }

void omni::ui::RecentSessions::setNumberOfFiles ( int  _numberOfFiles )

slot

Set maximum number of files.

                                                            {
      numberOfFiles_ = _numberOfFiles;
    }

void omni::ui::RecentSessions::writeToSettings

(

)

const

Write recent files to settings.

                                               {
      auto& _settings = Application::settings();

      _settings.beginWriteArray("recentFiles");
      for (int i = 0; i < recentFiles_.size(); ++i) {
        auto& _file = recentFiles_[i];
        _settings.setArrayIndex(i);
        _settings.setValue("file",_file);
      }
      _settings.endArray();
    }

Field Documentation

std::vector<RecentFileAction*> omni::ui::RecentSessions::actions_

private

QUniquePtr<QMenu> omni::ui::RecentSessions::menu_

private

int omni::ui::RecentSessions::numberOfFiles_ = 16

private

std::deque<QString> omni::ui::RecentSessions::recentFiles_

private

---

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

• src/app/RecentSessions.h
• src/app/RecentSessions.cpp