Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CGUIFadeLabelControl Class Reference

#include <GUIFadeLabelControl.h>

Inheritance diagram for CGUIFadeLabelControl:
CGUIControl

Public Member Functions

 CGUIFadeLabelControl (int parentID, int controlID, float posX, float posY, float width, float height, const CLabelInfo &labelInfo, bool scrollOut, unsigned int timeToDelayAtEnd, bool resetOnLabelChange, bool randomized)
 
 CGUIFadeLabelControl (const CGUIFadeLabelControl &from)
 
 ~CGUIFadeLabelControl (void) override
 
CGUIFadeLabelControlClone () const override
 
void Process (unsigned int currentTime, CDirtyRegionList &dirtyregions) override
 
void Render () override
 
bool CanFocus () const override
 
bool OnMessage (CGUIMessage &message) override
 
void AssignDepth () override
 
void SetInfo (const std::vector< KODI::GUILIB::GUIINFO::CGUIInfoLabel > &vecInfo)
 
void SetScrolling (bool scroll)
 
bool AllLabelsShown () const
 
- Public Member Functions inherited from CGUIControl
 CGUIControl ()
 
 CGUIControl (int parentID, int controlID, float posX, float posY, float width, float height)
 
 CGUIControl (const CGUIControl &)
 
virtual ~CGUIControl (void)
 
virtual void DoProcess (unsigned int currentTime, CDirtyRegionList &dirtyregions)
 
virtual void DoRender ()
 
virtual void RenderEx ()
 
bool HasProcessed () const
 Returns whether or not we have processed.
 
virtual bool OnAction (const CAction &action)
 
virtual void OnUp ()
 
virtual void OnDown ()
 
virtual void OnLeft ()
 
virtual void OnRight ()
 
virtual bool OnBack ()
 
virtual bool OnInfo ()
 
virtual void OnNextControl ()
 
virtual void OnPrevControl ()
 
virtual void OnFocus ()
 
virtual void OnUnFocus ()
 
virtual EVENT_RESULT SendMouseEvent (const CPoint &point, const KODI::MOUSE::CMouseEvent &event)
 React to a mouse event.
 
virtual EVENT_RESULT OnMouseEvent (const CPoint &point, const KODI::MOUSE::CMouseEvent &event)
 Perform a mouse action.
 
virtual void UnfocusFromPoint (const CPoint &point)
 Unfocus the control if the given point on screen is not within it's boundary.
 
virtual bool HitTest (const CPoint &point) const
 Used to test whether the point is inside a control.
 
virtual int GetID (void) const
 
virtual void SetID (int id)
 
int GetParentID () const
 
virtual bool HasFocus () const
 
virtual void AllocResources ()
 
virtual void FreeResources (bool immediately=false)
 
virtual void DynamicResourceAlloc (bool bOnOff)
 
virtual bool IsDynamicallyAllocated ()
 
virtual bool IsVisible () const
 
bool IsVisibleFromSkin () const
 
virtual bool IsDisabled () const
 
virtual void SetPosition (float posX, float posY)
 
virtual void SetHitRect (const CRect &rect, const KODI::UTILS::COLOR::Color &color)
 
virtual void SetCamera (const CPoint &camera)
 
virtual void SetStereoFactor (const float &factor)
 
bool SetColorDiffuse (const KODI::GUILIB::GUIINFO::CGUIInfoColor &color)
 
CPoint GetRenderPosition () const
 
virtual float GetXPosition () const
 
virtual float GetYPosition () const
 
virtual float GetWidth () const
 
virtual float GetHeight () const
 
void MarkDirtyRegion (const unsigned int dirtyState=DIRTY_STATE_CONTROL)
 
bool IsControlDirty () const
 
const CRectGetRenderRegion () const
 return the render region in screen coordinates of this control
 
virtual CRect CalcRenderRegion () const
 calculate the render region in parentcontrol coordinates of this control Called during process to update m_renderRegion
 
void SetActions (const ActionMap &actions)
 
void SetAction (int actionID, const CGUIAction &action, bool replace=true)
 Set actions to perform on navigation Navigations are set if replace is true or if there is no previously set action.
 
CGUIAction GetAction (int actionID) const
 Get an action the control can be perform.
 
bool Navigate (int direction) const
 Start navigating in given direction.
 
virtual void SetFocus (bool focus)
 
virtual void SetWidth (float width)
 
virtual void SetHeight (float height)
 
virtual void SetVisible (bool bVisible, bool setVisState=false)
 
void SetVisibleCondition (const std::string &expression, const std::string &allowHiddenFocus="")
 
bool HasVisibleCondition () const
 
void SetEnableCondition (const std::string &expression)
 
virtual void UpdateVisibility (const CGUIListItem *item)
 
virtual void SetInitialVisibility ()
 
virtual void SetEnabled (bool bEnable)
 
virtual void SetInvalid ()
 
virtual void SetPulseOnSelect (bool pulse)
 
virtual std::string GetDescriptionByIndex (int index) const
 
void SetAnimations (const std::vector< CAnimation > &animations)
 
const std::vector< CAnimation > & GetAnimations () const
 
virtual void QueueAnimation (ANIMATION_TYPE anim)
 
virtual bool IsAnimating (ANIMATION_TYPE anim)
 
virtual bool HasAnimation (ANIMATION_TYPE anim)
 
CAnimationGetAnimation (ANIMATION_TYPE type, bool checkConditions=true)
 
virtual void ResetAnimation (ANIMATION_TYPE type)
 
virtual void ResetAnimations ()
 
virtual void UpdateInfo (const CGUIListItem *item=NULL)
 
virtual void SetPushUpdates (bool pushUpdates)
 
virtual bool IsGroup () const
 
virtual bool IsContainer () const
 
virtual bool GetCondition (int condition, int data) const
 
void SetParentControl (CGUIControl *control)
 
CGUIControlGetParentControl (void) const
 
virtual void SaveStates (std::vector< CControlState > &states)
 
virtual CGUIControlGetControl (int id, std::vector< CGUIControl * > *idCollector=nullptr)
 
void SetControlStats (GUICONTROLSTATS *controlStats)
 
virtual void UpdateControlStats ()
 
GUICONTROLTYPES GetControlType () const
 
bool IsControlRenderable ()
 Test whether the control is "drawable" (not a group or similar)
 

Protected Member Functions

bool UpdateColors (const CGUIListItem *item) override
 
std::string GetDescription () const override
 
void AddLabel (const std::string &label)
 
std::string GetLabel ()
 retrieve the current label for display
 
- Protected Member Functions inherited from CGUIControl
virtual CPoint GetPosition () const
 Return the coordinates of the top left of the control, in the control's parent coordinates.
 
virtual bool OnMouseOver (const CPoint &point)
 Called when the mouse is over the control. Default implementation selects the control.
 
virtual bool CanFocusFromPoint (const CPoint &point) const
 Test whether we can focus a control from a point on screen.
 
virtual bool Animate (unsigned int currentTime)
 
virtual bool CheckAnimation (ANIMATION_TYPE animType)
 
void UpdateStates (ANIMATION_TYPE type, ANIMATION_PROCESS currentProcess, ANIMATION_STATE currentState)
 
bool SendWindowMessage (CGUIMessage &message) const
 

Protected Attributes

std::vector< KODI::GUILIB::GUIINFO::CGUIInfoLabelm_infoLabels
 
unsigned int m_currentLabel
 
unsigned int m_lastLabel
 
CLabelInfo m_label
 
bool m_scroll
 
bool m_scrollOut
 
bool m_shortText
 
CScrollInfo m_scrollInfo
 
CGUITextLayout m_textLayout
 
CAnimation m_fadeAnim
 
TransformMatrix m_fadeMatrix
 
unsigned int m_scrollSpeed
 
bool m_resetOnLabelChange
 
bool m_randomized
 
bool m_allLabelsShown = true
 
uint32_t m_fadeDepth {0}
 
- Protected Attributes inherited from CGUIControl
ActionMap m_actions
 
float m_posX
 
float m_posY
 
float m_height
 
float m_width
 
CRect m_hitRect
 
KODI::UTILS::COLOR::Color m_hitColor = 0xffffffff
 
KODI::GUILIB::GUIINFO::CGUIInfoColor m_diffuseColor
 
int m_controlID
 
int m_parentID
 
bool m_bHasFocus
 
bool m_bInvalidated
 
bool m_bAllocated
 
bool m_pulseOnSelect
 
GUICONTROLTYPES ControlType
 
GUICONTROLSTATSm_controlStats
 
CGUIControlm_parentControl
 
INFO::InfoPtr m_visibleCondition
 
GUIVISIBLE m_visible
 
bool m_visibleFromSkinCondition
 
bool m_forceHidden
 
KODI::GUILIB::GUIINFO::CGUIInfoBool m_allowHiddenFocus
 
bool m_hasProcessed
 
INFO::InfoPtr m_enableCondition
 
bool m_enabled
 
bool m_pushedUpdates
 
std::vector< CAnimationm_animations
 
CPoint m_camera
 
bool m_hasCamera
 
float m_stereo
 
TransformMatrix m_transform
 
TransformMatrix m_cachedTransform
 
bool m_isCulled {true}
 
unsigned int m_controlDirtyState
 
CRect m_renderRegion
 

Additional Inherited Members

- Public Types inherited from CGUIControl
enum  GUICONTROLTYPES {
  GUICONTROL_UNKNOWN , GUICONTAINER_EPGGRID , GUICONTAINER_FIXEDLIST , GUICONTAINER_LIST ,
  GUICONTAINER_PANEL , GUICONTAINER_WRAPLIST , GUICONTROL_BORDEREDIMAGE , GUICONTROL_BUTTON ,
  GUICONTROL_COLORBUTTON , GUICONTROL_EDIT , GUICONTROL_FADELABEL , GUICONTROL_GAME ,
  GUICONTROL_GAMECONTROLLER , GUICONTROL_GAMECONTROLLERLIST , GUICONTROL_GROUP , GUICONTROL_GROUPLIST ,
  GUICONTROL_IMAGE , GUICONTROL_LABEL , GUICONTROL_LISTGROUP , GUICONTROL_LISTLABEL ,
  GUICONTROL_MOVER , GUICONTROL_MULTI_IMAGE , GUICONTROL_PROGRESS , GUICONTROL_RADIO ,
  GUICONTROL_RANGES , GUICONTROL_RENDERADDON , GUICONTROL_RESIZE , GUICONTROL_RSS ,
  GUICONTROL_SCROLLBAR , GUICONTROL_SETTINGS_SLIDER , GUICONTROL_SLIDER , GUICONTROL_SPIN ,
  GUICONTROL_SPINEX , GUICONTROL_TEXTBOX , GUICONTROL_TOGGLEBUTTON , GUICONTROL_VIDEO ,
  GUICONTROL_VISUALISATION
}
 
enum  GUIVISIBLE { HIDDEN = 0 , DELAYED , VISIBLE }
 
enum  GUISCROLLVALUE { FOCUS = 0 , NEVER , ALWAYS }
 
typedef std::map< int, CGUIActionActionMap
 Set actions to perform on navigation.
 
- Static Protected Attributes inherited from CGUIControl
static const unsigned int DIRTY_STATE_CONTROL = 1
 
static const unsigned int DIRTY_STATE_CHILD = 2
 

Constructor & Destructor Documentation

◆ CGUIFadeLabelControl() [1/2]

CGUIFadeLabelControl::CGUIFadeLabelControl ( int parentID,
int controlID,
float posX,
float posY,
float width,
float height,
const CLabelInfo & labelInfo,
bool scrollOut,
unsigned int timeToDelayAtEnd,
bool resetOnLabelChange,
bool randomized )

◆ CGUIFadeLabelControl() [2/2]

CGUIFadeLabelControl::CGUIFadeLabelControl ( const CGUIFadeLabelControl & from)

◆ ~CGUIFadeLabelControl()

CGUIFadeLabelControl::~CGUIFadeLabelControl ( void )
overridedefault

Member Function Documentation

◆ AddLabel()

void CGUIFadeLabelControl::AddLabel ( const std::string & label)
protected

◆ AllLabelsShown()

bool CGUIFadeLabelControl::AllLabelsShown ( ) const
inline

◆ AssignDepth()

void CGUIFadeLabelControl::AssignDepth ( )
overridevirtual

Reimplemented from CGUIControl.

◆ CanFocus()

bool CGUIFadeLabelControl::CanFocus ( ) const
overridevirtual

Reimplemented from CGUIControl.

◆ Clone()

CGUIFadeLabelControl * CGUIFadeLabelControl::Clone ( void ) const
inlineoverridevirtual

Implements CGUIControl.

◆ GetDescription()

std::string CGUIFadeLabelControl::GetDescription ( void ) const
overrideprotectedvirtual

Reimplemented from CGUIControl.

◆ GetLabel()

std::string CGUIFadeLabelControl::GetLabel ( )
protected

retrieve the current label for display

The fadelabel has multiple labels which it cycles through. This routine retrieves the current label. It first checks the current label and if non-empty returns it. Otherwise it will iterate through all labels until it has a non-empty label to return.

Returns
the label that should be displayed. If empty, there is no label available.

◆ OnMessage()

bool CGUIFadeLabelControl::OnMessage ( CGUIMessage & message)
overridevirtual

Reimplemented from CGUIControl.

◆ Process()

void CGUIFadeLabelControl::Process ( unsigned int currentTime,
CDirtyRegionList & dirtyregions )
overridevirtual

Reimplemented from CGUIControl.

◆ Render()

void CGUIFadeLabelControl::Render ( )
overridevirtual

Reimplemented from CGUIControl.

◆ SetInfo()

void CGUIFadeLabelControl::SetInfo ( const std::vector< KODI::GUILIB::GUIINFO::CGUIInfoLabel > & vecInfo)

◆ SetScrolling()

void CGUIFadeLabelControl::SetScrolling ( bool scroll)
inline

◆ UpdateColors()

bool CGUIFadeLabelControl::UpdateColors ( const CGUIListItem * item)
overrideprotectedvirtual

Reimplemented from CGUIControl.

Member Data Documentation

◆ m_allLabelsShown

bool CGUIFadeLabelControl::m_allLabelsShown = true
protected

◆ m_currentLabel

unsigned int CGUIFadeLabelControl::m_currentLabel
protected

◆ m_fadeAnim

CAnimation CGUIFadeLabelControl::m_fadeAnim
protected

◆ m_fadeDepth

uint32_t CGUIFadeLabelControl::m_fadeDepth {0}
protected

◆ m_fadeMatrix

TransformMatrix CGUIFadeLabelControl::m_fadeMatrix
protected

◆ m_infoLabels

std::vector<KODI::GUILIB::GUIINFO::CGUIInfoLabel> CGUIFadeLabelControl::m_infoLabels
protected

◆ m_label

CLabelInfo CGUIFadeLabelControl::m_label
protected

◆ m_lastLabel

unsigned int CGUIFadeLabelControl::m_lastLabel
protected

◆ m_randomized

bool CGUIFadeLabelControl::m_randomized
protected

◆ m_resetOnLabelChange

bool CGUIFadeLabelControl::m_resetOnLabelChange
protected

◆ m_scroll

bool CGUIFadeLabelControl::m_scroll
protected

◆ m_scrollInfo

CScrollInfo CGUIFadeLabelControl::m_scrollInfo
protected

◆ m_scrollOut

bool CGUIFadeLabelControl::m_scrollOut
protected

◆ m_scrollSpeed

unsigned int CGUIFadeLabelControl::m_scrollSpeed
protected

◆ m_shortText

bool CGUIFadeLabelControl::m_shortText
protected

◆ m_textLayout

CGUITextLayout CGUIFadeLabelControl::m_textLayout
protected

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