Control Image

Class: kodi::gui::controls::CImage

Window control used to show an image.
The image control is used for displaying images in Kodi. You can choose the position, size, transparency and contents of the image to be displayed. More...

Functions
	kodi::gui::controls::CImage::CImage (CWindow *window, int controlId)
	Construct a new control.
	kodi::gui::controls::CImage::~CImage () override=default
	Destructor.
void	kodi::gui::controls::CImage::SetVisible (bool visible)
	Set the control on window to visible.
void	kodi::gui::controls::CImage::SetFileName (const std::string &filename, bool useCache=true)
	To set the filename used on image control.
void	kodi::gui::controls::CImage::SetColorDiffuse (uint32_t colorDiffuse)
	To set set the diffuse color on image.

Detailed Description

Class: kodi::gui::controls::CImage

Window control used to show an image.
The image control is used for displaying images in Kodi. You can choose the position, size, transparency and contents of the image to be displayed.

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

Here you find the needed skin part for a image control.

Note

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

Function Documentation

CImage()

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

inline

Construct a new control.

Parameters

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

SetColorDiffuse()

void kodi::gui::controls::CImage::SetColorDiffuse ( uint32_t colorDiffuse )

inline

To set set the diffuse color on image.

Parameters

[in]

colorDiffuse

Color to use for diffuse

SetFileName()

void kodi::gui::controls::CImage::SetFileName ( const std::string & filename, bool useCache = true )

inline

To set the filename used on image control.

Parameters

[in]	filename	Image file to use
[in]	useCache	To define storage of image, default is in cache, if false becomes it loaded always on changes again

SetVisible()

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

inline

Set the control on window to visible.

Parameters

[in]

visible

If true visible, otherwise hidden

~CImage()

kodi::gui::controls::CImage::~CImage ( )

overridedefault

Destructor.