DISPLIB::ProgressView Class Reference

Labelled QProgressBar with optional auto-hide on completion. More...

#include <progressview.h>

Public Slots
void	setMessage (const QString &sMessage)
void	updateProgress (int iPercentage, const QString &sMessage="")
void	setLoadingBarVisible (bool bVisible)

Public Member Functions
	ProgressView (bool bHorizontalMessage=false, const QString &sStyleSheet="")
	~ProgressView ()
virtual void	saveSettings ()
virtual void	loadSettings ()
virtual void	updateGuiMode (GuiMode mode)
virtual void	updateProcessingMode (ProcessingMode mode)
void	setHorizontal ()
void	setVertical ()
void	setTextStyleSheet (const QString &styleSheet)
void	clearView ()
Public Member Functions inherited from DISPLIB::AbstractView
	AbstractView (QWidget *parent=0, Qt::WindowFlags f=Qt::Widget)
virtual void	setGuiMode (GuiMode mode)
virtual void	setProcessingMode (ProcessingMode mode)

Additional Inherited Members
Public Types inherited from DISPLIB::AbstractView
enum	StyleMode { Default , Dark }
enum	GuiMode { Clinical , Research }
enum	ProcessingMode { RealTime , Offline }
typedef QSharedPointer< AbstractView >	SPtr
typedef QSharedPointer< const AbstractView >	ConstSPtr
Signals inherited from DISPLIB::AbstractView
void	guiStyleChanged (DISPLIB::AbstractView::StyleMode style)
Protected Attributes inherited from DISPLIB::AbstractView
bool	m_bResearchModeIsActive
bool	m_bOfflineModeIsActive
QString	m_sSettingsPath

Detailed Description

Labelled QProgressBar with optional auto-hide on completion.

Standard progress widget used by DISPLIB plugins to report long-running jobs (BEM solving, recording write-out, …).

Definition at line 53 of file progressview.h.

Inheritance diagram for DISPLIB::ProgressView:

Constructor & Destructor Documentation

ProgressView()

ProgressView::ProgressView	(	bool	bHorizontalMessage = false,
		const QString &	sStyleSheet = "" )

Creates an instance of a ProgressView object

Parameters

[in]	bHorizontalMessage	Whether message id beside(true) or under(false) the loading bar.
[in]	sStyleSheet	Set the stylesheet of the QLabels that display the loading message.

Definition at line 31 of file progressview.cpp.

~ProgressView()

ProgressView::~ProgressView

(

)

Deletes this instance of a ProgressView object

Definition at line 56 of file progressview.cpp.

Member Function Documentation

clearView()

void ProgressView::clearView ( )

virtual

Clears the view

Implements DISPLIB::AbstractView.

Definition at line 142 of file progressview.cpp.

loadSettings()

void ProgressView::loadSettings ( )

virtual

Loads and inits all important settings of this view via QSettings.

Implements DISPLIB::AbstractView.

Definition at line 69 of file progressview.cpp.

saveSettings()

void ProgressView::saveSettings ( )

virtual

Saves all important settings of this view via QSettings.

Implements DISPLIB::AbstractView.

Definition at line 63 of file progressview.cpp.

setHorizontal()

void ProgressView::setHorizontal

(

)

Sets message to appear next to loading bar

Definition at line 89 of file progressview.cpp.

setLoadingBarVisible

void ProgressView::setLoadingBarVisible ( bool bVisible )

slot

Sets whether loading bar is visible

Parameters

[in]

bVisible

whether the bar visible - True = visible, False = hidden.

Definition at line 131 of file progressview.cpp.

setMessage

void ProgressView::setMessage ( const QString & sMessage )

slot

Dsiplays a new message below/beside the loading bar

Parameters

[in]

sMessage

message to be displayed.

Definition at line 105 of file progressview.cpp.

setTextStyleSheet()

void DISPLIB::ProgressView::setTextStyleSheet

(

const QString &

styleSheet

)

Sets stylesheet parameters for the QLabels that display loading message

Parameters

[in]

styleSheet

string with parameters for the QLabels.

setVertical()

void ProgressView::setVertical

(

)

Sets message to appear under the loading bar

Definition at line 97 of file progressview.cpp.

updateGuiMode()

void ProgressView::updateGuiMode ( GuiMode mode )

virtual

Update the views GUI based on the set GuiMode (Clinical=0, Research=1).

Parameters

[in]

mode

The new mode (Clinical=0, Research=1).

Implements DISPLIB::AbstractView.

Definition at line 75 of file progressview.cpp.

updateProcessingMode()

void ProgressView::updateProcessingMode ( ProcessingMode mode )

virtual

Update the views GUI based on the set ProcessingMode (RealTime=0, Offline=1).

Parameters

[in]

mode

The new mode (RealTime=0, Offline=1).

Implements DISPLIB::AbstractView.

Definition at line 82 of file progressview.cpp.

updateProgress

void ProgressView::updateProgress ( int iPercentage, const QString & sMessage = "" )

slot

Sets new completion percentage and updates message

Parameters

[in]	iPercentage	percentage to show on the loading bar.
[in]	sMessage	message to be displayed.

Definition at line 113 of file progressview.cpp.

---

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

• src/libraries/disp/viewers/progressview.h
• src/libraries/disp/viewers/progressview.cpp