JTextProgressDisplay Class Reference

#include <JTextProgressDisplay.h>

Inheritance diagram for JTextProgressDisplay:

Public Member Functions
	JTextProgressDisplay ()
	~JTextProgressDisplay () override
bool	IncrementProgress (const JString &message=JString::empty) override
bool	IncrementProgress (const JSize delta) override
bool	IncrementProgress (const JString &message, const JSize delta) override
void	ProcessFinished () override
void	DisplayBusyCursor () override
Public Member Functions inherited from JProgressDisplay
	JProgressDisplay ()
virtual	~JProgressDisplay ()
void	FixedLengthProcessBeginning (const JSize stepCount, const JString &message, const bool allowCancel, const bool modal)
void	VariableLengthProcessBeginning (const JString &message, const bool allowCancel, const bool modal)
virtual bool	ProcessContinuing ()
bool	ProcessRunning () const
ProcessType	GetCurrentProcessType () const
JSize	GetCurrentStepCount () const

Protected Member Functions
void	ProcessBeginning (const ProcessType processType, const JSize stepCount, const JString &message, const bool allowCancel, const bool modal) override
bool	CheckForCancel () override
Protected Member Functions inherited from JProgressDisplay
bool	AllowCancel () const
bool	IsModal () const
JSize	GetMaxStepCount () const
void	IncrementStepCount (const JSize delta=1)

Additional Inherited Members
Public Types inherited from JProgressDisplay
enum	ProcessType {   kNoRunningProcess ,   kFixedLengthProcess ,   kVariableLengthProcess }

Detailed Description

Interface for the JTextProgressDisplay class.

Class for displaying the progress of a long process on the console.

Constructor & Destructor Documentation

JTextProgressDisplay()

JTextProgressDisplay::JTextProgressDisplay

(

)

~JTextProgressDisplay()

JTextProgressDisplay::~JTextProgressDisplay ( )

override

Make sure we restore the original signal handler.

Member Function Documentation

CheckForCancel()

bool JTextProgressDisplay::CheckForCancel ( )

overrideprotectedvirtual

Implements JProgressDisplay.

DisplayBusyCursor()

void JTextProgressDisplay::DisplayBusyCursor ( )

overridevirtual

Implements JProgressDisplay.

IncrementProgress() [1/3]

bool JTextProgressDisplay::IncrementProgress ( const JSize  delta )

overridevirtual

The iteration count is incremented by the specified value.

Update the display to show that progress is being made. Returns false if process was cancelled by user.

Implements JProgressDisplay.

IncrementProgress() [2/3]

bool JTextProgressDisplay::IncrementProgress ( const JString &  message, const JSize  delta  )

overridevirtual

Update the display to show that progress is being made. Returns false if process was cancelled by user.

If the current process is of variable length and the message is not nullptr, then it is displayed in place of the usual iteration count.

Implements JProgressDisplay.

IncrementProgress() [3/3]

bool JTextProgressDisplay::IncrementProgress ( const JString &  message = JString::empty )

overridevirtual

Update the display to show that progress is being made. Returns false if process was cancelled by user.

If the current process is of variable length and the message is not nullptr, then it is displayed in place of the usual iteration count.

Implements JProgressDisplay.

ProcessBeginning()

void JTextProgressDisplay::ProcessBeginning ( const ProcessType  processType, const JSize  stepCount, const JString &  message, const bool  allowCancel, const bool  modal  )

overrideprotectedvirtual

Display the message.

Reimplemented from JProgressDisplay.

ProcessFinished()

void JTextProgressDisplay::ProcessFinished ( )

overridevirtual

Derived classes must call this and then clean up the display they created.

Reimplemented from JProgressDisplay.

---

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

• libjcore/code/JTextProgressDisplay.h
• libjcore/code/JTextProgressDisplay.cpp