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

#include <GUIProgressControl.h>

Inheritance diagram for CGUIProgressControl:
CGUIControl

Public Member Functions

 CGUIProgressControl (int parentID, int controlID, float posX, float posY, float width, float height, const CTextureInfo &backGroundTexture, const CTextureInfo &leftTexture, const CTextureInfo &midTexture, const CTextureInfo &rightTexture, const CTextureInfo &overlayTexture, bool reveal=false)
 
 ~CGUIProgressControl () override=default
 
CGUIProgressControlClone () const override
 
void Process (unsigned int currentTime, CDirtyRegionList &dirtyregions) override
 
void Render () override
 
bool CanFocus () const override
 
void AllocResources () override
 
void FreeResources (bool immediately=false) override
 
void DynamicResourceAlloc (bool bOnOff) override
 
void SetInvalid () override
 
bool OnMessage (CGUIMessage &message) override
 
void SetPosition (float posX, float posY) override
 
void SetPercentage (float fPercent)
 
void SetInfo (int iInfo, int iInfo2=0)
 
int GetInfo () const
 
float GetPercentage () const
 
std::string GetDescription () const override
 
void UpdateInfo (const CGUIListItem *item=NULL) override
 
bool UpdateLayout (void)
 
- 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 bool IsDynamicallyAllocated ()
 
virtual bool IsVisible () const
 
bool IsVisibleFromSkin () const
 
virtual bool IsDisabled () const
 
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
 
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
 
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 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
 
- 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_guiBackground
 
std::unique_ptr< CGUITexturem_guiLeft
 
std::unique_ptr< CGUITexturem_guiMid
 
std::unique_ptr< CGUITexturem_guiRight
 
std::unique_ptr< CGUITexturem_guiOverlay
 
CRect m_guiMidClipRect
 
int m_iInfoCode
 
int m_iInfoCode2 = 0
 
float m_fPercent
 
float m_fPercent2 = 0.0f
 
bool m_bReveal
 
bool m_bChanged
 
- 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

◆ CGUIProgressControl()

CGUIProgressControl::CGUIProgressControl ( int parentID,
int controlID,
float posX,
float posY,
float width,
float height,
const CTextureInfo & backGroundTexture,
const CTextureInfo & leftTexture,
const CTextureInfo & midTexture,
const CTextureInfo & rightTexture,
const CTextureInfo & overlayTexture,
bool reveal = false )

◆ ~CGUIProgressControl()

CGUIProgressControl::~CGUIProgressControl ( )
overridedefault

Member Function Documentation

◆ AllocResources()

void CGUIProgressControl::AllocResources ( )
overridevirtual

Reimplemented from CGUIControl.

◆ CanFocus()

bool CGUIProgressControl::CanFocus ( ) const
overridevirtual

Reimplemented from CGUIControl.

◆ Clone()

CGUIProgressControl * CGUIProgressControl::Clone ( void ) const
inlineoverridevirtual

Implements CGUIControl.

◆ DynamicResourceAlloc()

void CGUIProgressControl::DynamicResourceAlloc ( bool bOnOff)
overridevirtual

Reimplemented from CGUIControl.

◆ FreeResources()

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

Reimplemented from CGUIControl.

◆ GetDescription()

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

Reimplemented from CGUIControl.

◆ GetInfo()

int CGUIProgressControl::GetInfo ( ) const
inline

◆ GetPercentage()

float CGUIProgressControl::GetPercentage ( ) const

◆ OnMessage()

bool CGUIProgressControl::OnMessage ( CGUIMessage & message)
overridevirtual

Reimplemented from CGUIControl.

◆ Process()

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

Reimplemented from CGUIControl.

◆ Render()

void CGUIProgressControl::Render ( )
overridevirtual

Reimplemented from CGUIControl.

◆ SetInfo()

void CGUIProgressControl::SetInfo ( int iInfo,
int iInfo2 = 0 )

◆ SetInvalid()

void CGUIProgressControl::SetInvalid ( )
overridevirtual

Reimplemented from CGUIControl.

◆ SetPercentage()

void CGUIProgressControl::SetPercentage ( float fPercent)

◆ SetPosition()

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

Reimplemented from CGUIControl.

◆ UpdateColors()

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

Reimplemented from CGUIControl.

◆ UpdateInfo()

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

Reimplemented from CGUIControl.

◆ UpdateLayout()

bool CGUIProgressControl::UpdateLayout ( void )

Member Data Documentation

◆ m_bChanged

bool CGUIProgressControl::m_bChanged
protected

◆ m_bReveal

bool CGUIProgressControl::m_bReveal
protected

◆ m_fPercent

float CGUIProgressControl::m_fPercent
protected

◆ m_fPercent2

float CGUIProgressControl::m_fPercent2 = 0.0f
protected

◆ m_guiBackground

std::unique_ptr<CGUITexture> CGUIProgressControl::m_guiBackground
protected

◆ m_guiLeft

std::unique_ptr<CGUITexture> CGUIProgressControl::m_guiLeft
protected

◆ m_guiMid

std::unique_ptr<CGUITexture> CGUIProgressControl::m_guiMid
protected

◆ m_guiMidClipRect

CRect CGUIProgressControl::m_guiMidClipRect
protected

◆ m_guiOverlay

std::unique_ptr<CGUITexture> CGUIProgressControl::m_guiOverlay
protected

◆ m_guiRight

std::unique_ptr<CGUITexture> CGUIProgressControl::m_guiRight
protected

◆ m_iInfoCode

int CGUIProgressControl::m_iInfoCode
protected

◆ m_iInfoCode2

int CGUIProgressControl::m_iInfoCode2 = 0
protected

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