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

#include <GUILabelControl.h>

Inheritance diagram for CGUILabelControl:
CGUIControl KODI::GAME::CGUIFeatureGroupTitle

Public Member Functions

 CGUILabelControl (int parentID, int controlID, float posX, float posY, float width, float height, const CLabelInfo &labelInfo, bool wrapMultiLine, bool bHasPath)
 
 ~CGUILabelControl (void) override
 
CGUILabelControlClone () const override
 
void Process (unsigned int currentTime, CDirtyRegionList &dirtyregions) override
 
void Render () override
 
void UpdateInfo (const CGUIListItem *item=NULL) override
 
bool CanFocus () const override
 
bool OnMessage (CGUIMessage &message) override
 
std::string GetDescription () const override
 
float GetWidth () const override
 
void SetWidth (float width) override
 
CRect CalcRenderRegion () const override
 calculate the render region in parentcontrol coordinates of this control Called during process to update m_renderRegion
 
const CLabelInfoGetLabelInfo () const
 
void SetLabel (const std::string &strLabel)
 
void ShowCursor (bool bShow=true)
 
void SetCursorPos (int iPos)
 
int GetCursorPos () const
 
void SetInfo (const KODI::GUILIB::GUIINFO::CGUIInfoLabel &labelInfo)
 
void SetWidthControl (float minWidth, bool bScroll)
 
void SetAlignment (uint32_t align)
 
void SetHighlight (unsigned int start, unsigned int end)
 
void SetSelection (unsigned int start, unsigned int end)
 
- 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 GetHeight () const
 
virtual void AssignDepth ()
 
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
 
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 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 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 ShortenPath (const std::string &path)
 
float GetMaxWidth () const
 Return the maximum width of this label control.
 
- 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

CGUILabel m_label
 
bool m_bHasPath
 
bool m_bShowCursor
 
int m_iCursorPos
 
unsigned int m_dwCounter
 
float m_minWidth
 
KODI::GUILIB::GUIINFO::CGUIInfoLabel m_infoLabel
 
unsigned int m_startHighlight
 
unsigned int m_endHighlight
 
unsigned int m_startSelection
 
unsigned int m_endSelection
 
- 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

◆ CGUILabelControl()

CGUILabelControl::CGUILabelControl ( int parentID,
int controlID,
float posX,
float posY,
float width,
float height,
const CLabelInfo & labelInfo,
bool wrapMultiLine,
bool bHasPath )

◆ ~CGUILabelControl()

CGUILabelControl::~CGUILabelControl ( void )
overridedefault

Member Function Documentation

◆ CalcRenderRegion()

CRect CGUILabelControl::CalcRenderRegion ( ) const
overridevirtual

calculate the render region in parentcontrol coordinates of this control Called during process to update m_renderRegion

Reimplemented from CGUIControl.

◆ CanFocus()

bool CGUILabelControl::CanFocus ( ) const
overridevirtual

Reimplemented from CGUIControl.

◆ Clone()

CGUILabelControl * CGUILabelControl::Clone ( void ) const
inlineoverridevirtual

Implements CGUIControl.

◆ GetCursorPos()

int CGUILabelControl::GetCursorPos ( ) const
inline

◆ GetDescription()

std::string CGUILabelControl::GetDescription ( void ) const
overridevirtual

Reimplemented from CGUIControl.

◆ GetLabelInfo()

const CLabelInfo & CGUILabelControl::GetLabelInfo ( ) const
inline

◆ GetMaxWidth()

float CGUILabelControl::GetMaxWidth ( ) const
inlineprotected

Return the maximum width of this label control.

Returns
Return the width of the control if available, else the width of the current text.

◆ GetWidth()

float CGUILabelControl::GetWidth ( ) const
overridevirtual

Reimplemented from CGUIControl.

◆ OnMessage()

bool CGUILabelControl::OnMessage ( CGUIMessage & message)
overridevirtual

Reimplemented from CGUIControl.

◆ Process()

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

Reimplemented from CGUIControl.

◆ Render()

void CGUILabelControl::Render ( )
overridevirtual

Reimplemented from CGUIControl.

◆ SetAlignment()

void CGUILabelControl::SetAlignment ( uint32_t align)

◆ SetCursorPos()

void CGUILabelControl::SetCursorPos ( int iPos)

◆ SetHighlight()

void CGUILabelControl::SetHighlight ( unsigned int start,
unsigned int end )

◆ SetInfo()

void CGUILabelControl::SetInfo ( const KODI::GUILIB::GUIINFO::CGUIInfoLabel & labelInfo)

◆ SetLabel()

void CGUILabelControl::SetLabel ( const std::string & strLabel)

◆ SetSelection()

void CGUILabelControl::SetSelection ( unsigned int start,
unsigned int end )

◆ SetWidth()

void CGUILabelControl::SetWidth ( float width)
overridevirtual

Reimplemented from CGUIControl.

◆ SetWidthControl()

void CGUILabelControl::SetWidthControl ( float minWidth,
bool bScroll )

◆ ShortenPath()

std::string CGUILabelControl::ShortenPath ( const std::string & path)
protected

◆ ShowCursor()

void CGUILabelControl::ShowCursor ( bool bShow = true)

◆ UpdateColors()

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

Reimplemented from CGUIControl.

◆ UpdateInfo()

void CGUILabelControl::UpdateInfo ( const CGUIListItem * item = NULL)
overridevirtual

Reimplemented from CGUIControl.

Member Data Documentation

◆ m_bHasPath

bool CGUILabelControl::m_bHasPath
protected

◆ m_bShowCursor

bool CGUILabelControl::m_bShowCursor
protected

◆ m_dwCounter

unsigned int CGUILabelControl::m_dwCounter
protected

◆ m_endHighlight

unsigned int CGUILabelControl::m_endHighlight
protected

◆ m_endSelection

unsigned int CGUILabelControl::m_endSelection
protected

◆ m_iCursorPos

int CGUILabelControl::m_iCursorPos
protected

◆ m_infoLabel

KODI::GUILIB::GUIINFO::CGUIInfoLabel CGUILabelControl::m_infoLabel
protected

◆ m_label

CGUILabel CGUILabelControl::m_label
protected

◆ m_minWidth

float CGUILabelControl::m_minWidth
protected

◆ m_startHighlight

unsigned int CGUILabelControl::m_startHighlight
protected

◆ m_startSelection

unsigned int CGUILabelControl::m_startSelection
protected

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