Kodi Documentation
Kodi is an open source media player and entertainment hub.
XBMCAddon::xbmcgui::ControlImage Class Reference

#include <Control.h>

Inheritance diagram for XBMCAddon::xbmcgui::ControlImage:
Collaboration diagram for XBMCAddon::xbmcgui::ControlImage:

Public Member Functions

 ControlImage (long x, long y, long width, long height, const char *filename, long aspectRatio=0, const char *colorDiffuse=NULL)
 
 setImage (...)
 { setImage(filename[, useCache]) } Changes the image. More...
 
 setColorDiffuse (...)
 { setColorDiffuse(colorDiffuse) } Changes the images color. More...
 
 ControlImage ()=default
 
CGUIControlCreate () override
 
- Public Member Functions inherited from XBMCAddon::xbmcgui::Control
 ~Control () override
 
virtual bool canAcceptMessages (int actionId)
 
 getId () inline bool operator
 { getId() } Returns the control's current id as an integer. More...
 
 getX ()
 { getX() } Returns the control's current X position. More...
 
 getY ()
 { getY() } Returns the control's current Y position. More...
 
 getHeight ()
 { getHeight() } Returns the control's current height as an integer. More...
 
 getWidth ()
 { getWidth() } Returns the control's current width as an integer. More...
 
 setEnabled (...)
 { setEnabled(enabled) } Sets the control's enabled/disabled state. More...
 
 setVisible (...)
 { setVisible(visible) } Sets the control's visible/hidden state. More...
 
 isVisible (...)
 { isVisible() } Get the control's visible/hidden state with respect to the container/window More...
 
 setVisibleCondition (...)
 { setVisibleCondition(visible[,allowHiddenFocus]) } Sets the control's visible condition. More...
 
 setEnableCondition (...)
 { setEnableCondition(enable) } Sets the control's enabled condition. More...
 
 setAnimations (...)
 { setAnimations([(event, attr,)*]) } Sets the control's animations. More...
 
 setPosition (...)
 { setPosition(x, y) } Sets the controls position. More...
 
 setWidth (...)
 { setWidth(width) } Sets the controls width. More...
 
 setHeight (...)
 { setHeight(height) } Sets the controls height. More...
 
 setNavigation (...)
 { setNavigation(up, down, left, right) } Sets the controls navigation. More...
 
 controlUp (...)
 { controlUp(control) } Sets the controls up navigation. More...
 
 controlDown (...)
 { controlDown(control) } Sets the controls down navigation. More...
 
 controlLeft (...)
 { controlLeft(control) } Sets the controls left navigation. More...
 
 controlRight (...)
 { controlRight(control) } Sets the controls right navigation. More...
 
- Public Member Functions inherited from XBMCAddon::AddonClass
 AddonClass ()
 
virtual ~AddonClass ()
 
const char * GetClassname () const
 
LanguageHookGetLanguageHook ()
 
bool isDeallocating ()
 
void Release () const
 
void Acquire () const
 
- Public Member Functions inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
 CountingLockable ()=default
 
void lock ()
 
bool try_lock ()
 
void unlock ()
 
unsigned int exit (unsigned int leave=0)
 
void restore (unsigned int restoreCount)
 
XbmcThreads::CRecursiveMutex & get_underlying ()
 

Public Attributes

std::string strFileName
 
int aspectRatio = 0
 
UTILS::COLOR::Color colorDiffuse
 
- Public Attributes inherited from XBMCAddon::xbmcgui::Control
int iControlId = 0
 
int iParentId = 0
 
int dwPosX = 0
 
int dwPosY = 0
 
int dwWidth = 0
 
int dwHeight = 0
 
int iControlUp = 0
 
int iControlDown = 0
 
int iControlLeft = 0
 
int iControlRight = 0
 
std::string m_label {}
 
bool m_visible {true}
 
CGUIControlpGUIControl = nullptr
 

Additional Inherited Members

- Static Public Member Functions inherited from XBMCAddon::AddonClass
static short getNumAddonClasses ()
 
- Protected Member Functions inherited from XBMCAddon::xbmcgui::Control
 Control ()=default
 
- Protected Member Functions inherited from XBMCAddon::AddonClass
virtual void deallocating ()
 
- Static Protected Member Functions inherited from XBMCAddon::AddonClass
static short getNextClassIndex ()
 
- Protected Attributes inherited from XBMCAddon::AddonClass
LanguageHooklanguageHook
 
- Protected Attributes inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
XbmcThreads::CRecursiveMutex mutex
 
unsigned int count
 

Constructor & Destructor Documentation

◆ ControlImage() [1/2]

XBMCAddon::xbmcgui::ControlImage::ControlImage ( long  x,
long  y,
long  width,
long  height,
const char *  filename,
long  aspectRatio = 0,
const char *  colorDiffuse = NULL 
)

◆ ControlImage() [2/2]

XBMCAddon::xbmcgui::ControlImage::ControlImage ( )
default

Member Function Documentation

◆ Create()

CGUIControl * XBMCAddon::xbmcgui::ControlImage::Create ( )
overridevirtual

Reimplemented from XBMCAddon::xbmcgui::Control.

Member Data Documentation

◆ aspectRatio

int XBMCAddon::xbmcgui::ControlImage::aspectRatio = 0

◆ colorDiffuse

UTILS::COLOR::Color XBMCAddon::xbmcgui::ControlImage::colorDiffuse

◆ strFileName

std::string XBMCAddon::xbmcgui::ControlImage::strFileName

The documentation for this class was generated from the following files: