![]() |
Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
group of controls, useful for remembering last control + animating/hiding together More...
#include <GUIControlGroup.h>
Public Member Functions | |
CGUIControlGroup () | |
CGUIControlGroup (int parentID, int controlID, float posX, float posY, float width, float height) | |
CGUIControlGroup (const CGUIControlGroup &from) | |
~CGUIControlGroup (void) override | |
CGUIControlGroup * | Clone () 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 |
CGUIControl * | GetFocusedControl () const |
virtual CGUIControl * | GetFirstFocusableControl (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 |
![]() | |
CGUIControlLookup ()=default | |
CGUIControlLookup (int parentID, int controlID, float posX, float posY, float width, float height) | |
CGUIControlLookup (const CGUIControlLookup &from) | |
~CGUIControlLookup (void) override=default | |
CGUIControl * | GetControl (int id, std::vector< CGUIControl * > *idCollector=nullptr) override |
![]() | |
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 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 |
void | MarkDirtyRegion (const unsigned int dirtyState=DIRTY_STATE_CONTROL) |
bool | IsControlDirty () const |
const CRect & | GetRenderRegion () 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 |
CAnimation * | GetAnimation (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) |
CGUIControl * | GetParentControl (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 |
![]() | |
typedef std::multimap< int, CGUIControl * > | LookupMap |
group of controls, useful for remembering last control + animating/hiding together
|
protected |
|
protected |
|
protected |
|
protected |
CGUIControlGroup::CGUIControlGroup | ( | ) |
CGUIControlGroup::CGUIControlGroup | ( | int | parentID, |
int | controlID, | ||
float | posX, | ||
float | posY, | ||
float | width, | ||
float | height ) |
|
explicit |
|
override |
|
virtual |
Reimplemented in CGUIControlGroupList, and CGUIListGroup.
|
overridevirtual |
Reimplemented from CGUIControl.
Reimplemented in CGUIWindow.
|
overridevirtual |
Reimplemented from CGUIControl.
|
overridevirtual |
Reimplemented from CGUIControl.
|
virtual |
Reimplemented in CGUIControlGroupList, and CGUIWindow.
|
inlineoverridevirtual |
Implements CGUIControl.
Reimplemented in CGUIControlGroupList, and CGUIListGroup.
Reimplemented from CGUIControl.
Reimplemented in CGUIWindow.
Reimplemented from CGUIControl.
Reimplemented in CGUIWindow, CGUIWindowSettingsScreenCalibration, PERIPHERALS::CGUIDialogPeripherals, and XBMCAddon::xbmcgui::WindowXMLInterceptor.
|
virtual |
CGUIControl * CGUIControlGroup::GetFocusedControl | ( | ) | const |
int CGUIControlGroup::GetFocusedControlID | ( | ) | const |
|
overridevirtual |
Reimplemented from CGUIControl.
Reimplemented from CGUIControl.
bool CGUIControlGroup::InsertControl | ( | CGUIControl * | control, |
const CGUIControl * | insertPoint ) |
|
overridevirtual |
Reimplemented from CGUIControl.
Reimplemented in CGUIWindow.
|
inlineoverridevirtual |
Reimplemented from CGUIControl.
Reimplemented from CGUIControl.
Reimplemented in CGUIControlGroupList, CGUIDialog, CGUIDialogAddonInfo, CGUIDialogAddonSettings, CGUIDialogContextMenu, CGUIDialogFileBrowser, CGUIDialogFullScreenInfo, CGUIDialogGamepad, CGUIDialogKeyboardGeneric, CGUIDialogMusicInfo, CGUIDialogMusicOSD, CGUIDialogNumeric, CGUIDialogPictureInfo, CGUIDialogPlayerProcessInfo, CGUIDialogSettingsBase, CGUIDialogSlider, CGUIDialogSongInfo, CGUIDialogTeletext, CGUIDialogTextViewer, CGUIDialogVideoBookmarks, CGUIDialogVideoInfo, CGUIDialogVideoManager, CGUIDialogVideoOSD, CGUIDialogVolumeBar, CGUIMediaWindow, CGUIWindow, CGUIWindowFavourites, CGUIWindowFileManager, CGUIWindowFullScreen, CGUIWindowHome, CGUIWindowLoginScreen, CGUIWindowMusicBase, CGUIWindowMusicNav, CGUIWindowMusicPlayList, CGUIWindowMusicPlaylistEditor, CGUIWindowScreensaver, CGUIWindowSettingsCategory, CGUIWindowSettingsScreenCalibration, CGUIWindowSlideShow, CGUIWindowSplash, CGUIWindowStartup, CGUIWindowVideoBase, CGUIWindowVideoNav, CGUIWindowVideoPlaylist, CGUIWindowVisualisation, PVR::CGUIDialogPVRChannelManager, PVR::CGUIDialogPVRChannelsOSD, PVR::CGUIDialogPVRGroupManager, PVR::CGUIDialogPVRItemsViewBase, PVR::CGUIWindowPVRBase, PVR::CGUIWindowPVRChannelsBase, PVR::CGUIWindowPVRGuideBase, PVR::CGUIWindowPVRProvidersBase, PVR::CGUIWindowPVRRecordingsBase, PVR::CGUIWindowPVRSearchBase, PVR::CGUIWindowPVRTimersBase, XBMCAddon::xbmcgui::Interceptor< CGUIMediaWindow >, and XBMCAddon::xbmcgui::WindowXMLInterceptor.
|
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::CGUIWindowPVRProvidersBase, PVR::CGUIWindowPVRRecordingsBase, PVR::CGUIWindowPVRSearchBase, PVR::CGUIWindowPVRTimersBase, and XBMCAddon::xbmcgui::Interceptor< CGUIMediaWindow >.
|
overridevirtual |
Reimplemented from CGUIControl.
Reimplemented in CGUIControlGroupList, CGUIDialogBoxBase, CGUIDialogExtendedProgressBar, CGUIDialogKeyboardTouch, CGUIDialogProgress, CGUIDialogSubtitles, CGUIDialogTeletext, CGUIListGroup, CGUIWindowDebugInfo, CGUIWindowFullScreen, CGUIWindowPointer, CGUIWindowScreensaver, CGUIWindowScreensaverDim, CGUIWindowSlideShow, and XBMCAddon::xbmcgui::WindowXMLInterceptor.
|
overridevirtual |
Reimplemented from CGUIControl.
|
virtual |
|
overridevirtual |
Reimplemented from CGUIControl.
Reimplemented in CGUIControlGroupList, CGUIDialog, CGUIDialogBusy, CGUIDialogBusyNoCancel, CGUIDialogTeletext, CGUIWindowDebugInfo, CGUIWindowFullScreen, CGUIWindowScreensaver, CGUIWindowScreensaverDim, CGUIWindowSlideShow, and CGUIWindowSplash.
|
overridevirtual |
Reimplemented from CGUIControl.
Reimplemented in CGUIWindowFullScreen, and CGUIWindowSlideShow.
|
overridevirtual |
Reimplemented from CGUIControl.
Reimplemented in CGUIListGroup.
|
overridevirtual |
Reimplemented from CGUIControl.
|
overridevirtual |
Reimplemented from CGUIControl.
|
virtual |
|
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.
point | the location in transformed skin coordinates from the upper left corner of the parent control. |
event | the mouse event to perform |
Reimplemented from CGUIControl.
Reimplemented in CGUIControlGroupList.
|
overridevirtual |
Reimplemented from CGUIControl.
Reimplemented in CGUIWindow.
Unfocus the control if the given point on screen is not within it's boundary.
point | the location in transformed skin coordinates from the upper left corner of the parent control. |
Reimplemented from CGUIControl.
Reimplemented in CGUIControlGroupList.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |