Tag Parser  7.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::AbortableProgressFeedback Class Reference

#include <progressfeedback.h>

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

Public Member Functions

 AbortableProgressFeedback (const Callback &callback, const Callback &percentageOnlyCallback=Callback())
 
 AbortableProgressFeedback (Callback &&callback, Callback &&percentageOnlyCallback=Callback())
 
bool isAborted () const
 
void tryToAbort ()
 
void stopIfAborted () const
 
void nextStepOrStop (const std::string &step, byte stepPercentage=0)
 
void nextStepOrStop (std::string &&step, byte stepPercentage=0)
 
- Public Member Functions inherited from TagParser::BasicProgressFeedback< AbortableProgressFeedback >
 BasicProgressFeedback (const Callback &callback, const Callback &percentageOnlyCallback=Callback())
 
 BasicProgressFeedback (Callback &&callback, Callback &&percentageOnlyCallback=Callback())
 
const std::string & step () const
 
byte stepPercentage () const
 
byte overallPercentage () const
 
void updateStep (const std::string &step, byte stepPercentage=0)
 
void updateStep (std::string &&step, byte stepPercentage=0)
 
void updateStepPercentage (byte stepPercentage)
 
void updateStepPercentageFromFraction (double stepPercentage)
 
void updateOverallPercentage (byte overallPercentage)
 

Additional Inherited Members

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

Detailed Description

Definition at line 132 of file progressfeedback.h.

Constructor & Destructor Documentation

◆ AbortableProgressFeedback() [1/2]

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

Definition at line 147 of file progressfeedback.h.

◆ AbortableProgressFeedback() [2/2]

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

Definition at line 153 of file progressfeedback.h.

Member Function Documentation

◆ isAborted()

bool TagParser::AbortableProgressFeedback::isAborted ( ) const
inline

Definition at line 159 of file progressfeedback.h.

◆ nextStepOrStop() [1/2]

void TagParser::AbortableProgressFeedback::nextStepOrStop ( const std::string &  step,
byte  stepPercentage = 0 
)
inline

Definition at line 176 of file progressfeedback.h.

◆ nextStepOrStop() [2/2]

void TagParser::AbortableProgressFeedback::nextStepOrStop ( std::string &&  step,
byte  stepPercentage = 0 
)
inline

Definition at line 184 of file progressfeedback.h.

◆ stopIfAborted()

void TagParser::AbortableProgressFeedback::stopIfAborted ( ) const
inline

Definition at line 169 of file progressfeedback.h.

◆ tryToAbort()

void TagParser::AbortableProgressFeedback::tryToAbort ( )
inline

Definition at line 164 of file progressfeedback.h.


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