Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
kodi::gui::dialogs::CProgress Class Reference

#include <Progress.h>

Public Member Functions

 CProgress ()
 Construct a new dialog.
 
 ~CProgress ()
 Destructor.
 
void Open ()
 To open the dialog.
 
void SetHeading (const std::string &heading)
 Set the heading title of dialog.
 
void SetLine (unsigned int iLine, const std::string &line)
 To set the line text field on dialog from 0 - 2.
 
void SetCanCancel (bool canCancel)
 To enable and show cancel button on dialog.
 
bool IsCanceled () const
 To check dialog for clicked cancel button.
 
void SetPercentage (int percentage)
 Get the current progress position as percent.
 
int GetPercentage () const
 To set the current progress position as percent.
 
void ShowProgressBar (bool onOff)
 To show or hide progress bar dialog.
 
void SetProgressMax (int max)
 Set the maximum position of progress, needed if SetProgressAdvance(...) is used.
 
void SetProgressAdvance (int steps=1)
 To increase progress bar by defined step size until reach of maximum position.
 
bool Abort ()
 To check progress was canceled on work.
 

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