#include <stfio.h>

Inheritance diagram for stfio::ProgressInfo:

Public Member Functions
	ProgressInfo (const std::string &title, const std::string &message, int maximum, bool verbose)
	Constructor.
virtual bool	Update (int value, const std::string &newmsg="", bool *skip=NULL)=0
	Updates the progress info.

Detailed Description

Abstract class to be used as an interface for the file io read/write functions Can be a GUI Dialog or stdout messages

Definition at line 104 of file stfio.h.

Constructor & Destructor Documentation

stfio::ProgressInfo::ProgressInfo	(	const std::string &	title,
		const std::string &	message,
		int	maximum,
		bool	verbose
	)		`[inline]`

Constructor.

Parameters:

title	Dialog title
message	Message displayed
maximum	Maximum value for the progress meter
verbose	Whether or not to emit a lot of noise

Definition at line 112 of file stfio.h.

virtual bool stfio::ProgressInfo::Update	(	int	value,
		const std::string &	newmsg = `""`,
		bool *	skip = `NULL`
	)		`[pure virtual]`

Updates the progress info.

Parameters:

value	New value of the progress meter
newmsg	New message for the info text
skip	This is set to true if the user has chosen to skip the operation

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