Kodi Development  20.0
for Binary and Script based Add-Ons

Detailed Description

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

CProgress ( CWindow window,
int  controlId 
)
inline

Construct a new control.

Parameters
[in]windowRelated window control class
[in]controlIdUsed skin xml control id

◆ ~CProgress()

~CProgress ( )
overridedefault

Destructor.

◆ SetVisible()

void SetVisible ( bool  visible)
inline

Set the control on window to visible.

Parameters
[in]visibleIf true visible, otherwise hidden

◆ SetPercentage()

void SetPercentage ( float  percent)
inline

To set Percent position of control.

Parameters
[in]percentThe percent position to use

◆ GetPercentage()

float GetPercentage ( ) const
inline

Get the active percent position of progress bar.

Returns
Progress position as percent