Detailed Description

`Class: kodi::gui::dialogs::ExtendedProgress`

Progress dialog shown for background work

The with #include <kodi/gui/dialogs/ExtendedProgress.h> given class are basically used to create Kodi's extended progress.

Example:

#include <kodi/gui/dialogs/ExtendedProgress.h>
 
kodi::gui::dialogs::CExtendedProgress *ext_progress = new kodi::gui::dialogs::CExtendedProgress("Test Extended progress");
ext_progress->SetText("Test progress");
for (unsigned int i = 0; i < 50; i += 10)
{
  ext_progress->SetProgress(i, 100);
  sleep(1);
}
 
ext_progress->SetTitle("Test Extended progress - Second round");
ext_progress->SetText("Test progress - Step 2");
 
for (unsigned int i = 50; i < 100; i += 10)
{
  ext_progress->SetProgress(i, 100);
  sleep(1);
}
delete ext_progress;

Function Documentation

◆ CExtendedProgress()

CExtendedProgress ( const std::string & title = "" )

inlineexplicit

Construct a new dialog.

Parameters

[in] title [opt] Title string

◆ ~CExtendedProgress()

~CExtendedProgress ( )

inline

Destructor.

◆ Title()

std::string Title ( ) const

inline

Get the used title.

Returns: Title string

◆ SetTitle()

void SetTitle ( const std::string & title )

inline

To set the title of dialog.

Parameters

[in] title Title string

◆ Text()

std::string Text ( ) const

inline

Get the used text information string.

Returns: Text string

◆ SetText()

void SetText ( const std::string & text )

inline

To set the used text information string.

Parameters

[in] text Information text to set

◆ IsFinished()

bool IsFinished ( ) const

inline

To ask dialog is finished.

Returns: True if on end

◆ MarkFinished()

void MarkFinished ( )

inline

Mark progress finished.

◆ Percentage()

float Percentage ( ) const

inline

Get the current progress position as percent.

Returns: Position

◆ SetPercentage()

void SetPercentage ( float percentage )

inline

To set the current progress position as percent.

Parameters

[in] percentage Position to use from 0.0 to 100.0

◆ SetProgress()

void SetProgress	(	int	currentItem,
		int	itemCount
	)

inline

To set progress position with predefined places.

Parameters

[in]	currentItem	Place position to use
[in]	itemCount	Amount of used places