ActionManager Class Reference

Description

Class to handle MainWindow's menu and corresponding actions.

Definition at line 28 of file ActionManager.h.

Inheritance diagram for ActionManager:

Collaboration diagram for ActionManager:

Public Member Functions
	ActionManager (MainWindow *parent)

Private Slots
void	onAboutApplication ()
void	onAboutToShowFileMenu ()
void	onAboutToShowSettingsMenu ()
void	onAboutToShowViewMenu ()
void	onCurrentViewChanged ()
void	setSessionModelViewActive (bool status)

Private Member Functions
void	createActions ()
void	createGlobalShortcuts ()
void	createMenus ()
void	updateActionEnabling ()

Private Attributes
QAction *	m_aboutAction
QAction *	m_closeProjectAction
QAction *	m_exitAction
QMenu *	m_fileMenu
QMenu *	m_helpMenu
MainWindow *	m_mainWindow
QMenuBar *	m_menuBar
QAction *	m_newAction
QAction *	m_openAction
QMenu *	m_recentProjectsMenu
QAction *	m_saveAction
QAction *	m_saveAsAction
QMenu *	m_settingsMenu
QShortcut *	m_simulateShortcut
QMenu *	m_viewMenu
QAction *	m_webdocAction

Constructor & Destructor Documentation

ActionManager()

ActionManager::ActionManager

(

MainWindow *

parent

)

Definition at line 34 of file ActionManager.cpp.

    : 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();
}

References createActions(), createGlobalShortcuts(), createMenus(), MainWindow::currentViewChanged(), ProjectManager::documentOpenedOrClosed(), ProjectManager::instance(), m_mainWindow, onCurrentViewChanged(), and updateActionEnabling().

Here is the call graph for this function:

Member Function Documentation

createActions()

void ActionManager::createActions ( )

private

Definition at line 72 of file ActionManager.cpp.

{
    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);
}

References ProjectManager::closeCurrentProject(), m_aboutAction, m_closeProjectAction, m_exitAction, m_mainWindow, m_newAction, m_openAction, m_saveAction, m_saveAsAction, m_webdocAction, ProjectManager::newProject(), onAboutApplication(), ProjectManager::openProject(), MainWindow::projectManager(), ProjectManager::saveProject(), and ProjectManager::saveProjectAs().

Referenced by ActionManager().

Here is the call graph for this function:

createGlobalShortcuts()

void ActionManager::createGlobalShortcuts ( )

private

Definition at line 174 of file ActionManager.cpp.

{
    m_simulateShortcut = new QShortcut(QKeySequence("Ctrl+r"), m_mainWindow);
    m_simulateShortcut->setContext((Qt::ApplicationShortcut));
    connect(m_simulateShortcut, &QShortcut::activated, m_mainWindow,
            &MainWindow::onRunSimulationShortcut);
}

References m_mainWindow, m_simulateShortcut, and MainWindow::onRunSimulationShortcut().

Referenced by ActionManager().

Here is the call graph for this function:

createMenus()

void ActionManager::createMenus ( )

private

Definition at line 128 of file ActionManager.cpp.

{
    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();
}

References m_aboutAction, m_closeProjectAction, m_exitAction, m_fileMenu, m_helpMenu, m_mainWindow, m_menuBar, m_newAction, m_openAction, m_recentProjectsMenu, m_saveAction, m_saveAsAction, m_settingsMenu, m_viewMenu, m_webdocAction, onAboutToShowFileMenu(), onAboutToShowSettingsMenu(), onAboutToShowViewMenu(), and onCurrentViewChanged().

Referenced by ActionManager().

Here is the call graph for this function:

onAboutApplication

void ActionManager::onAboutApplication ( )

privateslot

Definition at line 293 of file ActionManager.cpp.

{
    AboutDialog dialog(m_mainWindow);
    dialog.exec();
}

References m_mainWindow.

Referenced by createActions().

onAboutToShowFileMenu

void ActionManager::onAboutToShowFileMenu ( )

privateslot

Definition at line 182 of file ActionManager.cpp.

{
    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);
    }
}

References ProjectManager::clearRecentProjects(), m_mainWindow, m_recentProjectsMenu, MainWindow::openRecentProject(), MainWindow::projectManager(), ProjectManager::recentProjects(), and GUI::Util::Path::withTildeHomePath().

Referenced by createMenus().

Here is the call graph for this function:

onAboutToShowSettingsMenu

void ActionManager::onAboutToShowSettingsMenu ( )

privateslot

Definition at line 208 of file ActionManager.cpp.

{
    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);
}

References appSettings, ApplicationSettings::createNewProjectOnStartup(), ApplicationSettings::currentStyle(), ApplicationSettings::defaultUnitIsAngstrom(), ProjectManager::isAutosaveEnabled(), ApplicationSettings::light, ApplicationSettings::loadStyle(), m_mainWindow, m_settingsMenu, ApplicationSettings::native, MainWindow::projectManager(), GUI::Constants::S_SESSIONMODELVIEW, GUI::Constants::S_VIEWISACTIVE, ProjectManager::setAutosaveEnabled(), ApplicationSettings::setCreateNewProjectOnStartup(), ApplicationSettings::setDefaultUnitIsAngstrom(), setSessionModelViewActive(), and ApplicationSettings::setStyleToUse().

Referenced by createMenus().

Here is the call graph for this function:

onAboutToShowViewMenu

void ActionManager::onAboutToShowViewMenu ( )

privateslot

Definition at line 273 of file ActionManager.cpp.

{
    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);
}

References MainWindow::currentView(), m_mainWindow, and m_viewMenu.

Referenced by createMenus(), and onCurrentViewChanged().

Here is the call graph for this function:

onCurrentViewChanged

void ActionManager::onCurrentViewChanged ( )

privateslot

Definition at line 299 of file ActionManager.cpp.

{
    // not every view support view menu entries -> hide it, if empty
    onAboutToShowViewMenu();
    m_viewMenu->menuAction()->setVisible(!m_viewMenu->actions().isEmpty());
}

References m_viewMenu, and onAboutToShowViewMenu().

Referenced by ActionManager(), and createMenus().

Here is the call graph for this function:

setSessionModelViewActive

void ActionManager::setSessionModelViewActive ( bool  status )

privateslot

Definition at line 284 of file ActionManager.cpp.

{
    QSettings settings;
    settings.beginGroup(GUI::Constants::S_SESSIONMODELVIEW);
    settings.setValue(GUI::Constants::S_VIEWISACTIVE, status);
    settings.endGroup();
    m_mainWindow->onSessionModelViewActive(status);
}

References m_mainWindow, MainWindow::onSessionModelViewActive(), GUI::Constants::S_SESSIONMODELVIEW, and GUI::Constants::S_VIEWISACTIVE.

Referenced by onAboutToShowSettingsMenu().

Here is the call graph for this function:

updateActionEnabling()

void ActionManager::updateActionEnabling ( )

private

Definition at line 64 of file ActionManager.cpp.

{
    const bool documentExists = gSessionData->projectDocument.has_value();
    m_saveAction->setEnabled(documentExists);
    m_saveAsAction->setEnabled(documentExists);
    m_closeProjectAction->setEnabled(documentExists);
}

References gSessionData, m_closeProjectAction, m_saveAction, m_saveAsAction, and SessionData::projectDocument.

Referenced by ActionManager().

Member Data Documentation

m_aboutAction

QAction* ActionManager::m_aboutAction

private

Definition at line 54 of file ActionManager.h.

Referenced by createActions(), and createMenus().

m_closeProjectAction

QAction* ActionManager::m_closeProjectAction

private

Definition at line 51 of file ActionManager.h.

Referenced by createActions(), createMenus(), and updateActionEnabling().

m_exitAction

QAction* ActionManager::m_exitAction

private

Definition at line 52 of file ActionManager.h.

Referenced by createActions(), and createMenus().

m_fileMenu

QMenu* ActionManager::m_fileMenu

private

Definition at line 57 of file ActionManager.h.

Referenced by createMenus().

m_helpMenu

QMenu* ActionManager::m_helpMenu

private

Definition at line 61 of file ActionManager.h.

Referenced by createMenus().

m_mainWindow

MainWindow* ActionManager::m_mainWindow

private

Definition at line 45 of file ActionManager.h.

Referenced by ActionManager(), createActions(), createGlobalShortcuts(), createMenus(), onAboutApplication(), onAboutToShowFileMenu(), onAboutToShowSettingsMenu(), onAboutToShowViewMenu(), and setSessionModelViewActive().

m_menuBar

QMenuBar* ActionManager::m_menuBar

private

Definition at line 56 of file ActionManager.h.

Referenced by createMenus().

m_newAction

QAction* ActionManager::m_newAction

private

Definition at line 47 of file ActionManager.h.

Referenced by createActions(), and createMenus().

m_openAction

QAction* ActionManager::m_openAction

private

Definition at line 48 of file ActionManager.h.

Referenced by createActions(), and createMenus().

m_recentProjectsMenu

QMenu* ActionManager::m_recentProjectsMenu

private

Definition at line 60 of file ActionManager.h.

Referenced by createMenus(), and onAboutToShowFileMenu().

m_saveAction

QAction* ActionManager::m_saveAction

private

Definition at line 49 of file ActionManager.h.

Referenced by createActions(), createMenus(), and updateActionEnabling().

m_saveAsAction

QAction* ActionManager::m_saveAsAction

private

Definition at line 50 of file ActionManager.h.

Referenced by createActions(), createMenus(), and updateActionEnabling().

m_settingsMenu

QMenu* ActionManager::m_settingsMenu

private

Definition at line 58 of file ActionManager.h.

Referenced by createMenus(), and onAboutToShowSettingsMenu().

m_simulateShortcut

QShortcut* ActionManager::m_simulateShortcut

private

Definition at line 63 of file ActionManager.h.

Referenced by createGlobalShortcuts().

m_viewMenu

QMenu* ActionManager::m_viewMenu

private

Definition at line 59 of file ActionManager.h.

Referenced by createMenus(), onAboutToShowViewMenu(), and onCurrentViewChanged().

m_webdocAction

QAction* ActionManager::m_webdocAction

private

Definition at line 53 of file ActionManager.h.

Referenced by createActions(), and createMenus().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Main/ActionManager.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Main/ActionManager.cpp