gui2::UserInteractor Class Reference

Provide save/discard/cancel and similar dialogs on user request. More...

Collaboration diagram for gui2::UserInteractor:

Public Member Functions
	UserInteractor (RecentProjectSettings *settings, QWidget *parent)
std::string	onCreateDirRequest ()
	Returns new directory on disk created by the user via QFileDialog. More...
ModelView::SaveChangesAnswer	onSaveChangesRequest ()
	Returns save/cancel/discard changes choice provided by the user. More...
std::string	onSelectDirRequest ()
	Returns directory on disk selected by the user via QFileDialog. More...

Private Member Functions
std::string	selectDir () const
	Summon dialog to select directory on disk. More...

Private Attributes
QWidget *	m_parent {nullptr}
RecentProjectSettings *	m_settings {nullptr}

Detailed Description

Provide save/discard/cancel and similar dialogs on user request.

Intended to work in pair with ProjectManagerDecorator.

Definition at line 34 of file userinteractor.h.

Constructor & Destructor Documentation

UserInteractor()

gui2::UserInteractor::UserInteractor	(	RecentProjectSettings *	settings,
		QWidget *	parent
	)

Definition at line 40 of file userinteractor.cpp.

    : m_settings(settings), m_parent(parent)
{
}

Member Function Documentation

onCreateDirRequest()

std::string gui2::UserInteractor::onCreateDirRequest

(

)

Returns new directory on disk created by the user via QFileDialog.

Definition at line 68 of file userinteractor.cpp.

{
    auto dirname = selectDir();
 
    if (dirname.empty()) // no valid selection
        return {};
 
    if (!ModelView::Utils::is_empty(dirname)) {
        QMessageBox msgBox;
        msgBox.setText("The selected directory is not empty, choose another one.");
        msgBox.exec();
        return {};
    }
 
    return dirname;
}

References ModelView::Utils::is_empty(), and selectDir().

Here is the call graph for this function:

onSaveChangesRequest()

SaveChangesAnswer gui2::UserInteractor::onSaveChangesRequest

(

)

Returns save/cancel/discard changes choice provided by the user.

Definition at line 88 of file userinteractor.cpp.

{
    static auto translate = answer_map();
 
    QMessageBox msgBox;
    msgBox.setText("The project has been modified.");
    msgBox.setInformativeText("Do you want to save your changes?");
    msgBox.setStandardButtons(QMessageBox::Save | QMessageBox::Discard | QMessageBox::Cancel);
    msgBox.setDefaultButton(QMessageBox::Save);
    auto ret = static_cast<QMessageBox::StandardButton>(msgBox.exec());
    return translate[ret];
}

onSelectDirRequest()

std::string gui2::UserInteractor::onSelectDirRequest

(

)

Returns directory on disk selected by the user via QFileDialog.

Checks if selected directory can be the project directory.

Definition at line 48 of file userinteractor.cpp.

{
    auto dirname = selectDir();
 
    if (dirname.empty()) // no valid selection
        return {};
 
    if (!ModelView::ProjectUtils::IsPossibleProjectDir(dirname)) {
        QMessageBox msgBox;
        msgBox.setText(
            "Selected directory doesn't look like a project directory, choose another one");
        msgBox.exec();
        return {};
    }
 
    return dirname;
}

References ModelView::ProjectUtils::IsPossibleProjectDir(), and selectDir().

Here is the call graph for this function:

selectDir()

std::string gui2::UserInteractor::selectDir ( ) const

private

Summon dialog to select directory on disk.

If selection is not empty, save parent directory for later re-use.

Definition at line 104 of file userinteractor.cpp.

{
    QString dirname = QFileDialog::getExistingDirectory(
        m_parent, "Select directory", m_settings->currentWorkdir(),
        QFileDialog::DontResolveSymlinks | QFileDialog::ShowDirsOnly);
 
    if (!dirname.isEmpty())
        m_settings->updateWorkdirFromSelection(dirname);
 
    return dirname.toStdString();
}

References gui2::RecentProjectSettings::currentWorkdir(), m_parent, m_settings, and gui2::RecentProjectSettings::updateWorkdirFromSelection().

Referenced by onCreateDirRequest(), and onSelectDirRequest().

Here is the call graph for this function:

Member Data Documentation

m_parent

QWidget* gui2::UserInteractor::m_parent {nullptr}

private

Definition at line 48 of file userinteractor.h.

Referenced by selectDir().

m_settings

RecentProjectSettings* gui2::UserInteractor::m_settings {nullptr}

private

Definition at line 47 of file userinteractor.h.

Referenced by selectDir().

---

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

• /home/www/ba/gui2/welcomeview/userinteractor.h
• /home/www/ba/gui2/welcomeview/userinteractor.cpp