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

#include <GUIButtonControl.h>

Inheritance diagram for CGUIButtonControl:
CGUIControl CGUIColorButtonControl CGUIEditControl CGUIRadioButtonControl CGUIToggleButtonControl KODI::GAME::CGUIControllerButton KODI::GAME::CGUIFeatureButton KODI::GAME::CGUICardinalFeatureButton KODI::GAME::CGUIScalarFeatureButton KODI::GAME::CGUISelectKeyButton KODI::GAME::CGUIThrottleButton KODI::GAME::CGUIWheelButton

Public Member Functions

 CGUIButtonControl (int parentID, int controlID, float posX, float posY, float width, float height, const CTextureInfo &textureFocus, const CTextureInfo &textureNoFocus, const CLabelInfo &label, bool wrapMultiline=false)
 
 CGUIButtonControl (const CGUIButtonControl &control)
 
 ~CGUIButtonControl () override=default
 
CGUIButtonControlClone () const override
 
void Process (unsigned int currentTime, CDirtyRegionList &dirtyregions) override
 
void Render () override
 
bool OnAction (const CAction &action) override
 
bool OnMessage (CGUIMessage &message) override
 
void AllocResources () override
 
void FreeResources (bool immediately=false) override
 
void DynamicResourceAlloc (bool bOnOff) override
 
void SetInvalid () override
 
void SetPosition (float posX, float posY) override
 
virtual void SetLabel (const std::string &aLabel)
 
virtual void SetLabel2 (const std::string &aLabel2)
 
void SetClickActions (const CGUIAction &clickActions)
 
const CGUIActionGetClickActions () const
 
void SetFocusActions (const CGUIAction &focusActions)
 
void SetUnFocusActions (const CGUIAction &unfocusActions)
 
const CLabelInfoGetLabelInfo () const
 
virtual std::string GetLabel () const
 
virtual std::string GetLabel2 () const
 
void SetSelected (bool bSelected)
 
std::string GetDescription () const override
 
float GetWidth () const override
 
virtual void SetMinWidth (float minWidth)
 
void SetAlpha (unsigned char alpha)
 
void PythonSetLabel (const std::string &strFont, const std::string &strText, UTILS::COLOR::Color textColor, UTILS::COLOR::Color shadowColor, UTILS::COLOR::Color focusedColor)
 
void PythonSetDisabledColor (UTILS::COLOR::Color disabledColor)
 
virtual void OnClick ()
 
bool HasClickActions () const
 
bool UpdateColors (const CGUIListItem *item) override
 
CRect CalcRenderRegion () const override
 calculate the render region in parentcontrol coordinates of this control Called during process to update m_renderRegion
 
- 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 void OnUp ()
 
virtual void OnDown ()
 
virtual void OnLeft ()
 
virtual void OnRight ()
 
virtual bool OnBack ()
 
virtual bool OnInfo ()
 
virtual void OnNextControl ()
 
virtual void OnPrevControl ()
 
virtual EVENT_RESULT SendMouseEvent (const CPoint &point, const KODI::MOUSE::CMouseEvent &event)
 React to a mouse event.
 
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 bool IsDynamicallyAllocated ()
 
virtual bool CanFocus () const
 
virtual bool IsVisible () const
 
bool IsVisibleFromSkin () const
 
virtual bool IsDisabled () const
 
virtual void SetHitRect (const CRect &rect, const 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 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 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

EVENT_RESULT OnMouseEvent (const CPoint &point, const KODI::MOUSE::CMouseEvent &event) override
 Perform a mouse action.
 
void OnFocus () override
 
void OnUnFocus () override
 
virtual void ProcessText (unsigned int currentTime)
 
virtual void RenderText ()
 
virtual CGUILabel::COLOR GetTextColor () const
 
void SetMaxWidth (float labelMaxWidth)
 Set the maximum width for the left label.
 
- 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::unique_ptr< CGUITexturem_imgFocus
 
std::unique_ptr< CGUITexturem_imgNoFocus
 
unsigned int m_focusCounter
 
unsigned char m_alpha
 
float m_minWidth
 
float m_maxWidth
 
float m_labelMaxWidth {0}
 
KODI::GUILIB::GUIINFO::CGUIInfoLabel m_info
 
KODI::GUILIB::GUIINFO::CGUIInfoLabel m_info2
 
CGUILabel m_label
 
CGUILabel m_label2
 
CGUIAction m_clickActions
 
CGUIAction m_focusActions
 
CGUIAction m_unfocusActions
 
bool m_bSelected
 
- Protected Attributes inherited from CGUIControl
ActionMap m_actions
 
float m_posX
 
float m_posY
 
float m_height
 
float m_width
 
CRect m_hitRect
 
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
 

Friends

class CGUISpinControlEx
 

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

◆ CGUIButtonControl() [1/2]

CGUIButtonControl::CGUIButtonControl ( int parentID,
int controlID,
float posX,
float posY,
float width,
float height,
const CTextureInfo & textureFocus,
const CTextureInfo & textureNoFocus,
const CLabelInfo & label,
bool wrapMultiline = false )

◆ CGUIButtonControl() [2/2]

CGUIButtonControl::CGUIButtonControl ( const CGUIButtonControl & control)

◆ ~CGUIButtonControl()

CGUIButtonControl::~CGUIButtonControl ( )
overridedefault

Member Function Documentation

◆ AllocResources()

void CGUIButtonControl::AllocResources ( )
overridevirtual

◆ CalcRenderRegion()

CRect CGUIButtonControl::CalcRenderRegion ( ) const
overridevirtual

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

Reimplemented from CGUIControl.

◆ Clone()

CGUIButtonControl * CGUIButtonControl::Clone ( void ) const
inlineoverridevirtual

◆ DynamicResourceAlloc()

void CGUIButtonControl::DynamicResourceAlloc ( bool bOnOff)
overridevirtual

◆ FreeResources()

void CGUIButtonControl::FreeResources ( bool immediately = false)
overridevirtual

◆ GetClickActions()

const CGUIAction & CGUIButtonControl::GetClickActions ( ) const
inline

◆ GetDescription()

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

◆ GetLabel()

virtual std::string CGUIButtonControl::GetLabel ( ) const
inlinevirtual

◆ GetLabel2()

std::string CGUIButtonControl::GetLabel2 ( ) const
virtual

Reimplemented in CGUIEditControl.

◆ GetLabelInfo()

const CLabelInfo & CGUIButtonControl::GetLabelInfo ( ) const
inline

◆ GetTextColor()

CGUILabel::COLOR CGUIButtonControl::GetTextColor ( ) const
protectedvirtual

Reimplemented in CGUIColorButtonControl, and CGUIEditControl.

◆ GetWidth()

float CGUIButtonControl::GetWidth ( ) const
overridevirtual

Reimplemented from CGUIControl.

◆ HasClickActions()

bool CGUIButtonControl::HasClickActions ( ) const
inline

◆ OnAction()

bool CGUIButtonControl::OnAction ( const CAction & action)
overridevirtual

◆ OnClick()

void CGUIButtonControl::OnClick ( )
virtual

Reimplemented in CGUIEditControl, and CGUIToggleButtonControl.

◆ OnFocus()

void CGUIButtonControl::OnFocus ( )
overrideprotectedvirtual

Reimplemented from CGUIControl.

◆ OnMessage()

bool CGUIButtonControl::OnMessage ( CGUIMessage & message)
overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIColorButtonControl, CGUIEditControl, and CGUIRadioButtonControl.

◆ OnMouseEvent()

EVENT_RESULT CGUIButtonControl::OnMouseEvent ( const CPoint & point,
const KODI::MOUSE::CMouseEvent & event )
overrideprotectedvirtual

Perform a mouse action.

Mouse actions are sent from the window to all controls, and each control can react based on the event and location of the actions.

Parameters
pointthe location in transformed skin coordinates from the upper left corner of the parent control.
eventthe mouse event to perform
Returns
EVENT_RESULT corresponding to whether the control handles this event
See also
SendMouseEvent, HitTest, CanFocusFromPoint, CMouseEvent

Reimplemented from CGUIControl.

◆ OnUnFocus()

void CGUIButtonControl::OnUnFocus ( void )
overrideprotectedvirtual

Reimplemented from CGUIControl.

Reimplemented in KODI::GAME::CGUIFeatureButton.

◆ Process()

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

◆ ProcessText()

void CGUIButtonControl::ProcessText ( unsigned int currentTime)
protectedvirtual

Reimplemented in CGUIEditControl.

◆ PythonSetDisabledColor()

void CGUIButtonControl::PythonSetDisabledColor ( UTILS::COLOR::Color disabledColor)

◆ PythonSetLabel()

void CGUIButtonControl::PythonSetLabel ( const std::string & strFont,
const std::string & strText,
UTILS::COLOR::Color textColor,
UTILS::COLOR::Color shadowColor,
UTILS::COLOR::Color focusedColor )

◆ Render()

void CGUIButtonControl::Render ( )
overridevirtual

◆ RenderText()

void CGUIButtonControl::RenderText ( )
protectedvirtual

Reimplemented in CGUIEditControl.

◆ SetAlpha()

void CGUIButtonControl::SetAlpha ( unsigned char alpha)

◆ SetClickActions()

void CGUIButtonControl::SetClickActions ( const CGUIAction & clickActions)
inline

◆ SetFocusActions()

void CGUIButtonControl::SetFocusActions ( const CGUIAction & focusActions)
inline

◆ SetInvalid()

void CGUIButtonControl::SetInvalid ( )
overridevirtual

◆ SetLabel()

void CGUIButtonControl::SetLabel ( const std::string & aLabel)
virtual

Reimplemented in CGUIEditControl, and CGUIToggleButtonControl.

◆ SetLabel2()

void CGUIButtonControl::SetLabel2 ( const std::string & aLabel2)
virtual

Reimplemented in CGUIEditControl.

◆ SetMaxWidth()

void CGUIButtonControl::SetMaxWidth ( float labelMaxWidth)
inlineprotected

Set the maximum width for the left label.

◆ SetMinWidth()

void CGUIButtonControl::SetMinWidth ( float minWidth)
virtual

Reimplemented in CGUIToggleButtonControl.

◆ SetPosition()

void CGUIButtonControl::SetPosition ( float posX,
float posY )
overridevirtual

◆ SetSelected()

void CGUIButtonControl::SetSelected ( bool bSelected)

◆ SetUnFocusActions()

void CGUIButtonControl::SetUnFocusActions ( const CGUIAction & unfocusActions)
inline

◆ UpdateColors()

bool CGUIButtonControl::UpdateColors ( const CGUIListItem * item)
overridevirtual

Friends And Related Symbol Documentation

◆ CGUISpinControlEx

friend class CGUISpinControlEx
friend

Member Data Documentation

◆ m_alpha

unsigned char CGUIButtonControl::m_alpha
protected

◆ m_bSelected

bool CGUIButtonControl::m_bSelected
protected

◆ m_clickActions

CGUIAction CGUIButtonControl::m_clickActions
protected

◆ m_focusActions

CGUIAction CGUIButtonControl::m_focusActions
protected

◆ m_focusCounter

unsigned int CGUIButtonControl::m_focusCounter
protected

◆ m_imgFocus

std::unique_ptr<CGUITexture> CGUIButtonControl::m_imgFocus
protected

◆ m_imgNoFocus

std::unique_ptr<CGUITexture> CGUIButtonControl::m_imgNoFocus
protected

◆ m_info

KODI::GUILIB::GUIINFO::CGUIInfoLabel CGUIButtonControl::m_info
protected

◆ m_info2

KODI::GUILIB::GUIINFO::CGUIInfoLabel CGUIButtonControl::m_info2
protected

◆ m_label

CGUILabel CGUIButtonControl::m_label
protected

◆ m_label2

CGUILabel CGUIButtonControl::m_label2
protected

◆ m_labelMaxWidth

float CGUIButtonControl::m_labelMaxWidth {0}
protected

◆ m_maxWidth

float CGUIButtonControl::m_maxWidth
protected

◆ m_minWidth

float CGUIButtonControl::m_minWidth
protected

◆ m_unfocusActions

CGUIAction CGUIButtonControl::m_unfocusActions
protected

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