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

group of controls, useful for remembering last control + animating/hiding together More...

#include <GUIControlGroup.h>

Inheritance diagram for CGUIControlGroup:
CGUIControlLookup CGUIControl CGUIControlGroupList CGUIListGroup CGUIWindow CGUIDialog CGUIMediaWindow CGUIWindowFileManager CGUIWindowFullScreen CGUIWindowHome CGUIWindowLoginScreen CGUIWindowSettings CGUIWindowSettingsProfile CGUIWindowSettingsScreenCalibration CGUIWindowSplash CGUIWindowStartup CGUIWindowSystemInfo CGUIWindowVisualisation CGUIWindowWeather KODI::RETRO::CGameWindowFullScreen

Public Member Functions

 CGUIControlGroup ()
 
 CGUIControlGroup (int parentID, int controlID, float posX, float posY, float width, float height)
 
 CGUIControlGroup (const CGUIControlGroup &from)
 
 ~CGUIControlGroup (void) override
 
CGUIControlGroupClone () const override
 
void Process (unsigned int currentTime, CDirtyRegionList &dirtyregions) override
 
void Render () override
 
void RenderEx () override
 
bool OnAction (const CAction &action) override
 
bool OnMessage (CGUIMessage &message) override
 
virtual bool SendControlMessage (CGUIMessage &message)
 
bool HasFocus () const override
 
void AllocResources () override
 
void FreeResources (bool immediately=false) override
 
void DynamicResourceAlloc (bool bOnOff) override
 
bool CanFocus () const override
 
void AssignDepth () override
 
EVENT_RESULT SendMouseEvent (const CPoint &point, const KODI::MOUSE::CMouseEvent &event) override
 React to a mouse event.
 
void UnfocusFromPoint (const CPoint &point) override
 Unfocus the control if the given point on screen is not within it's boundary.
 
void SetInitialVisibility () override
 
bool IsAnimating (ANIMATION_TYPE anim) override
 
bool HasAnimation (ANIMATION_TYPE anim) override
 
void QueueAnimation (ANIMATION_TYPE anim) override
 
void ResetAnimation (ANIMATION_TYPE anim) override
 
void ResetAnimations () override
 
int GetFocusedControlID () const
 
CGUIControlGetFocusedControl () const
 
virtual CGUIControlGetFirstFocusableControl (int id)
 
virtual void AddControl (CGUIControl *control, int position=-1)
 
bool InsertControl (CGUIControl *control, const CGUIControl *insertPoint)
 
virtual bool RemoveControl (const CGUIControl *control)
 
virtual void ClearAll ()
 
void SetDefaultControl (int id, bool always)
 
void SetRenderFocusedLast (bool renderLast)
 
void SaveStates (std::vector< CControlState > &states) override
 
bool IsGroup () const override
 
- Public Member Functions inherited from CGUIControlLookup
 CGUIControlLookup ()=default
 
 CGUIControlLookup (int parentID, int controlID, float posX, float posY, float width, float height)
 
 CGUIControlLookup (const CGUIControlLookup &from)
 
 ~CGUIControlLookup (void) override=default
 
CGUIControlGetControl (int id, std::vector< CGUIControl * > *idCollector=nullptr) 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 ()
 
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 OnMouseEvent (const CPoint &point, const KODI::MOUSE::CMouseEvent &event)
 Perform a mouse action.
 
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 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 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 SetEnabled (bool bEnable)
 
virtual void SetInvalid ()
 
virtual void SetPulseOnSelect (bool pulse)
 
virtual std::string GetDescription () const
 
virtual std::string GetDescriptionByIndex (int index) const
 
void SetAnimations (const std::vector< CAnimation > &animations)
 
const std::vector< CAnimation > & GetAnimations () const
 
CAnimationGetAnimation (ANIMATION_TYPE type, bool checkConditions=true)
 
virtual void UpdateInfo (const CGUIListItem *item=NULL)
 
virtual void SetPushUpdates (bool pushUpdates)
 
virtual bool IsContainer () const
 
virtual bool GetCondition (int condition, int data) const
 
void SetParentControl (CGUIControl *control)
 
CGUIControlGetParentControl (void) const
 
void SetControlStats (GUICONTROLSTATS *controlStats)
 
virtual void UpdateControlStats ()
 
GUICONTROLTYPES GetControlType () const
 
bool IsControlRenderable ()
 Test whether the control is "drawable" (not a group or similar)
 

Protected Types

typedef std::vector< CGUIControl * >::iterator iControls
 
typedef std::vector< CGUIControl * >::const_iterator ciControls
 
typedef std::vector< CGUIControl * >::reverse_iterator rControls
 
typedef std::vector< CGUIControl * >::const_reverse_iterator crControls
 
- Protected Types inherited from CGUIControlLookup
typedef std::multimap< int, CGUIControl * > LookupMap
 

Protected Attributes

std::vector< CGUIControl * > m_children
 
int m_defaultControl
 
bool m_defaultAlways
 
int m_focusedControl
 
bool m_renderFocusedLast
 
- 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
 

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.
 
- Protected Member Functions inherited from CGUIControlLookup
bool IsValidControl (const CGUIControl *control) const
 Check whether a given control is valid Runs through controls and returns whether this control is valid. Only functional for controls with non-zero id.
 
std::pair< LookupMap::const_iterator, LookupMap::const_iterator > GetLookupControls (int controlId) const
 
void AddLookup (CGUIControl *control)
 
void RemoveLookup (CGUIControl *control)
 
void RemoveLookup ()
 
const LookupMapGetLookup () const
 
void ClearLookup ()
 
- 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 UpdateColors (const CGUIListItem *item)
 
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
 
- Static Protected Attributes inherited from CGUIControl
static const unsigned int DIRTY_STATE_CONTROL = 1
 
static const unsigned int DIRTY_STATE_CHILD = 2
 

Detailed Description

group of controls, useful for remembering last control + animating/hiding together

Member Typedef Documentation

◆ ciControls

typedef std::vector<CGUIControl*>::const_iterator CGUIControlGroup::ciControls
protected

◆ crControls

typedef std::vector<CGUIControl*>::const_reverse_iterator CGUIControlGroup::crControls
protected

◆ iControls

typedef std::vector<CGUIControl*>::iterator CGUIControlGroup::iControls
protected

◆ rControls

typedef std::vector<CGUIControl*>::reverse_iterator CGUIControlGroup::rControls
protected

Constructor & Destructor Documentation

◆ CGUIControlGroup() [1/3]

CGUIControlGroup::CGUIControlGroup ( )

◆ CGUIControlGroup() [2/3]

CGUIControlGroup::CGUIControlGroup ( int parentID,
int controlID,
float posX,
float posY,
float width,
float height )

◆ CGUIControlGroup() [3/3]

CGUIControlGroup::CGUIControlGroup ( const CGUIControlGroup & from)
explicit

◆ ~CGUIControlGroup()

CGUIControlGroup::~CGUIControlGroup ( void )
override

Member Function Documentation

◆ AddControl()

void CGUIControlGroup::AddControl ( CGUIControl * control,
int position = -1 )
virtual

Reimplemented in CGUIControlGroupList, and CGUIListGroup.

◆ AllocResources()

void CGUIControlGroup::AllocResources ( )
overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIWindow.

◆ AssignDepth()

void CGUIControlGroup::AssignDepth ( )
overridevirtual

Reimplemented from CGUIControl.

◆ CanFocus()

bool CGUIControlGroup::CanFocus ( ) const
overridevirtual

Reimplemented from CGUIControl.

◆ ClearAll()

void CGUIControlGroup::ClearAll ( )
virtual

Reimplemented in CGUIControlGroupList, and CGUIWindow.

◆ Clone()

CGUIControlGroup * CGUIControlGroup::Clone ( void ) const
inlineoverridevirtual

Implements CGUIControl.

Reimplemented in CGUIControlGroupList, and CGUIListGroup.

◆ DynamicResourceAlloc()

void CGUIControlGroup::DynamicResourceAlloc ( bool bOnOff)
overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIWindow.

◆ FreeResources()

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

◆ GetFirstFocusableControl()

◆ GetFocusedControl()

CGUIControl * CGUIControlGroup::GetFocusedControl ( ) const

◆ GetFocusedControlID()

int CGUIControlGroup::GetFocusedControlID ( ) const

◆ HasAnimation()

bool CGUIControlGroup::HasAnimation ( ANIMATION_TYPE anim)
overridevirtual

Reimplemented from CGUIControl.

◆ HasFocus()

bool CGUIControlGroup::HasFocus ( void ) const
overridevirtual

Reimplemented from CGUIControl.

◆ InsertControl()

bool CGUIControlGroup::InsertControl ( CGUIControl * control,
const CGUIControl * insertPoint )

◆ IsAnimating()

bool CGUIControlGroup::IsAnimating ( ANIMATION_TYPE anim)
overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIWindow.

◆ IsGroup()

bool CGUIControlGroup::IsGroup ( ) const
inlineoverridevirtual

Reimplemented from CGUIControl.

◆ OnAction()

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

◆ OnMessage()

bool CGUIControlGroup::OnMessage ( CGUIMessage & message)
overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIControlGroupList, CGUIDialog, CGUIDialogAddonInfo, CGUIDialogAddonSettings, CGUIDialogBoxBase, CGUIDialogButtonMenu, CGUIDialogColorPicker, CGUIDialogContextMenu, CGUIDialogExtendedProgressBar, CGUIDialogFileBrowser, CGUIDialogGamepad, CGUIDialogKaiToast, CGUIDialogKeyboardGeneric, CGUIDialogLibExportSettings, CGUIDialogMediaFilter, CGUIDialogMediaSource, CGUIDialogMusicInfo, CGUIDialogMusicOSD, CGUIDialogNetworkSetup, CGUIDialogNumeric, CGUIDialogOK, CGUIDialogPlayEject, CGUIDialogProgress, CGUIDialogSeekBar, CGUIDialogSelect, CGUIDialogSettingsBase, CGUIDialogSlider, CGUIDialogSmartPlaylistEditor, CGUIDialogSmartPlaylistRule, CGUIDialogSongInfo, CGUIDialogSubMenu, CGUIDialogSubtitles, CGUIDialogSubtitleSettings, CGUIDialogTeletext, CGUIDialogTextViewer, CGUIDialogVideoBookmarks, CGUIDialogVideoInfo, CGUIDialogVideoManager, CGUIDialogVideoManagerExtras, CGUIDialogVideoManagerVersions, CGUIDialogVideoOSD, CGUIDialogVisualisationPresetList, CGUIDialogVolumeBar, CGUIDialogYesNo, CGUIMediaWindow, CGUIWindow, CGUIWindowAddonBrowser, CGUIWindowDebugInfo, CGUIWindowEventLog, CGUIWindowFavourites, CGUIWindowFileManager, CGUIWindowFullScreen, CGUIWindowHome, CGUIWindowLoginScreen, CGUIWindowMusicBase, CGUIWindowMusicNav, CGUIWindowMusicPlayList, CGUIWindowMusicPlaylistEditor, CGUIWindowPictures, CGUIWindowPrograms, CGUIWindowScreensaver, CGUIWindowSettingsCategory, CGUIWindowSettingsProfile, CGUIWindowSettingsScreenCalibration, CGUIWindowSlideShow, CGUIWindowSystemInfo, CGUIWindowVideoBase, CGUIWindowVideoNav, CGUIWindowVideoPlaylist, CGUIWindowVisualisation, CGUIWindowWeather, KODI::GAME::CGUIControllerWindow, KODI::GAME::CGUIPortWindow, KODI::GAME::CGUIWindowGames, PERIPHERALS::CGUIDialogPeripherals, PERIPHERALS::CGUIDialogPeripheralSettings, PVR::CGUIDialogPVRChannelManager, PVR::CGUIDialogPVRChannelsOSD, PVR::CGUIDialogPVRGroupManager, PVR::CGUIDialogPVRGuideInfo, PVR::CGUIDialogPVRGuideSearch, PVR::CGUIDialogPVRRadioRDSInfo, PVR::CGUIDialogPVRRecordingInfo, PVR::CGUIWindowPVRBase, PVR::CGUIWindowPVRChannelsBase, PVR::CGUIWindowPVRGuideBase, PVR::CGUIWindowPVRRecordingsBase, PVR::CGUIWindowPVRSearchBase, PVR::CGUIWindowPVRTimersBase, and XBMCAddon::xbmcgui::Interceptor< CGUIMediaWindow >.

◆ Process()

◆ QueueAnimation()

void CGUIControlGroup::QueueAnimation ( ANIMATION_TYPE anim)
overridevirtual

Reimplemented from CGUIControl.

◆ RemoveControl()

bool CGUIControlGroup::RemoveControl ( const CGUIControl * control)
virtual

◆ Render()

◆ RenderEx()

void CGUIControlGroup::RenderEx ( )
overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIWindowFullScreen, and CGUIWindowSlideShow.

◆ ResetAnimation()

void CGUIControlGroup::ResetAnimation ( ANIMATION_TYPE anim)
overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIListGroup.

◆ ResetAnimations()

void CGUIControlGroup::ResetAnimations ( )
overridevirtual

Reimplemented from CGUIControl.

◆ SaveStates()

void CGUIControlGroup::SaveStates ( std::vector< CControlState > & states)
overridevirtual

Reimplemented from CGUIControl.

◆ SendControlMessage()

bool CGUIControlGroup::SendControlMessage ( CGUIMessage & message)
virtual

◆ SendMouseEvent()

EVENT_RESULT CGUIControlGroup::SendMouseEvent ( const CPoint & point,
const KODI::MOUSE::CMouseEvent & event )
overridevirtual

React to a mouse event.

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

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
HitTest, CanFocusFromPoint, CMouseEvent, EVENT_RESULT

Reimplemented from CGUIControl.

Reimplemented in CGUIControlGroupList.

◆ SetDefaultControl()

void CGUIControlGroup::SetDefaultControl ( int id,
bool always )
inline

◆ SetInitialVisibility()

void CGUIControlGroup::SetInitialVisibility ( )
overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIWindow.

◆ SetRenderFocusedLast()

void CGUIControlGroup::SetRenderFocusedLast ( bool renderLast)
inline

◆ UnfocusFromPoint()

void CGUIControlGroup::UnfocusFromPoint ( const CPoint & point)
overridevirtual

Unfocus the control if the given point on screen is not within it's boundary.

Parameters
pointthe location in transformed skin coordinates from the upper left corner of the parent control.
See also
CanFocusFromPoint

Reimplemented from CGUIControl.

Reimplemented in CGUIControlGroupList.

Member Data Documentation

◆ m_children

std::vector<CGUIControl *> CGUIControlGroup::m_children
protected

◆ m_defaultAlways

bool CGUIControlGroup::m_defaultAlways
protected

◆ m_defaultControl

int CGUIControlGroup::m_defaultControl
protected

◆ m_focusedControl

int CGUIControlGroup::m_focusedControl
protected

◆ m_renderFocusedLast

bool CGUIControlGroup::m_renderFocusedLast
protected

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