Gui::SequencerDialog Class Reference

#include <ProgressDialog.h>

Inheritance diagram for Gui::SequencerDialog:

Public Member Functions
bool	isBlocking () const
	Returns true if the running sequencer is blocking any user input.
void	pause ()
	Breaks the sequencer if needed.
void	resume ()
	Continues with progress.
Static Public Member Functions
static SequencerDialog *	instance ()
Protected Member Functions
void	nextStep (bool canAbort)
	Increase the step indicator of the progress dialog.
void	resetData ()
	Resets the sequencer.
	SequencerDialog ()
	Construction.
void	setText (const char *pszTxt)
	Puts text to the progress dialog.
void	showRemainingTime ()
void	startStep ()
	Starts the progress dialog.
	~SequencerDialog ()
	Destruction.
Friends
class	ProgressDialog

Detailed Description

Definition at line 38 of file ProgressDialog.h.

Constructor & Destructor Documentation

SequencerDialog::SequencerDialog ( ) [protected]

Construction.

Definition at line 55 of file ProgressDialog.cpp.

References Gui::SequencerDialogPrivate::dlg, Gui::getMainWindow(), Gui::SequencerDialogPrivate::guiThread, and ProgressDialog.

Referenced by instance().

SequencerDialog::~SequencerDialog ( ) [protected]

Destruction.

Definition at line 62 of file ProgressDialog.cpp.

Member Function Documentation

SequencerDialog * SequencerDialog::instance ( void ) [static]

Definition at line 47 of file ProgressDialog.cpp.

References SequencerDialog().

bool SequencerDialog::isBlocking ( ) const [virtual]

Returns true if the running sequencer is blocking any user input.

This might be only of interest of the GUI where the progress bar or dialog is used from a thread. If started from a thread this method should return false, otherwise true. The default implementation always returns true.

Reimplemented from Base::SequencerBase.

Definition at line 264 of file ProgressDialog.cpp.

References Gui::SequencerDialogPrivate::guiThread.

void SequencerDialog::nextStep ( bool canAbort ) [protected, virtual]

Increase the step indicator of the progress dialog.

Reimplemented from Base::SequencerBase.

Definition at line 114 of file ProgressDialog.cpp.

References Gui::ProgressDialog::canAbort(), Gui::SequencerDialogPrivate::dlg, Base::SequencerBase::nProgress, pause(), Base::SequencerBase::rejectCancel(), resume(), and Base::SequencerBase::wasCanceled().

void SequencerDialog::pause ( ) [virtual]

Breaks the sequencer if needed.

The default implementation does nothing. Every pause() must eventually be followed by a corresponding resume().