class Progress

Demidify progress callback interface. More...

Contains pure virtuals
Full nameTSE3::Progress
Definition#include <Progress.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods


Detailed Description

Callback interface for TSE3 classes that provide progress information. This is used, for example, by the file import/export mechanisms (see TSE3MDL, MidiFileImport and MidiFileExport) and the Util::Demidify utility.

See also: Demidify

void  progressRange (int min, int max)

progressRange

[pure virtual]

Called by a progress information generator before the first call to progress().

It defines the minimum and maximum values the progress values range between.

Parameters:
minMimumum value returned from progess (i.e. the first value sent)
maxMaximum value returned from progess (i.e. the last value sent)

void  progress (int value)

progress

[pure virtual]

Whilst an operation is being performed by a class that uses the Progress interface, this callback will be intermittantly invoked.

Before it is called for the first time, the progressRange method will be invoked, to give meaning to the value parameter.

Parameters:
valueProgress indication