Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
PVR::CPVRGUIProgressHandler Class Reference

#include <PVRGUIProgressHandler.h>

Inheritance diagram for PVR::CPVRGUIProgressHandler:
CThread

Public Member Functions

 CPVRGUIProgressHandler ()=delete
 
 CPVRGUIProgressHandler (const std::string &strTitle)
 Creates and asynchronously shows a progress dialog with the given title.
 
 ~CPVRGUIProgressHandler () override=default
 
void UpdateProgress (std::string_view strText, float fProgress)
 Update the progress dialogs's content.
 
void UpdateProgress (std::string_view text, size_t currentValue, size_t maxValue)
 Update the progress dialogs's content.
 

Protected Member Functions

void Process () override
 

Constructor & Destructor Documentation

◆ CPVRGUIProgressHandler() [1/2]

PVR::CPVRGUIProgressHandler::CPVRGUIProgressHandler ( )
delete

◆ CPVRGUIProgressHandler() [2/2]

PVR::CPVRGUIProgressHandler::CPVRGUIProgressHandler ( const std::string & strTitle)
explicit

Creates and asynchronously shows a progress dialog with the given title.

Parameters
strTitleThe title for the progress dialog.

◆ ~CPVRGUIProgressHandler()

PVR::CPVRGUIProgressHandler::~CPVRGUIProgressHandler ( )
overridedefault

Member Function Documentation

◆ Process()

void PVR::CPVRGUIProgressHandler::Process ( void )
overrideprotectedvirtual

Reimplemented from CThread.

◆ UpdateProgress() [1/2]

void PVR::CPVRGUIProgressHandler::UpdateProgress ( std::string_view strText,
float fProgress )

Update the progress dialogs's content.

Parameters
strTextThe new progress text.
fProgressThe new progress value, in a range from 0.0 to 100.0.

◆ UpdateProgress() [2/2]

void PVR::CPVRGUIProgressHandler::UpdateProgress ( std::string_view text,
size_t currentValue,
size_t maxValue )

Update the progress dialogs's content.

Parameters
textThe new progress text.
currentValueThe new current progress value, must be less or equal iMax.
maxValueThe new maximum progress value, must be greater or equal iCurrent.

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