Control Fade Label

Class: kodi::gui::controls::CFadeLabel

Window control used to show multiple pieces of text in the same position, by fading from one to the other
The fade label control is used for displaying multiple pieces of text in the same space in Kodi. More...

Functions
	kodi::gui::controls::CFadeLabel::CFadeLabel (CWindow *window, int controlId)
	Construct a new control.
	kodi::gui::controls::CFadeLabel::~CFadeLabel () override=default
	Destructor.
void	kodi::gui::controls::CFadeLabel::SetVisible (bool visible)
	Set the control on window to visible.
void	kodi::gui::controls::CFadeLabel::AddLabel (const std::string &label)
	To add additional text string on fade label.
std::string	kodi::gui::controls::CFadeLabel::GetLabel () const
	Get the used text from button.
void	kodi::gui::controls::CFadeLabel::SetScrolling (bool scroll)
	To enable or disable scrolling on fade label.
void	kodi::gui::controls::CFadeLabel::Reset ()
	To reset al inserted labels.

Detailed Description

Class: kodi::gui::controls::CFadeLabel

Window control used to show multiple pieces of text in the same position, by fading from one to the other
The fade label control is used for displaying multiple pieces of text in the same space in Kodi.

You can choose the font, size, colour, location and contents of the text to be displayed. The first piece of information to display fades in over 50 frames, then scrolls off to the left. Once it is finished scrolling off screen, the second piece of information fades in and the process repeats. A fade label control is not supported in a list container.

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

Here you find the needed skin part for a fade label control.

Note

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

Function Documentation

AddLabel()

void kodi::gui::controls::CFadeLabel::AddLabel ( const std::string & label )

inline

To add additional text string on fade label.

Parameters

[in]

label

Text to show

CFadeLabel()

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

inline

Construct a new control.

Parameters

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

GetLabel()

std::string kodi::gui::controls::CFadeLabel::GetLabel ( ) const

inline

Get the used text from button.

Returns

Text shown

Reset()

void kodi::gui::controls::CFadeLabel::Reset ( )

inline

To reset al inserted labels.

SetScrolling()

void kodi::gui::controls::CFadeLabel::SetScrolling ( bool scroll )

inline

To enable or disable scrolling on fade label.

Parameters

[in]

scroll

To enable scrolling set to true, otherwise is disabled

SetVisible()

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

inline

Set the control on window to visible.

Parameters

[in]

visible

If true visible, otherwise hidden

~CFadeLabel()

kodi::gui::controls::CFadeLabel::~CFadeLabel ( )

overridedefault

Destructor.