Control Progress

\cpp_class{ kodi::gui::controls::CProgress } Window control to show the progress of a particular operation More...

Functions
	kodi::gui::controls::CProgress::CProgress (CWindow *window, int controlId)
	Construct a new control. More...
	kodi::gui::controls::CProgress::~CProgress () override=default
	Destructor. More...
void	kodi::gui::controls::CProgress::SetVisible (bool visible)
	Set the control on window to visible. More...
void	kodi::gui::controls::CProgress::SetPercentage (float percent)
	To set Percent position of control. More...
float	kodi::gui::controls::CProgress::GetPercentage () const
	Get the active percent position of progress bar. More...

Detailed Description

\cpp_class{ kodi::gui::controls::CProgress } Window control to show the progress of a particular operation

The progress control is used to show the progress of an item that may take a long time, or to show how far through a movie you are. You can choose the position, size, and look of the progress control.

It has the header #include <kodi/gui/controls/Progress.h> be included to enjoy it.

Here you find the needed skin part for a progress control

Note

The call of the control is only possible from the corresponding window as its class and identification number is required.

Function Documentation

CProgress()

kodi::gui::controls::CProgress::CProgress ( CWindow *  window, int  controlId  )

inline

Construct a new control.

Parameters

[in]	window	related window control class
[in]	controlId	Used skin xml control id

GetPercentage()

float kodi::gui::controls::CProgress::GetPercentage ( ) const

inline

Get the active percent position of progress bar.

Returns

Progress position as percent

SetPercentage()

void kodi::gui::controls::CProgress::SetPercentage ( float  percent )

inline

To set Percent position of control.

Parameters

[in]

percent

The percent position to use

SetVisible()

void kodi::gui::controls::CProgress::SetVisible ( bool  visible )

inline

Set the control on window to visible.

Parameters

[in]

visible

If true visible, otherwise hidden

~CProgress()

kodi::gui::controls::CProgress::~CProgress ( )

overridedefault

Destructor.