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

#include <GUIScrollBarControl.h>

Inheritance diagram for GUIScrollBarControl:
CGUIControl

Public Member Functions

 GUIScrollBarControl (int parentID, int controlID, float posX, float posY, float width, float height, const CTextureInfo &backGroundTexture, const CTextureInfo &barTexture, const CTextureInfo &barTextureFocus, const CTextureInfo &nibTexture, const CTextureInfo &nibTextureFocus, ORIENTATION orientation, bool showOnePage)
 
 ~GUIScrollBarControl () override=default
 
GUIScrollBarControlClone () const override
 
void Process (unsigned int currentTime, CDirtyRegionList &dirtyregions) override
 
void Render () override
 
bool OnAction (const CAction &action) override
 
void AllocResources () override
 
void FreeResources (bool immediately=false) override
 
void DynamicResourceAlloc (bool bOnOff) override
 
void SetInvalid () override
 
virtual void SetRange (int pageSize, int numItems)
 
bool OnMessage (CGUIMessage &message) override
 
void SetValue (int value)
 
int GetValue () const
 
std::string GetDescription () const override
 
bool IsVisible () const override
 
- 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 void OnFocus ()
 
virtual void OnUnFocus ()
 
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
 
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
 
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 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.
 
bool UpdateColors (const CGUIListItem *item) override
 
bool UpdateBarSize ()
 
bool Move (int iNumSteps)
 
virtual void SetFromPosition (const CPoint &point)
 
- 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_guiBarNoFocus
 
std::unique_ptr< CGUITexturem_guiBarFocus
 
std::unique_ptr< CGUITexturem_guiNibNoFocus
 
std::unique_ptr< CGUITexturem_guiNibFocus
 
int m_numItems
 
int m_pageSize
 
int m_offset
 
bool m_showOnePage
 
ORIENTATION m_orientation
 
- 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

◆ GUIScrollBarControl()

GUIScrollBarControl::GUIScrollBarControl ( int parentID,
int controlID,
float posX,
float posY,
float width,
float height,
const CTextureInfo & backGroundTexture,
const CTextureInfo & barTexture,
const CTextureInfo & barTextureFocus,
const CTextureInfo & nibTexture,
const CTextureInfo & nibTextureFocus,
ORIENTATION orientation,
bool showOnePage )

◆ ~GUIScrollBarControl()

GUIScrollBarControl::~GUIScrollBarControl ( )
overridedefault

Member Function Documentation

◆ AllocResources()

void GUIScrollBarControl::AllocResources ( )
overridevirtual

Reimplemented from CGUIControl.

◆ Clone()

GUIScrollBarControl * GUIScrollBarControl::Clone ( void ) const
inlineoverridevirtual

Implements CGUIControl.

◆ DynamicResourceAlloc()

void GUIScrollBarControl::DynamicResourceAlloc ( bool bOnOff)
overridevirtual

Reimplemented from CGUIControl.

◆ FreeResources()

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

Reimplemented from CGUIControl.

◆ GetDescription()

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

Reimplemented from CGUIControl.

◆ GetValue()

int GUIScrollBarControl::GetValue ( ) const

◆ IsVisible()

bool GUIScrollBarControl::IsVisible ( ) const
overridevirtual

Reimplemented from CGUIControl.

◆ Move()

bool GUIScrollBarControl::Move ( int iNumSteps)
protected

◆ OnAction()

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

Reimplemented from CGUIControl.

◆ OnMessage()

bool GUIScrollBarControl::OnMessage ( CGUIMessage & message)
overridevirtual

Reimplemented from CGUIControl.

◆ OnMouseEvent()

EVENT_RESULT GUIScrollBarControl::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.

◆ Process()

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

Reimplemented from CGUIControl.

◆ Render()

void GUIScrollBarControl::Render ( )
overridevirtual

Reimplemented from CGUIControl.

◆ SetFromPosition()

void GUIScrollBarControl::SetFromPosition ( const CPoint & point)
protectedvirtual

◆ SetInvalid()

void GUIScrollBarControl::SetInvalid ( )
overridevirtual

Reimplemented from CGUIControl.

◆ SetRange()

void GUIScrollBarControl::SetRange ( int pageSize,
int numItems )
virtual

◆ SetValue()

void GUIScrollBarControl::SetValue ( int value)

◆ UpdateBarSize()

bool GUIScrollBarControl::UpdateBarSize ( )
protected

◆ UpdateColors()

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

Reimplemented from CGUIControl.

Member Data Documentation

◆ m_guiBackground

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

◆ m_guiBarFocus

std::unique_ptr<CGUITexture> GUIScrollBarControl::m_guiBarFocus
protected

◆ m_guiBarNoFocus

std::unique_ptr<CGUITexture> GUIScrollBarControl::m_guiBarNoFocus
protected

◆ m_guiNibFocus

std::unique_ptr<CGUITexture> GUIScrollBarControl::m_guiNibFocus
protected

◆ m_guiNibNoFocus

std::unique_ptr<CGUITexture> GUIScrollBarControl::m_guiNibNoFocus
protected

◆ m_numItems

int GUIScrollBarControl::m_numItems
protected

◆ m_offset

int GUIScrollBarControl::m_offset
protected

◆ m_orientation

ORIENTATION GUIScrollBarControl::m_orientation
protected

◆ m_pageSize

int GUIScrollBarControl::m_pageSize
protected

◆ m_showOnePage

bool GUIScrollBarControl::m_showOnePage
protected

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