Tag Parser  8.0.0
C++ library for reading and writing MP4 (iTunes), ID3, Vorbis, Opus, FLAC and Matroska tags
Public Member Functions | List of all members
TagParser::ProgressFeedback Class Reference

The ProgressFeedback class provides feedback about an ongoing operation via callbacks. More...

#include <progressfeedback.h>

Inheritance diagram for TagParser::ProgressFeedback:
[legend]
Collaboration diagram for TagParser::ProgressFeedback:
[legend]

Public Member Functions

 ProgressFeedback (const Callback &callback, const Callback &percentageOnlyCallback=Callback())
 Constructs a new ProgressFeedback. More...
 
 ProgressFeedback (Callback &&callback, Callback &&percentageOnlyCallback=Callback())
 Constructs a new ProgressFeedback. More...
 
- Public Member Functions inherited from TagParser::BasicProgressFeedback< ProgressFeedback >
 BasicProgressFeedback (const Callback &callback, const Callback &percentageOnlyCallback=Callback())
 Constructs a new BasicProgressFeedback. More...
 
 BasicProgressFeedback (Callback &&callback, Callback &&percentageOnlyCallback=Callback())
 Constructs a new BasicProgressFeedback. More...
 
const std::string & step () const
 Returns the name of the current step (initially empty). More...
 
byte stepPercentage () const
 Returns the percentage of the current step (initially 0, supposed to be a value from 0 to 100). More...
 
byte overallPercentage () const
 Returns the overall percentage (initially 0, supposed to be a value from 0 to 100). More...
 
void updateStep (const std::string &step, byte stepPercentage=0)
 Updates the current step and invokes the first callback specified on construction. More...
 
void updateStep (std::string &&step, byte stepPercentage=0)
 Updates the current step and invokes the first callback specified on construction. More...
 
void updateStepPercentage (byte stepPercentage)
 Updates the current step percentage and invokes the second callback specified on construction (or the first if only one has been specified). More...
 
void updateStepPercentageFromFraction (double stepPercentage)
 Updates the current step percentage and invokes the second callback specified on construction (or the first if only one has been specified). More...
 
void updateOverallPercentage (byte overallPercentage)
 Updates the overall percentage and invokes the second callback specified on construction (or the first if only one has been specified). More...
 

Additional Inherited Members

- Public Types inherited from TagParser::BasicProgressFeedback< ProgressFeedback >
using Callback = std::function< void(ProgressFeedback &feedback)>
 

Detailed Description

The ProgressFeedback class provides feedback about an ongoing operation via callbacks.

Definition at line 159 of file progressfeedback.h.

Constructor & Destructor Documentation

◆ ProgressFeedback() [1/2]

TagParser::ProgressFeedback::ProgressFeedback ( const Callback callback,
const Callback percentageOnlyCallback = Callback() 
)
inline

Constructs a new ProgressFeedback.

It will call callback on the next step and percentageOnlyCallback when only the percentage changes.

Definition at line 170 of file progressfeedback.h.

◆ ProgressFeedback() [2/2]

TagParser::ProgressFeedback::ProgressFeedback ( Callback &&  callback,
Callback &&  percentageOnlyCallback = Callback() 
)
inline

Constructs a new ProgressFeedback.

It will call callback on the next step and percentageOnlyCallback when only the percentage changes.

Definition at line 180 of file progressfeedback.h.


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