ActionManager.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/View/Main/ActionManager.cpp
//! @brief     Implements class ActionManager
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2021
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#include "GUI/View/Main/ActionManager.h"
#include "Base/Util/Assert.h"
#include "Base/Util/SysUtils.h"
#include "GUI/Application/ApplicationSettings.h"
#include "GUI/Model/Data/SessionData.h"
#include "GUI/Util/Path.h"
#include "GUI/View/Job/JobView.h"
#include "GUI/View/Main/AboutDialog.h"
#include "GUI/View/Main/MainWindow.h"
#include "GUI/View/Project/ProjectManager.h"
#include "GUI/View/SampleDesigner/SampleView.h"
#include "GUI/View/Tool/mainwindow_constants.h"
#include <QDesktopServices>
#include <QDir>
#include <QMenuBar>
#include <QSettings>
#include <QShortcut>
#include <QUrl>
 
ActionManager::ActionManager(MainWindow* parent)
    : QObject(parent)
    , m_mainWindow(parent)
    , m_newAction(nullptr)
    , m_openAction(nullptr)
    , m_saveAction(nullptr)
    , m_saveAsAction(nullptr)
    , m_exitAction(nullptr)
    , m_aboutAction(nullptr)
    , m_menuBar(nullptr)
    , m_fileMenu(nullptr)
    , m_settingsMenu(nullptr)
    , m_viewMenu(nullptr)
    , m_recentProjectsMenu(nullptr)
    , m_helpMenu(nullptr)
    , m_simulateShortcut(nullptr)
{
    createActions();
    createMenus();
    createGlobalShortcuts();
 
    connect(m_mainWindow, &MainWindow::currentViewChanged, this,
            &ActionManager::onCurrentViewChanged);
 
    connect(ProjectManager::instance(), &ProjectManager::documentOpenedOrClosed, this,
            &ActionManager::updateActionEnabling);
 
    updateActionEnabling();
}
 
void ActionManager::updateActionEnabling()
{
    const bool documentExists = gSessionData->projectDocument.has_value();
    m_saveAction->setEnabled(documentExists);
    m_saveAsAction->setEnabled(documentExists);
    m_closeProjectAction->setEnabled(documentExists);
}
 
void ActionManager::createActions()
{
    ProjectManager* projectManager = m_mainWindow->projectManager();
    ASSERT(projectManager);
 
    // new project action
    m_newAction = new QAction("&New Project", m_mainWindow);
    m_newAction->setShortcuts(QKeySequence::New);
    m_newAction->setStatusTip("Create a new project");
    connect(m_newAction, &QAction::triggered, projectManager, &ProjectManager::newProject);
 
    // open project action
    m_openAction = new QAction("&Open Project", m_mainWindow);
    m_openAction->setShortcuts(QKeySequence::Open);
    m_openAction->setStatusTip("Open an existing project");
    connect(m_openAction, &QAction::triggered, projectManager,
            [projectManager]() { projectManager->openProject(); });
 
    // save project action
    m_saveAction = new QAction("&Save Project", m_mainWindow);
    m_saveAction->setShortcuts(QKeySequence::Save);
    m_saveAction->setStatusTip("Save project");
    m_saveAction->setShortcutContext(Qt::ApplicationShortcut);
    connect(m_saveAction, &QAction::triggered, projectManager,
            [projectManager]() { projectManager->saveProject(); });
 
    // save-as project action
    m_saveAsAction = new QAction("Save &As...", m_mainWindow);
    m_saveAsAction->setShortcuts(QKeySequence::SaveAs);
    m_saveAsAction->setStatusTip("Save project under different name");
    connect(m_saveAsAction, &QAction::triggered, projectManager, &ProjectManager::saveProjectAs);
 
    // close project action
    m_closeProjectAction = new QAction("Close Project", m_mainWindow);
    m_closeProjectAction->setStatusTip("Save project under different name");
    connect(m_closeProjectAction, &QAction::triggered, projectManager,
            &ProjectManager::closeCurrentProject);
 
    // exit application action
    m_exitAction = new QAction("&Quit", this);
    m_exitAction->setShortcuts(QKeySequence::Quit);
    m_exitAction->setStatusTip("Exit the application");
    connect(m_exitAction, &QAction::triggered, m_mainWindow, &MainWindow::close);
 
    // visit web doc action
    m_webdocAction = new QAction("&Visit web docs", this);
    m_webdocAction->setStatusTip("Open BornAgain documentation in default browser");
    connect(m_webdocAction, &QAction::triggered, this,
            []() { QDesktopServices::openUrl(QUrl("https://www.bornagainproject.org/latest")); });
 
    // about application action
    m_aboutAction = new QAction("&About BornAgain", this);
    m_aboutAction->setStatusTip("About the application");
    connect(m_aboutAction, &QAction::triggered, this, &ActionManager::onAboutApplication);
}
 
void ActionManager::createMenus()
{
    m_menuBar = new QMenuBar(nullptr); // No parent (System menu bar on Mac OS X)
 
#ifndef Q_OS_MAC
    m_mainWindow->setMenuBar(m_menuBar);
#endif
 
    // File Menu
    m_fileMenu = m_menuBar->addMenu("&File");
    m_fileMenu->addAction(m_newAction);
    m_fileMenu->addAction(m_openAction);
    connect(m_fileMenu, &QMenu::aboutToShow, this, &ActionManager::onAboutToShowFileMenu);
 
    m_recentProjectsMenu = m_fileMenu->addMenu("&Recent Projects");
 
    m_fileMenu->addSeparator();
    m_fileMenu->addAction(m_saveAction);
    m_fileMenu->addAction(m_saveAsAction);
    m_fileMenu->addAction(m_closeProjectAction);
 
    m_fileMenu->addSeparator();
    m_fileMenu->addAction(m_exitAction);
 
    // Settings Menu
    m_settingsMenu = new QMenu("&Settings", m_mainWindow);
    onAboutToShowSettingsMenu(); // MacOS feature: action should exist already, otherwise menuBar
                                 // will not add menu
    connect(m_settingsMenu, &QMenu::aboutToShow, this, &ActionManager::onAboutToShowSettingsMenu);
    m_menuBar->addMenu(m_settingsMenu);
 
    // View menu
    m_viewMenu = new QMenu("&View", m_mainWindow);
    onAboutToShowViewMenu(); // MacOS feature: action should exist already, otherwise menuBar will
                             // not add menu
    connect(m_viewMenu, &QMenu::aboutToShow, this, &ActionManager::onAboutToShowViewMenu);
    m_menuBar->addMenu(m_viewMenu);
 
    // Help Menu
    m_helpMenu = m_menuBar->addMenu("&Help");
    m_helpMenu->addAction(m_webdocAction);
    m_helpMenu->addAction(m_aboutAction);
 
    onCurrentViewChanged();
}
 
void ActionManager::createGlobalShortcuts()
{
    m_simulateShortcut = new QShortcut(QKeySequence("Ctrl+r"), m_mainWindow);
    m_simulateShortcut->setContext((Qt::ApplicationShortcut));
    connect(m_simulateShortcut, &QShortcut::activated, m_mainWindow,
            &MainWindow::onRunSimulationShortcut);
}
 
void ActionManager::onAboutToShowFileMenu()
{
    m_recentProjectsMenu->clear();
 
    bool hasRecentProjects = false;
    int orderNr = 1;
    for (const QString& file : m_mainWindow->projectManager()->recentProjects()) {
        hasRecentProjects = true;
        QString actionText = GUI::Util::Path::withTildeHomePath(QDir::toNativeSeparators(file));
        if (orderNr < 10)
            actionText = QString("&%1 ").arg(orderNr) + actionText;
        QAction* action = m_recentProjectsMenu->addAction(actionText);
        action->setData(QVariant::fromValue(file));
        connect(action, &QAction::triggered, m_mainWindow, &MainWindow::openRecentProject);
        orderNr++;
    }
    m_recentProjectsMenu->setEnabled(hasRecentProjects);
 
    if (hasRecentProjects) {
        m_recentProjectsMenu->addSeparator();
        QAction* action = m_recentProjectsMenu->addAction("&Clear Menu");
        connect(action, &QAction::triggered, m_mainWindow->projectManager(),
                &ProjectManager::clearRecentProjects);
    }
}
 
void ActionManager::onAboutToShowSettingsMenu()
{
    m_settingsMenu->clear();
    m_settingsMenu->setToolTipsVisible(true);
 
    QSettings settings;
 
    settings.beginGroup(GUI::Constants::S_SESSIONMODELVIEW);
    QAction* action = m_settingsMenu->addAction("&Model tech view");
    action->setToolTip("Additional developer's view will appear in left control tab bar");
    action->setCheckable(true);
    action->setChecked(settings.value(GUI::Constants::S_VIEWISACTIVE, false).toBool());
    connect(action, &QAction::toggled, this, &ActionManager::setSessionModelViewActive);
    settings.endGroup();
 
    action = m_settingsMenu->addAction("&Enable autosave");
    action->setToolTip("Project will be saved periodically in project's autosave directory.\n"
                       "When opening project, recover option will be suggested, if possible.");
    action->setCheckable(true);
    action->setChecked(m_mainWindow->projectManager()->isAutosaveEnabled());
    connect(action, &QAction::toggled, m_mainWindow->projectManager(),
            &ProjectManager::setAutosaveEnabled);
 
    action = m_settingsMenu->addAction("&Create project on startup");
    action->setCheckable(true);
    action->setChecked(appSettings->createNewProjectOnStartup());
    connect(action, &QAction::toggled,
            [](bool b) { appSettings->setCreateNewProjectOnStartup(b); });
 
    m_settingsMenu->addSeparator();
 
    auto* unitActions = new QActionGroup(this);
    const auto addUnitAction = [=](const QString& text, bool isAngstrom) {
        auto* action = m_settingsMenu->addAction(
            text, [=]() { appSettings->setDefaultUnitIsAngstrom(isAngstrom); });
        action->setCheckable(true);
        action->setChecked(appSettings->defaultUnitIsAngstrom() == isAngstrom);
        unitActions->addAction(action);
    };
 
    addUnitAction("Lengths in nanometer", false);
    addUnitAction(u8"Lengths in \u00c5ngstrom", true);
 
    m_settingsMenu->addSeparator();
 
    auto* styleActions = new QActionGroup(this);
    const auto addStyleAction = [=](const QString& text, ApplicationSettings::Style style) {
        auto* action = m_settingsMenu->addAction(text, [=]() {
            appSettings->setStyleToUse(style);
            appSettings->loadStyle(style);
        });
        action->setCheckable(true);
        action->setChecked(appSettings->currentStyle() == style);
        styleActions->addAction(action);
    };
 
    addStyleAction("Native style", ApplicationSettings::Style::native);
    addStyleAction("Light style", ApplicationSettings::Style::light);
 
    // The following menu entry is commented since the dark style is not completed so far. Once it
    // is complete, just uncomment the line. See also issue #220
    //
    // addStyleAction("Dark style", ApplicationSettings::Style::dark);
}
 
void ActionManager::onAboutToShowViewMenu()
{
    m_viewMenu->clear();
 
    auto* view = m_mainWindow->currentView();
    if (auto* sampleView = dynamic_cast<SampleView*>(view); sampleView != nullptr)
        sampleView->fillViewMenu(m_viewMenu);
    if (auto* jobView = dynamic_cast<JobView*>(view); jobView != nullptr)
        jobView->fillViewMenu(m_viewMenu);
}
 
void ActionManager::setSessionModelViewActive(bool status)
{
    QSettings settings;
    settings.beginGroup(GUI::Constants::S_SESSIONMODELVIEW);
    settings.setValue(GUI::Constants::S_VIEWISACTIVE, status);
    settings.endGroup();
    m_mainWindow->onSessionModelViewActive(status);
}
 
void ActionManager::onAboutApplication()
{
    AboutDialog dialog(m_mainWindow);
    dialog.exec();
}
 
void ActionManager::onCurrentViewChanged()
{
    // not every view support view menu entries -> hide it, if empty
    onAboutToShowViewMenu();
    m_viewMenu->menuAction()->setVisible(!m_viewMenu->actions().isEmpty());
}