OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-02-25 18:55:39 -06:00
Code Issues Packages Projects Releases Wiki Activity

Improved documentation of the progressbar class

Browse Source
This commit is contained in:
Jacob Støren 2015-05-29 11:49:44 +02:00
parent 842e3d385f
commit a338c6abda
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Fwk/AppFwk/cafUserInterface/cafProgressInfo.cpp
View File

@ -70,7 +70,9 @@ namespace caf {
//==================================================================================================
//--------------------------------------------------------------------------------------------------
///
/// The title will be written centered in the dialog, under other progress titles in action.
/// If you do not need a title for a particular level, simply pass "" and it will be ignored.
/// \sa setProgressDescription
//--------------------------------------------------------------------------------------------------
ProgressInfo::ProgressInfo(size_t maxProgressValue, const QString& title)
{
@ -97,7 +99,12 @@ ProgressInfo::~ProgressInfo()
//--------------------------------------------------------------------------------------------------
/// Sets a description of the step currently being executed.
/// Used to create a nice text in the progressDialog
/// Used to create a nice text in the progressDialog, by appending " : <your text>"
/// to the current levels title. If no title is requested for this level, the ":" is omitted.
/// So: One line per level that has title and/or description.
/// in the format:
/// <Title>: <Description>
/// The ":" is only there when needed
//--------------------------------------------------------------------------------------------------
void ProgressInfo::setProgressDescription(const QString& description)
{