Inkscape::Async::SubProgress< T, S > Class Template Reference

A Progress object representing a sub-task of another Progress. More...

#include <progress.h>

Inheritance diagram for Inkscape::Async::SubProgress< T, S >:

Public Member Functions
	SubProgress (Progress< T, S... > &parent, T from, T amount)
	Construct a progress object for a sub-task.
Public Member Functions inherited from Inkscape::Async::Progress< T, S... >
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().

Private Member Functions
bool	_keepgoing () const override
bool	_report (T const &progress, S const &... aux) override

Private Attributes
Progress< T, S... > *	_root
T	_from
T	_amount

Additional Inherited Members
Protected Member Functions inherited from Inkscape::Async::Progress< T, S... >
	~Progress ()=default
virtual bool	_report (T const &... progress)=0

Detailed Description

template<typename T, typename... S>
class Inkscape::Async::SubProgress< T, S >

A Progress object representing a sub-task of another Progress.

Definition at line 50 of file progress.h.

Constructor & Destructor Documentation

SubProgress()

template<typename T , typename... S>

Inkscape::Async::SubProgress< T, S >::SubProgress ( Progress< T, S... > &  parent, T  from, T  amount  )

inline

Construct a progress object for a sub-task.

Definition at line 55 of file progress.h.

References Inkscape::Async::SubProgress< T, S >::_amount, Inkscape::Async::SubProgress< T, S >::_from, Inkscape::Async::SubProgress< T, S >::_root, and parent.

Member Function Documentation

_keepgoing()

template<typename T , typename... S>

bool Inkscape::Async::SubProgress< T, S >::_keepgoing ( ) const

inlineoverrideprivatevirtual

Implements Inkscape::Async::Progress< T, S... >.

Definition at line 72 of file progress.h.

References Inkscape::Async::SubProgress< T, S >::_root, and Inkscape::Async::Progress< T >::keepgoing().

_report()

template<typename T , typename... S>

bool Inkscape::Async::SubProgress< T, S >::_report ( T const &  progress, S const &...  aux  )

inlineoverrideprivate

Definition at line 73 of file progress.h.

References Inkscape::Async::SubProgress< T, S >::_amount, Inkscape::Async::SubProgress< T, S >::_from, Inkscape::Async::SubProgress< T, S >::_root, and Inkscape::Async::Progress< T >::report().

Member Data Documentation

_amount

template<typename T , typename... S>

T Inkscape::Async::SubProgress< T, S >::_amount

private

Definition at line 70 of file progress.h.

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

_from

template<typename T , typename... S>

T Inkscape::Async::SubProgress< T, S >::_from

private

Definition at line 70 of file progress.h.

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

_root

template<typename T , typename... S>

Progress<T, S...>* Inkscape::Async::SubProgress< T, S >::_root

private

Definition at line 69 of file progress.h.

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

---

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

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