Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
XBMCAddon::xbmcgui::ControlFadeLabel Class Reference

#include <Control.h>

Inheritance diagram for XBMCAddon::xbmcgui::ControlFadeLabel:
XBMCAddon::xbmcgui::Control XBMCAddon::AddonClass

Public Member Functions

 ControlFadeLabel (long x, long y, long width, long height, const char *font=NULL, const char *textColor=NULL, long _alignment=XBFONT_LEFT)
 
 addLabel (...)
 

Function: addLabel(label)


Add a label to this control for scrolling.
 
 setScrolling (...)
 

Function: setScrolling(scroll)


Set scrolling. If set to false, the labels won't scroll. Defaults to true.
 
 reset ()
 

Function: reset()


Clear this fade label.
 
CGUIControlCreate () override
 
 ControlFadeLabel ()=default
 
- Public Member Functions inherited from XBMCAddon::xbmcgui::Control
 ~Control () override
 
virtual bool canAcceptMessages (int actionId)
 
 getId () inline bool operator
 

Function: getId()


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

Function: getX()


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

Function: getY()


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

Function: getHeight()


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

Function: getWidth()


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

Function: setEnabled(enabled)


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

Function: setVisible(visible)


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

Function: isVisible()


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

Function: setVisibleCondition(visible[,allowHiddenFocus])


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

Function: setEnableCondition(enable)


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

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


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

Function: setPosition(x, y)


Sets the controls position.
 
 setWidth (...)
 

Function: setWidth(width)


Sets the controls width.
 
 setHeight (...)
 

Function: setHeight(height)


Sets the controls height.
 
 setNavigation (...)
 

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


Sets the controls navigation.
 
 controlUp (...)
 

Function: controlUp(control)


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

Function: controlDown(control)


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

Function: controlLeft(control)


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

Function: controlRight(control)


Sets the controls right navigation.
 
- Public Member Functions inherited from XBMCAddon::AddonClass
 AddonClass ()
 
virtual ~AddonClass ()
 
const char * GetClassname () const
 
LanguageHookGetLanguageHook ()
 
bool isDeallocating ()
 
void Release () const
 
void Acquire () const
 

Public Attributes

std::string strFont
 
KODI::UTILS::COLOR::Color textColor
 
std::vector< std::string > vecLabels
 
uint32_t align
 
- 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
 

Constructor & Destructor Documentation

◆ ControlFadeLabel() [1/2]

XBMCAddon::xbmcgui::ControlFadeLabel::ControlFadeLabel ( long x,
long y,
long width,
long height,
const char * font = NULL,
const char * textColor = NULL,
long _alignment = XBFONT_LEFT )

◆ ControlFadeLabel() [2/2]

XBMCAddon::xbmcgui::ControlFadeLabel::ControlFadeLabel ( )
default

Member Function Documentation

◆ Create()

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

Reimplemented from XBMCAddon::xbmcgui::Control.

Member Data Documentation

◆ align

uint32_t XBMCAddon::xbmcgui::ControlFadeLabel::align

◆ strFont

std::string XBMCAddon::xbmcgui::ControlFadeLabel::strFont

◆ textColor

KODI::UTILS::COLOR::Color XBMCAddon::xbmcgui::ControlFadeLabel::textColor

◆ vecLabels

std::vector<std::string> XBMCAddon::xbmcgui::ControlFadeLabel::vecLabels

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