ActionManager Class Reference

Class to handle MainWindow's menu and corresponding actions. More...

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	onImportFromPythonScript ()
void	setSessionModelViewActive (bool status)
void	toggleCheckForUpdates (bool status)

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

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

Detailed Description

Class to handle MainWindow's menu and corresponding actions.

Definition at line 28 of file actionmanager.h.

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_importMenu(nullptr)
    , m_runSimulationShortcut(nullptr)
{
    createActions();
    createMenus();
    createGlobalShortcuts();
 
    connect(m_mainWindow, &MainWindow::currentViewChanged, this,
            &ActionManager::onCurrentViewChanged);
}

References createActions(), createGlobalShortcuts(), createMenus(), MainWindow::currentViewChanged(), m_mainWindow, and onCurrentViewChanged().

Here is the call graph for this function:

Member Function Documentation

createActions()

void ActionManager::createActions ( )

private

Definition at line 60 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);
 
    // exit application action
    m_exitAction = new QAction("E&xit Application", this);
    m_exitAction->setShortcuts(QKeySequence::Quit);
    m_exitAction->setStatusTip("Exit the application");
    connect(m_exitAction, &QAction::triggered, m_mainWindow, &MainWindow::close);
 
    // 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 ASSERT, m_aboutAction, m_exitAction, m_mainWindow, m_newAction, m_openAction, m_saveAction, m_saveAsAction, 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 162 of file actionmanager.cpp.

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

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

Referenced by ActionManager().

Here is the call graph for this function:

createMenus()

void ActionManager::createMenus ( )

private

Definition at line 104 of file actionmanager.cpp.

{
    m_menuBar = new QMenuBar(0); // No parent (System menu bar on Mac OS X)
 
    if (!GUI_OS_Utils::HostOsInfo::isMacHost())
        m_mainWindow->setMenuBar(m_menuBar);
 
    // 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);
 
    // Import submenu
    m_fileMenu->addSeparator();
    m_importMenu = m_fileMenu->addMenu("&Import");
    m_importMenu->setToolTipsVisible(true);
    QAction* action = m_importMenu->addAction("&Import from Python script (experimental)");
    action->setToolTip("Import sample from Python script.\n The script should contain a function "
                       "returning a valid multi-layer.");
 
#ifdef BORNAGAIN_PYTHON
    connect(action, &QAction::triggered, this, &ActionManager::onImportFromPythonScript);
    if (GUI_OS_Utils::HostOsInfo::isMacHost())
        if (SysUtils::getenv("PYTHONHOME").empty())
            action->setEnabled(false);
#endif // BORNAGAIN_PYTHON
 
    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_aboutAction);
 
    onCurrentViewChanged();
}

References SysUtils::getenv(), GUI_OS_Utils::HostOsInfo::isMacHost(), m_aboutAction, m_exitAction, m_fileMenu, m_helpMenu, m_importMenu, m_mainWindow, m_menuBar, m_newAction, m_openAction, m_recentProjectsMenu, m_saveAction, m_saveAsAction, m_settingsMenu, m_viewMenu, onAboutToShowFileMenu(), onAboutToShowSettingsMenu(), onAboutToShowViewMenu(), onCurrentViewChanged(), and onImportFromPythonScript().

Referenced by ActionManager().

Here is the call graph for this function:

onAboutApplication

void ActionManager::onAboutApplication ( )

privateslot

Definition at line 254 of file actionmanager.cpp.

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

References m_mainWindow.

Referenced by createActions().

onAboutToShowFileMenu

void ActionManager::onAboutToShowFileMenu ( )

privateslot

Definition at line 170 of file actionmanager.cpp.

{
    m_recentProjectsMenu->clear();
 
    bool hasRecentProjects = false;
    int orderNr = 1;
    for (QString file : m_mainWindow->projectManager()->recentProjects()) {
        hasRecentProjects = true;
        QString actionText = GUI_StringUtils::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_StringUtils::withTildeHomePath().

Referenced by createMenus().

Here is the call graph for this function:

onAboutToShowSettingsMenu

void ActionManager::onAboutToShowSettingsMenu ( )

privateslot

Definition at line 196 of file actionmanager.cpp.

{
    m_settingsMenu->clear();
    QSettings settings;
 
    settings.beginGroup(Constants::S_UPDATES);
    QAction* action = m_settingsMenu->addAction("&Check for Updates");
    action->setToolTip("Checks for updates available on GUI startup.");
    action->setCheckable(true);
    action->setChecked(settings.value(Constants::S_CHECKFORUPDATES, false).toBool());
    connect(action, &QAction::toggled, this, &ActionManager::toggleCheckForUpdates);
    settings.endGroup();
 
    settings.beginGroup(Constants::S_SESSIONMODELVIEW);
    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(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);
 
    m_settingsMenu->setToolTipsVisible(true);
}

References ProjectManager::isAutosaveEnabled(), m_mainWindow, m_settingsMenu, MainWindow::projectManager(), Constants::S_CHECKFORUPDATES, Constants::S_SESSIONMODELVIEW, Constants::S_UPDATES, Constants::S_VIEWISACTIVE, ProjectManager::setAutosaveEnabled(), setSessionModelViewActive(), and toggleCheckForUpdates().

Referenced by createMenus().

Here is the call graph for this function:

onAboutToShowViewMenu

void ActionManager::onAboutToShowViewMenu ( )

privateslot

Definition at line 228 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 260 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:

onImportFromPythonScript

void ActionManager::onImportFromPythonScript ( )

privateslot

Definition at line 268 of file actionmanager.cpp.

{
    PyImportAssistant assistant(m_mainWindow);
    assistant.exec();
}

References PyImportAssistant::exec(), and m_mainWindow.

Referenced by createMenus().

Here is the call graph for this function:

setSessionModelViewActive

void ActionManager::setSessionModelViewActive ( bool  status )

privateslot

Definition at line 245 of file actionmanager.cpp.

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

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

Referenced by onAboutToShowSettingsMenu().

Here is the call graph for this function:

toggleCheckForUpdates

void ActionManager::toggleCheckForUpdates ( bool  status )

privateslot

Definition at line 239 of file actionmanager.cpp.

{
    m_mainWindow->updateNotifier()->setCheckUpdatesFlag(status);
    m_mainWindow->updateNotifier()->checkForUpdates();
}

References UpdateNotifier::checkForUpdates(), m_mainWindow, UpdateNotifier::setCheckUpdatesFlag(), and MainWindow::updateNotifier().

Referenced by onAboutToShowSettingsMenu().

Here is the call graph for this function:

Member Data Documentation

m_aboutAction

QAction* ActionManager::m_aboutAction

private

Definition at line 53 of file actionmanager.h.

Referenced by createActions(), and createMenus().

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 56 of file actionmanager.h.

Referenced by createMenus().

m_helpMenu

QMenu* ActionManager::m_helpMenu

private

Definition at line 60 of file actionmanager.h.

Referenced by createMenus().

m_importMenu

QMenu* ActionManager::m_importMenu

private

Definition at line 61 of file actionmanager.h.

Referenced by createMenus().

m_mainWindow

MainWindow* ActionManager::m_mainWindow

private

Definition at line 46 of file actionmanager.h.

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

m_menuBar

QMenuBar* ActionManager::m_menuBar

private

Definition at line 55 of file actionmanager.h.

Referenced by createMenus().

m_newAction

QAction* ActionManager::m_newAction

private

Definition at line 48 of file actionmanager.h.

Referenced by createActions(), and createMenus().

m_openAction

QAction* ActionManager::m_openAction

private

Definition at line 49 of file actionmanager.h.

Referenced by createActions(), and createMenus().

m_recentProjectsMenu

QMenu* ActionManager::m_recentProjectsMenu

private

Definition at line 59 of file actionmanager.h.

Referenced by createMenus(), and onAboutToShowFileMenu().

m_runSimulationShortcut

QShortcut* ActionManager::m_runSimulationShortcut

private

Definition at line 63 of file actionmanager.h.

Referenced by createGlobalShortcuts().

m_saveAction

QAction* ActionManager::m_saveAction

private

Definition at line 50 of file actionmanager.h.

Referenced by createActions(), and createMenus().

m_saveAsAction

QAction* ActionManager::m_saveAsAction

private

Definition at line 51 of file actionmanager.h.

Referenced by createActions(), and createMenus().

m_settingsMenu

QMenu* ActionManager::m_settingsMenu

private

Definition at line 57 of file actionmanager.h.

Referenced by createMenus(), and onAboutToShowSettingsMenu().

m_viewMenu

QMenu* ActionManager::m_viewMenu

private

Definition at line 58 of file actionmanager.h.

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

---

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

• /home/www/ba/GUI/coregui/mainwindow/actionmanager.h
• /home/www/ba/GUI/coregui/mainwindow/actionmanager.cpp