GUIHelpers Namespace Reference

Classes
class	Error

Functions
QString	baseName (const QString &fileName)
	Returns base name of file. More...
QString	createUuid ()
QString	currentDateTime ()
QString	fileDir (const QString &fileName)
	Returns file directory from the full file path. More...
QStringList	fromStdStrings (const std::vector< std::string > &container)
QVector< double >	fromStdVector (const std::vector< double > &data)
QString	getBornAgainVersionString ()
QString	getValidFileName (const QString &proposed_name)
	Returns valid file name to be saved on disk. More...
void	information (const QString &title, const QString &text, const QString &detailedText)
void	information (QWidget *parent, const QString &title, const QString &text, const QString &detailedText)
bool	isVersionMatchMinimal (const QString &version, const QString &minimal_version)
	returns true if current BornAgain version match minimal required version More...
bool	okToDelete (QWidget *parent, const QString &title, const QString &text, const QString &detailedText)
bool	parseVersion (const QString &version, int &major_num, int &minor_num, int &patch_num)
	parses version string into 3 numbers, returns true in the case of success More...
bool	question (QWidget *parent, const QString &title, const QString &text, const QString &detailedText, const QString &yesText, const QString &noText)
QString	readTextFile (const QString &fileName)
int	versionCode (const QString &version)
void	warning (const QString &title, const QString &text, const QString &detailedText)
void	warning (QWidget *parent, const QString &title, const QString &text, const QString &detailedText)

Function Documentation

baseName()

QString GUIHelpers::baseName

(

const QString &

fileName

)

Returns base name of file.

Definition at line 204 of file GUIHelpers.cpp.

{
    QFileInfo info(fileName);
    return info.baseName();
}

Referenced by PyImportAssistant::exec().

createUuid()

QString GUIHelpers::createUuid

(

)

Definition at line 242 of file GUIHelpers.cpp.

{
    return QUuid::createUuid().toString();
}

Referenced by InstrumentItem::InstrumentItem(), MaterialItem::MaterialItem(), JobModel::addJob(), MaterialModel::cloneMaterial(), ItemIDFactory::createID(), ModelView::UniqueIdGenerator::generate(), ItemIDFactory::IDSize(), MaterialItemContainer::insertCopy(), and JobModelFunctions::setupJobItemInstrument().

currentDateTime()

QString GUIHelpers::currentDateTime

(

)

Definition at line 210 of file GUIHelpers.cpp.

{
    return QDateTime::currentDateTime().toString("yyyy.MM.dd hh:mm:ss");
    ;
}

Referenced by DataItem::DataItem(), PointwiseAxisItem::PointwiseAxisItem(), OutputDataSaveInfo::createSaved(), FitWorker::durationSince(), PointwiseAxisItem::init(), PointwiseAxisItem::load(), FitSessionController::onFittingFinished(), FitSessionController::onFittingStarted(), JobQueueData::onStartedJob(), JobQueueData::processFinishedJob(), JobWorker::start(), and FitWorker::startFit().

fileDir()

QString GUIHelpers::fileDir

(

const QString &

fileName

)

Returns file directory from the full file path.

Definition at line 193 of file GUIHelpers.cpp.

{
    QFileInfo info(fileName);
    if (info.exists()) {
        return info.dir().path();
    }
    return "";
}

Referenced by RealDataSelectorWidget::importData(), and PyImportAssistant::saveImportDir().

fromStdStrings()

QStringList GUIHelpers::fromStdStrings

(

const std::vector< std::string > &

container

)

Definition at line 233 of file GUIHelpers.cpp.

{
    QStringList result;
    for (std::string str : container) {
        result.append(QString::fromStdString(str));
    }
    return result;
}

Referenced by MinimizerItemCatalog::algorithmDescriptions(), MinimizerItemCatalog::algorithmNames(), PyImportAssistant::getPySampleFunctionName(), and TransformFromDomain::setParticleDistributionItem().

fromStdVector()

QVector< double > GUIHelpers::fromStdVector

(

const std::vector< double > &

data

)

Definition at line 225 of file GUIHelpers.cpp.

{
    QVector<double> result;
    result.reserve(int(data.size()));
    std::copy(data.begin(), data.end(), std::back_inserter(result));
    return result;
}

Referenced by Data1DViewItem::graphData(), DistributionWidget::plot_multiple_values(), SaveProjectionsAssistant::projectionsData(), ProjectionsPlot::setGraphFromItem(), FitObjectiveBuilder::update_fit_parameters(), FitSessionController::updateFitParameterValues(), and FitSessionController::updateLog().

getBornAgainVersionString()

QString GUIHelpers::getBornAgainVersionString

(

)

Definition at line 130 of file GUIHelpers.cpp.

{
    return QString::fromStdString(BornAgain::GetVersionNumber());
}

Referenced by UpdateNotifier::checkForUpdates(), AboutApplicationDialog::createTextLayout(), ProjectDocument::documentVersion(), SplashScreen::drawContents(), ProjectLoadWarningDialog::explanationText(), MainWindow::initApplication(), ApplicationOptions::processOptions(), UpdateNotifier::replyFinished(), SessionModel::save(), and ProjectDocument::writeTo().

getValidFileName()

QString GUIHelpers::getValidFileName

(

const QString &

proposed_name

)

Returns valid file name to be saved on disk.

This name is constructed from proposed_name by replacing all special characters with text representation \ backslash / slash " quote < lessthan

greaterthan

| pipe ? questionmark

Definition at line 144 of file GUIHelpers.cpp.

{
    QString result = proposed_name;
    for (auto it = invalidCharacterMap.begin(); it != invalidCharacterMap.end(); ++it) {
        result.replace(it.key(), it.value());
    }
    return result;
}

information() [1/2]

void GUIHelpers::information	(	const QString &	title,
		const QString &	text,
		const QString &	detailedText
	)

Definition at line 69 of file GUIHelpers.cpp.

{
    information(MainWindow::instance(), title, text, detailedText);
}

References information(), and MainWindow::instance().

Here is the call graph for this function:

information() [2/2]

void GUIHelpers::information	(	QWidget *	parent,
		const QString &	title,
		const QString &	text,
		const QString &	detailedText
	)

Definition at line 54 of file GUIHelpers.cpp.

{
    QScopedPointer<QMessageBox> messageBox(new QMessageBox(parent));
    if (parent)
        messageBox->setWindowModality(Qt::WindowModal);
    messageBox->setWindowTitle(QString("%1 - %2").arg(QApplication::applicationName()).arg(title));
    messageBox->setText(text);
    if (!detailedText.isEmpty())
        messageBox->setInformativeText(detailedText);
    messageBox->setIcon(QMessageBox::Information);
    messageBox->addButton(QMessageBox::Ok);
    messageBox->exec();
}

Referenced by information(), SpecularDataImportWidget::onFormatSelectionChanged(), and PyImportAssistant::populateModels().

isVersionMatchMinimal()

bool GUIHelpers::isVersionMatchMinimal	(	const QString &	version,
		const QString &	minimal_version
	)

returns true if current BornAgain version match minimal required version

Definition at line 187 of file GUIHelpers.cpp.

{
    return versionCode(version) >= versionCode(minimal_version);
}

References versionCode().

Referenced by ProjectDocument::readFrom().

Here is the call graph for this function:

okToDelete()

bool GUIHelpers::okToDelete	(	QWidget *	parent,
		const QString &	title,
		const QString &	text,
		const QString &	detailedText
	)

Definition at line 112 of file GUIHelpers.cpp.

{
    QScopedPointer<QMessageBox> messageBox(new QMessageBox(parent));
    if (parent)
        messageBox->setWindowModality(Qt::WindowModal);
    messageBox->setIcon(QMessageBox::Question);
    messageBox->setWindowTitle(QString("%1 - %2").arg(QApplication::applicationName()).arg(title));
    messageBox->setText(text);
    if (!detailedText.isEmpty())
        messageBox->setInformativeText(detailedText);
    QAbstractButton* deleteButton = messageBox->addButton("&Delete", QMessageBox::AcceptRole);
    messageBox->addButton("Do &Not Delete", QMessageBox::RejectRole);
    messageBox->setDefaultButton(qobject_cast<QPushButton*>(deleteButton));
    messageBox->exec();
    return messageBox->clickedButton() == deleteButton;
}

parseVersion()

bool GUIHelpers::parseVersion	(	const QString &	version,
		int &	major_num,
		int &	minor_num,
		int &	patch_num
	)

parses version string into 3 numbers, returns true in the case of success

Definition at line 154 of file GUIHelpers.cpp.

{
    major_num = minor_num = patch_num = 0;
    bool success(true);
    QStringList nums = version.split(".");
    if (nums.size() != 3)
        return false;
 
    bool ok(false);
    major_num = nums.at(0).toInt(&ok);
    success &= ok;
    minor_num = nums.at(1).toInt(&ok);
    success &= ok;
    patch_num = nums.at(2).toInt(&ok);
    success &= ok;
 
    return success;
}

Referenced by versionCode().

question()

bool GUIHelpers::question	(	QWidget *	parent,
		const QString &	title,
		const QString &	text,
		const QString &	detailedText,
		const QString &	yesText,
		const QString &	noText
	)

Definition at line 94 of file GUIHelpers.cpp.

{
    QScopedPointer<QMessageBox> messageBox(new QMessageBox(parent));
    if (parent)
        messageBox->setWindowModality(Qt::WindowModal);
    messageBox->setWindowTitle(QString("%1 - %2").arg(QApplication::applicationName()).arg(title));
    messageBox->setText(text);
    if (!detailedText.isEmpty())
        messageBox->setInformativeText(detailedText);
    messageBox->setIcon(QMessageBox::Question);
    QAbstractButton* yesButton = messageBox->addButton(yesText, QMessageBox::AcceptRole);
    messageBox->addButton(noText, QMessageBox::RejectRole);
    messageBox->setDefaultButton(qobject_cast<QPushButton*>(yesButton));
    messageBox->exec();
    return messageBox->clickedButton() == yesButton;
}

Referenced by ProjectManager::restoreProjectDialog(), and RealDataSelectorWidget::rotateCurrentItem().

readTextFile()

QString GUIHelpers::readTextFile

(

const QString &

fileName

)

Definition at line 247 of file GUIHelpers.cpp.

{
    QFile file(fileName);
    if (!file.open(QIODevice::ReadOnly | QIODevice::Text))
        throw GUIHelpers::Error("PyImportAssistant::readFile() -> Error. Can't read file '"
                                + fileName + "'");
    QTextStream in(&file);
    return in.readAll();
}

versionCode()

int GUIHelpers::versionCode

(

const QString &

version

)

Definition at line 173 of file GUIHelpers.cpp.

{
    int result(-1);
 
    int ba_major(0), ba_minor(0), ba_patch(0);
    if (!parseVersion(version, ba_major, ba_minor, ba_patch))
        return result;
 
    result = ba_major * 10000 + ba_minor * 100 + ba_patch;
 
    return result;
}

References parseVersion().

Referenced by isVersionMatchMinimal(), and UpdateNotifier::replyFinished().

Here is the call graph for this function:

warning() [1/2]

void GUIHelpers::warning	(	const QString &	title,
		const QString &	text,
		const QString &	detailedText
	)

Definition at line 89 of file GUIHelpers.cpp.

{
    warning(MainWindow::instance(), title, text, detailedText);
}

References MainWindow::instance(), and warning().

Here is the call graph for this function:

warning() [2/2]

void GUIHelpers::warning	(	QWidget *	parent,
		const QString &	title,
		const QString &	text,
		const QString &	detailedText
	)

Definition at line 74 of file GUIHelpers.cpp.

{
    QScopedPointer<QMessageBox> messageBox(new QMessageBox(parent));
    if (parent)
        messageBox->setWindowModality(Qt::WindowModal);
    messageBox->setWindowTitle(QString("%1 - %2").arg(QApplication::applicationName()).arg(title));
    messageBox->setText(text);
    if (!detailedText.isEmpty())
        messageBox->setInformativeText(detailedText);
    messageBox->setIcon(QMessageBox::Warning);
    messageBox->addButton(QMessageBox::Ok);
    messageBox->exec();
}

Referenced by ModelView::ExternalPropertyEditor::buttonClicked(), LinkInstrumentManager::canLinkDataToInstrument(), MainWindow::closeEvent(), RealDataSelectorWidget::importData(), ImportDataUtils::ImportKnownData(), ImportDataUtils::ImportReflectometryData(), SimulationSetupAssistant::isValidSimulationSetup(), PyImportAssistant::readFile(), ProjectManager::riseProjectLoadFailedDialog(), RealSpaceCanvas::savePicture(), SavePlotAssistant::savePlot(), ProjectManager::saveProject(), PyImportAssistant::selectPySampleFunction(), and warning().