CLONE_CANCEL_REPORTER Class Reference

Inheritance diagram for CLONE_CANCEL_REPORTER:

Public Member Functions
void	SetNumPhases (int) override
	Set the number of phases.
void	AddPhases (int) override
void	BeginPhase (int) override
	Initialize the aPhase virtual zone of the dialog progress bar.
void	AdvancePhase () override
	Use the next available virtual zone of the dialog progress bar.
void	AdvancePhase (const wxString &) override
	Use the next available virtual zone of the dialog progress bar and updates the message.
void	Report (const wxString &) override
	Display aMessage in the progress bar dialog.
void	SetCurrentProgress (double) override
	Set the progress value to aProgress (0..1).
void	SetMaxProgress (int) override
	Fix the value that gives the 100 percent progress bar length (inside the current virtual zone).
void	AdvanceProgress () override
	Increment the progress bar length (inside the current virtual zone).
void	SetTitle (const wxString &) override
	Change the title displayed on the window caption.
bool	IsCancelled () const override
bool	KeepRefreshing (bool=false) override
	Update the UI (if any).
int	Ticks () const
virtual void	SetIndeterminate (bool aIndeterminate)
	Ask for an indeterminate (pulsing) display, for work whose total is not known yet.

Private Attributes
int	m_ticks = 0

Detailed Description

Definition at line 1977 of file test_libgit_backend.cpp.

Member Function Documentation

AddPhases()

void CLONE_CANCEL_REPORTER::AddPhases ( int )

inlineoverridevirtual

Implements PROGRESS_REPORTER.

Definition at line 1981 of file test_libgit_backend.cpp.

AdvancePhase() [1/2]

void CLONE_CANCEL_REPORTER::AdvancePhase ( )

inlineoverridevirtual

Use the next available virtual zone of the dialog progress bar.

Implements PROGRESS_REPORTER.

Definition at line 1983 of file test_libgit_backend.cpp.

AdvancePhase() [2/2]

void CLONE_CANCEL_REPORTER::AdvancePhase ( const wxString & aMessage )

inlineoverridevirtual

Use the next available virtual zone of the dialog progress bar and updates the message.

Implements PROGRESS_REPORTER.

Definition at line 1984 of file test_libgit_backend.cpp.

AdvanceProgress()

void CLONE_CANCEL_REPORTER::AdvanceProgress ( )

inlineoverridevirtual

Increment the progress bar length (inside the current virtual zone).

Implements PROGRESS_REPORTER.

Definition at line 1988 of file test_libgit_backend.cpp.

BeginPhase()

void CLONE_CANCEL_REPORTER::BeginPhase ( int aPhase )

inlineoverridevirtual

Initialize the aPhase virtual zone of the dialog progress bar.

Implements PROGRESS_REPORTER.

Definition at line 1982 of file test_libgit_backend.cpp.

IsCancelled()

bool CLONE_CANCEL_REPORTER::IsCancelled ( ) const

inlineoverridevirtual

Implements PROGRESS_REPORTER.

Definition at line 1990 of file test_libgit_backend.cpp.

KeepRefreshing()

bool CLONE_CANCEL_REPORTER::KeepRefreshing ( bool aWait = false )

inlineoverridevirtual

Update the UI (if any).

Warning

This should only be called from the main thread.

Returns

false if the user cancelled.

Implements PROGRESS_REPORTER.

Definition at line 1992 of file test_libgit_backend.cpp.

References m_ticks.

Report()

void CLONE_CANCEL_REPORTER::Report ( const wxString & aMessage )

inlineoverridevirtual

Display aMessage in the progress bar dialog.

Implements PROGRESS_REPORTER.

Definition at line 1985 of file test_libgit_backend.cpp.

SetCurrentProgress()

void CLONE_CANCEL_REPORTER::SetCurrentProgress ( double aProgress )

inlineoverridevirtual

Set the progress value to aProgress (0..1).

Implements PROGRESS_REPORTER.

Definition at line 1986 of file test_libgit_backend.cpp.

SetIndeterminate()

virtual void PROGRESS_REPORTER::SetIndeterminate ( bool aIndeterminate )

inlinevirtualinherited

Ask for an indeterminate (pulsing) display, for work whose total is not known yet.

Safe to call from a worker thread. Implementations record the request and apply it on the next UI refresh.

Reimplemented in WX_PROGRESS_REPORTER.

Definition at line 79 of file progress_reporter.h.

SetMaxProgress()

void CLONE_CANCEL_REPORTER::SetMaxProgress ( int aMaxProgress )

inlineoverridevirtual

Fix the value that gives the 100 percent progress bar length (inside the current virtual zone).

Implements PROGRESS_REPORTER.

Definition at line 1987 of file test_libgit_backend.cpp.

SetNumPhases()

void CLONE_CANCEL_REPORTER::SetNumPhases ( int aNumPhases )

inlineoverridevirtual

Set the number of phases.

Implements PROGRESS_REPORTER.

Definition at line 1980 of file test_libgit_backend.cpp.

SetTitle()

void CLONE_CANCEL_REPORTER::SetTitle ( const wxString & aTitle )

inlineoverridevirtual

Change the title displayed on the window caption.

Has meaning only for some reporters. Does nothing for others.

Warning

This should only be called from the main thread.

Implements PROGRESS_REPORTER.

Definition at line 1989 of file test_libgit_backend.cpp.

Ticks()

int CLONE_CANCEL_REPORTER::Ticks ( ) const

inline

Definition at line 1998 of file test_libgit_backend.cpp.

References m_ticks.

Referenced by BOOST_AUTO_TEST_CASE().

Member Data Documentation

m_ticks

int CLONE_CANCEL_REPORTER::m_ticks = 0

private

Definition at line 2001 of file test_libgit_backend.cpp.

Referenced by KeepRefreshing(), and Ticks().

---

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

• test_libgit_backend.cpp