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

#include <Control.h>

Inheritance diagram for XBMCAddon::xbmcgui::Control:
Collaboration diagram for XBMCAddon::xbmcgui::Control:

Public Member Functions

 ~Control () override
 
virtual CGUIControlCreate ()
 
virtual bool canAcceptMessages (int actionId)
 
 getId () inline bool operator
 

Function: getId()


Returns the control's current id as an integer. More...
 
 getX ()
 

Function: getX()


Returns the control's current X position. More...
 
 getY ()
 

Function: getY()


Returns the control's current Y position. More...
 
 getHeight ()
 

Function: getHeight()


Returns the control's current height as an integer. More...
 
 getWidth ()
 

Function: getWidth()


Returns the control's current width as an integer. More...
 
 setEnabled (...)
 

Function: setEnabled(enabled)


Sets the control's enabled/disabled state. More...
 
 setVisible (...)
 

Function: setVisible(visible)


Sets the control's visible/hidden state. More...
 
 isVisible (...)
 

Function: isVisible()


Get the control's visible/hidden state with respect to the container/window More...
 
 setVisibleCondition (...)
 

Function: setVisibleCondition(visible[,allowHiddenFocus])


Sets the control's visible condition. More...
 
 setEnableCondition (...)
 

Function: setEnableCondition(enable)


Sets the control's enabled condition. More...
 
 setAnimations (...)
 

Function: setAnimations([(event, attr,)*])


Sets the control's animations. More...
 
 setPosition (...)
 

Function: setPosition(x, y)


Sets the controls position. More...
 
 setWidth (...)
 

Function: setWidth(width)


Sets the controls width. More...
 
 setHeight (...)
 

Function: setHeight(height)


Sets the controls height. More...
 
 setNavigation (...)
 

Function: setNavigation(up, down, left, right)


Sets the controls navigation. More...
 
 controlUp (...)
 

Function: controlUp(control)


Sets the controls up navigation. More...
 
 controlDown (...)
 

Function: controlDown(control)


Sets the controls down navigation. More...
 
 controlLeft (...)
 

Function: controlLeft(control)


Sets the controls left navigation. More...
 
 controlRight (...)
 

Function: 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

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
 

Protected Member Functions

 Control ()=default
 
- Protected Member Functions inherited from XBMCAddon::AddonClass
virtual void deallocating ()
 

Additional Inherited Members

- Static Public Member Functions inherited from XBMCAddon::AddonClass
static short getNumAddonClasses ()
 
- 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

◆ Control()

XBMCAddon::xbmcgui::Control::Control ( )
protecteddefault

◆ ~Control()

XBMCAddon::xbmcgui::Control::~Control ( )
override

Member Function Documentation

◆ canAcceptMessages()

virtual bool XBMCAddon::xbmcgui::Control::canAcceptMessages ( int  actionId)
inlinevirtual

◆ Create()

Member Data Documentation

◆ dwHeight

int XBMCAddon::xbmcgui::Control::dwHeight = 0

◆ dwPosX

int XBMCAddon::xbmcgui::Control::dwPosX = 0

◆ dwPosY

int XBMCAddon::xbmcgui::Control::dwPosY = 0

◆ dwWidth

int XBMCAddon::xbmcgui::Control::dwWidth = 0

◆ iControlDown

int XBMCAddon::xbmcgui::Control::iControlDown = 0

◆ iControlId

int XBMCAddon::xbmcgui::Control::iControlId = 0

◆ iControlLeft

int XBMCAddon::xbmcgui::Control::iControlLeft = 0

◆ iControlRight

int XBMCAddon::xbmcgui::Control::iControlRight = 0

◆ iControlUp

int XBMCAddon::xbmcgui::Control::iControlUp = 0

◆ iParentId

int XBMCAddon::xbmcgui::Control::iParentId = 0

◆ m_label

std::string XBMCAddon::xbmcgui::Control::m_label {}

◆ m_visible

bool XBMCAddon::xbmcgui::Control::m_visible {true}

◆ pGUIControl

CGUIControl* XBMCAddon::xbmcgui::Control::pGUIControl = nullptr

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