Dialog Extended Progress

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

Progress dialog shown for background work More...

Functions
	kodi::gui::dialogs::CExtendedProgress::CExtendedProgress (const std::string &title="")
	kodi::gui::dialogs::CExtendedProgress::~CExtendedProgress ()
std::string	kodi::gui::dialogs::CExtendedProgress::Title () const
	Get the used title.
void	kodi::gui::dialogs::CExtendedProgress::SetTitle (const std::string &title)
	To set the title of dialog.
std::string	kodi::gui::dialogs::CExtendedProgress::Text () const
	Get the used text information string.
void	kodi::gui::dialogs::CExtendedProgress::SetText (const std::string &text)
	To set the used text information string.
bool	kodi::gui::dialogs::CExtendedProgress::IsFinished () const
	To ask dialog is finished.
void	kodi::gui::dialogs::CExtendedProgress::MarkFinished ()
	Mark progress finished.
float	kodi::gui::dialogs::CExtendedProgress::Percentage () const
	Get the current progress position as percent.
void	kodi::gui::dialogs::CExtendedProgress::SetPercentage (float percentage)
	To set the current progress position as percent.
void	kodi::gui::dialogs::CExtendedProgress::SetProgress (int currentItem, int itemCount)
	To set progress position with predefined places.

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()

kodi::gui::dialogs::CExtendedProgress::CExtendedProgress ( const std::string & title = "" )

inlineexplicit

Construct a new dialog.

Parameters

[in]

title

[opt] Title string

IsFinished()

bool kodi::gui::dialogs::CExtendedProgress::IsFinished ( ) const

inline

To ask dialog is finished.

Returns

True if on end

MarkFinished()

void kodi::gui::dialogs::CExtendedProgress::MarkFinished ( )

inline

Mark progress finished.

Percentage()

float kodi::gui::dialogs::CExtendedProgress::Percentage ( ) const

inline

Get the current progress position as percent.

Returns

Position

SetPercentage()

void kodi::gui::dialogs::CExtendedProgress::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 kodi::gui::dialogs::CExtendedProgress::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

SetText()

void kodi::gui::dialogs::CExtendedProgress::SetText ( const std::string & text )

inline

To set the used text information string.

Parameters

[in]

text

Information text to set

SetTitle()

void kodi::gui::dialogs::CExtendedProgress::SetTitle ( const std::string & title )

inline

To set the title of dialog.

Parameters

[in]

title

Title string

Text()

std::string kodi::gui::dialogs::CExtendedProgress::Text ( ) const

inline

Get the used text information string.

Returns

Text string

Title()

std::string kodi::gui::dialogs::CExtendedProgress::Title ( ) const

inline

Get the used title.

Returns

Title string

~CExtendedProgress()

kodi::gui::dialogs::CExtendedProgress::~CExtendedProgress ( )

inline

Destructor.