Inkscape::Async::Progress< T > Class Template Reference

An interface for tasks to report progress and check for cancellation. More...

#include <progress.h>

Public Member Functions
bool	report (T const &... progress)
	Report a progress value, returning false if cancelled.
void	report_or_throw (T const &... progress)
	Report a progress value, throwing CancelledException if cancelled.
bool	keepgoing () const
	Return whether not cancelled.
void	throw_if_cancelled () const
	Throw CancelledException if cancelled.
	operator bool () const
	Convenience function - same as check().

Protected Member Functions
	~Progress ()=default
virtual bool	_keepgoing () const =0
virtual bool	_report (T const &... progress)=0

Detailed Description

template<typename... T>
class Inkscape::Async::Progress< T >

An interface for tasks to report progress and check for cancellation.

Not supported:

• Error reporting - use exceptions!
• Thread-safety - overrides should provide this if needed using e.g. BackgroundProgress.

Definition at line 22 of file progress.h.

Constructor & Destructor Documentation

~Progress()

template<typename... T>

Inkscape::Async::Progress< T >::~Progress ( )

protecteddefault

Member Function Documentation

_keepgoing()

template<typename... T>

virtual bool Inkscape::Async::Progress< T >::_keepgoing ( ) const

protectedpure virtual

Implemented in Inkscape::Async::BackgroundProgress< T >, Inkscape::Async::SubProgress< T, S >, Inkscape::Async::ProgressStepThrottler< T, S >, Inkscape::Async::ProgressTimeThrottler< T >, and Inkscape::Async::ProgressAlways< T >.

Referenced by Inkscape::Async::Progress< T >::keepgoing(), Inkscape::Async::Progress< T >::operator bool(), and Inkscape::Async::Progress< T >::throw_if_cancelled().

_report()

template<typename... T>

virtual bool Inkscape::Async::Progress< T >::_report ( T const &...  progress )

protectedpure virtual

Implemented in Inkscape::Async::BackgroundProgress< T >, and Inkscape::Async::ProgressTimeThrottler< T >.

Referenced by Inkscape::Async::Progress< T >::report(), and Inkscape::Async::Progress< T >::report_or_throw().

keepgoing()

template<typename... T>

bool Inkscape::Async::Progress< T >::keepgoing ( ) const

inline

Return whether not cancelled.

Definition at line 32 of file progress.h.

References Inkscape::Async::Progress< T >::_keepgoing().

Referenced by Inkscape::Async::SubProgress< T, S >::_keepgoing(), Inkscape::Async::ProgressStepThrottler< T, S >::_keepgoing(), Inkscape::Async::ProgressTimeThrottler< T >::_keepgoing(), Inkscape::Async::ProgressTimeThrottler< T >::_report(), and Inkscape::Async::ProgressStepThrottler< T, S >::_report().

operator bool()

template<typename... T>

Inkscape::Async::Progress< T >::operator bool ( ) const

inline

Convenience function - same as check().

Definition at line 38 of file progress.h.

References Inkscape::Async::Progress< T >::_keepgoing().

report()

template<typename... T>

bool Inkscape::Async::Progress< T >::report ( T const &...  progress )

inline

Report a progress value, returning false if cancelled.

Definition at line 26 of file progress.h.

References Inkscape::Async::Progress< T >::_report().

Referenced by Inkscape::Async::ProgressTimeThrottler< T >::_report(), Inkscape::Async::SubProgress< T, S >::_report(), and Inkscape::Async::ProgressStepThrottler< T, S >::_report().

report_or_throw()

template<typename... T>

void Inkscape::Async::Progress< T >::report_or_throw ( T const &...  progress )

inline

Report a progress value, throwing CancelledException if cancelled.

Definition at line 29 of file progress.h.

References Inkscape::Async::Progress< T >::_report().

Referenced by Inkscape::Trace::Siox::extractForeground(), Inkscape::Trace::Depixelize::DepixelizeTracingEngine::trace(), and Inkscape::Trace::Potrace::PotraceTracingEngine::traceSingle().

throw_if_cancelled()

template<typename... T>

void Inkscape::Async::Progress< T >::throw_if_cancelled ( ) const

inline

Throw CancelledException if cancelled.

Definition at line 35 of file progress.h.

References Inkscape::Async::Progress< T >::_keepgoing().

Referenced by Inkscape::Trace::Potrace::PotraceTracingEngine::grayMapToPath(), and Inkscape::Trace::Potrace::PotraceTracingEngine::writePaths().

---

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

• /builds/inkscape/inkscape/src/async/progress.h