#include <JXStandAlonePG.h>

Inheritance diagram for JXStandAlonePG:

Public Member Functions
	JXStandAlonePG ()

	~JXStandAlonePG () override

bool	ProcessContinuing () override

void	ProcessFinished () override

void	RaiseWhenUpdate (const bool raise=true)

Public Member Functions inherited from JXProgressDisplay
	JXProgressDisplay ()

	~JXProgressDisplay () override

void	SetItems (JXTextButton cancelButton, JXStaticText counter, JXProgressIndicator indicator, JXTEBase label=nullptr)

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

bool	IncrementProgress (const JSize delta) override

bool	IncrementProgress (const JString &message, const JSize delta) 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)

bool	ProcessRunning () const

ProcessType	GetCurrentProcessType () const

JSize	GetCurrentStepCount () const

Public Member Functions inherited from JBroadcaster
	JBroadcaster ()

virtual	~JBroadcaster ()

JBroadcaster &	operator= (const JBroadcaster &source)

bool	HasSenders () const

JSize	GetSenderCount () const

bool	HasRecipients () const

JSize	GetRecipientCount () const

virtual JString	ToString () const

template<class T >
void	ListenTo (const JBroadcaster *sender, const std::function< void(const T &)> &f)

Protected Member Functions
void	ProcessBeginning (const ProcessType processType, const JSize stepCount, const JString &message, const bool allowCancel, const bool modal) override

Protected Member Functions inherited from JXProgressDisplay
virtual void	AppendToMessageWindow (const JString &message)

bool	CheckForCancel () override

void	Receive (JBroadcaster *sender, const Message &message) override

Protected Member Functions inherited from JProgressDisplay
bool	AllowCancel () const

bool	IsModal () const

JSize	GetMaxStepCount () const

void	IncrementStepCount (const JSize delta=1)

Protected Member Functions inherited from JBroadcaster
	JBroadcaster (const JBroadcaster &source)

void	ListenTo (const JBroadcaster *sender)

void	StopListening (const JBroadcaster *sender)

void	ClearWhenGoingAway (const JBroadcaster sender, void pointerToMember)

void	StopListening (const JBroadcaster *sender, const std::type_info &messageType)

template<class T >
void	Send (JBroadcaster *recipient, const T &message)

template<class T >
void	Broadcast (const T &message)

void	SendWithFeedback (JBroadcaster recipient, Message message)

void	BroadcastWithFeedback (Message *message)

virtual void	ReceiveWithFeedback (JBroadcaster sender, Message message)

virtual void	ReceiveGoingAway (JBroadcaster *sender)

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

Static Public Attributes inherited from JXProgressDisplay
static const JUtf8Byte *	kCancelRequested = "CancelRequested::JXProgressDisplay"

Detailed Description

Class to display the progress of a long process in a separate window.

Constructor & Destructor Documentation

◆ JXStandAlonePG()

JXStandAlonePG::JXStandAlonePG ( )

◆ ~JXStandAlonePG()

JXStandAlonePG::~JXStandAlonePG ( )

override

Member Function Documentation

◆ ProcessBeginning()

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

overrideprotectedvirtual

Initialize the data members. Derived classes should create some sort of display to represent the progress.

Reimplemented from JXProgressDisplay.

◆ ProcessContinuing()

bool JXStandAlonePG::ProcessContinuing ( )

overridevirtual

Derived classes should give the system some background time (system dependent) without updating the progress display.

Returns false if process was cancelled by user.

Reimplemented from JXProgressDisplay.

◆ ProcessFinished()

void JXStandAlonePG::ProcessFinished ( )

overridevirtual

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

Reimplemented from JXProgressDisplay.

◆ RaiseWhenUpdate()

void JXStandAlonePG::RaiseWhenUpdate ( const bool raise = true )

inline

This controls whether or not the progress window is raised every time it is updated. This is mainly useful if a process creates new windows, because it can then be very hard for the user to find the progress window and cancel the process.

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

libjx/code/JXStandAlonePG.h
libjx/code/JXStandAlonePG.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ JXStandAlonePG()

◆ ~JXStandAlonePG()

Member Function Documentation

◆ ProcessBeginning()

◆ ProcessContinuing()

◆ ProcessFinished()

◆ RaiseWhenUpdate()