#include <GUIWindow.h>

Inheritance diagram for CGUIWindow:

Classes
struct	icompare

Public Types
enum	LOAD_TYPE { LOAD_EVERY_TIME , LOAD_ON_GUI_INIT , KEEP_IN_MEMORY }

Public Types inherited from CGUIControl
enum	GUICONTROLTYPES { GUICONTROL_UNKNOWN , GUICONTROL_BUTTON , GUICONTROL_FADELABEL , GUICONTROL_IMAGE , GUICONTROL_BORDEREDIMAGE , GUICONTROL_LABEL , GUICONTROL_LISTGROUP , GUICONTROL_PROGRESS , GUICONTROL_RADIO , GUICONTROL_RSS , GUICONTROL_SLIDER , GUICONTROL_SETTINGS_SLIDER , GUICONTROL_SPIN , GUICONTROL_SPINEX , GUICONTROL_TEXTBOX , GUICONTROL_TOGGLEBUTTON , GUICONTROL_VIDEO , GUICONTROL_GAME , GUICONTROL_MOVER , GUICONTROL_RESIZE , GUICONTROL_EDIT , GUICONTROL_VISUALISATION , GUICONTROL_RENDERADDON , GUICONTROL_MULTI_IMAGE , GUICONTROL_GROUP , GUICONTROL_GROUPLIST , GUICONTROL_SCROLLBAR , GUICONTROL_LISTLABEL , GUICONTROL_GAMECONTROLLER , GUICONTAINER_LIST , GUICONTAINER_WRAPLIST , GUICONTAINER_FIXEDLIST , GUICONTAINER_EPGGRID , GUICONTAINER_PANEL }

enum	GUIVISIBLE { HIDDEN = 0 , DELAYED , VISIBLE }

enum	GUISCROLLVALUE { FOCUS = 0 , NEVER , ALWAYS }

typedef std::map< int, CGUIAction >	ActionMap
	Set actions to perform on navigation. More...

Public Member Functions
	CGUIWindow (int id, const std::string &xmlFile)

	~CGUIWindow (void) override

bool	Initialize ()

bool	Load (const std::string &strFileName, bool bContainsPath=false)

void	CenterWindow ()

void	DoProcess (unsigned int currentTime, CDirtyRegionList &dirtyregions) override

void	DoRender () override
	Main render function, called every frame. Window classes should override this only if they need to alter how something is rendered. General updating on a per-frame basis should be handled in FrameMove instead, as DoRender is not necessarily re-entrant. More...

void	AfterRender ()
	Do any post render activities. Check if window closing animation is finished and finalize window closing. More...

virtual void	FrameMove ()
	Main update function, called every frame prior to rendering Any window that requires updating on a frame by frame basis (such as to maintain timers and the like) should override this function. More...

void	Close (bool forceClose=false, int nextWindowID=0, bool enableSound=true, bool bWait=true)

bool	OnAction (const CAction &action) override

virtual bool	OnBack (int actionID)

virtual bool	OnInfo (int actionID)

virtual void	ClearBackground ()
	Clear the background (if necessary) prior to rendering the window. More...

bool	OnMove (int fromControl, int moveAction)

bool	OnMessage (CGUIMessage &message) override

bool	ControlGroupHasFocus (int groupID, int controlID)

void	SetID (int id) override

virtual bool	HasID (int controlID) const

const std::vector< int > &	GetIDRange () const

int	GetPreviousWindow ()

CRect	GetScaledBounds () const

void	ClearAll () override

virtual void	AllocResources (bool forceLoad=false)

void	FreeResources (bool forceUnLoad=false) override

void	DynamicResourceAlloc (bool bOnOff) override

virtual bool	IsDialog () const

virtual bool	IsDialogRunning () const

virtual bool	IsModalDialog () const

virtual bool	IsMediaWindow () const

virtual bool	HasListItems () const

virtual bool	IsSoundEnabled () const

virtual CFileItemPtr	GetCurrentListItem (int offset=0)

virtual int	GetViewContainerID () const

virtual int	GetViewCount () const

virtual bool	CanBeActivated () const

virtual bool	IsActive () const

void	SetCoordsRes (const RESOLUTION_INFO &res)

const RESOLUTION_INFO &	GetCoordsRes () const

void	SetLoadType (LOAD_TYPE loadType)

LOAD_TYPE	GetLoadType ()

int	GetRenderOrder ()

void	SetInitialVisibility () override

bool	IsVisible () const override

virtual bool	HasVisibleControls ()

bool	IsAnimating (ANIMATION_TYPE animType) override

bool	IsCustom () const
	Return if the window is a custom window. More...

void	SetCustom (bool custom)
	Mark this window as custom window. More...

void	DisableAnimations ()

virtual void	ResetControlStates ()

void	UpdateControlStats () override

void	SetRunActionsManually ()

void	RunLoadActions () const

void	RunUnloadActions () const

void	SetProperty (const std::string &key, const CVariant &value)
	Set a property Sets the value of a property referenced by a key. More...

CVariant	GetProperty (const std::string &key) const
	Retrieve a property. More...

void	ClearProperties ()
	Clear a all the window's properties. More...

bool	HasSaveLastControl () const

virtual void	OnDeinitWindow (int nextWindowID)

void	AllocResources () override

Public Member Functions inherited from CGUIControlGroup
	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

virtual bool	SendControlMessage (CGUIMessage &message)

bool	HasFocus () const override

bool	CanFocus () const override

EVENT_RESULT	SendMouseEvent (const CPoint &point, const CMouseEvent &event) override
	React to a mouse event. More...

void	UnfocusFromPoint (const CPoint &point) override
	Unfocus the control if the given point on screen is not within it's boundary. More...

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)

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

CGUIControl *	GetControl (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)

bool	HasProcessed () const
	Returns whether or not we have processed. More...

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 bool	HitTest (const CPoint &point) const
	Used to test whether the point is inside a control. More...

virtual int	GetID (void) const

int	GetParentID () const

virtual bool	IsDynamicallyAllocated ()

bool	IsVisibleFromSkin () const

virtual bool	IsDisabled () const

virtual void	SetPosition (float posX, float posY)

virtual void	SetHitRect (const CRect &rect, const UTILS::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 More...

virtual CRect	CalcRenderRegion () const
	calculate the render region in parentcontrol coordinates of this control Called during process to update m_renderRegion More...

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. More...

CGUIAction	GetAction (int actionID) const
	Get an action the control can be perform. More...

bool	Navigate (int direction) const
	Start navigating in given direction. More...

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)

GUICONTROLTYPES	GetControlType () const

Protected Member Functions
EVENT_RESULT	OnMouseEvent (const CPoint &point, const CMouseEvent &event) override
	Perform a mouse action. More...

virtual bool	LoadXML (const std::string &strPath, const std::string &strLowerPath)
	Load the window XML from the given path. More...

virtual bool	Load (TiXmlElement *pRootElement)
	Loads the window from the given XML element. More...

virtual std::unique_ptr< TiXmlElement >	Prepare (TiXmlElement *pRootElement)
	Prepare the XML for load. More...

bool	NeedLoad () const
	Check if window needs a (re)load. The window need to be (re)loaded when window is not loaded or include conditions values were changed. More...

virtual void	SetDefaults ()

virtual void	OnWindowUnload ()

virtual void	OnWindowLoaded ()

virtual void	OnInitWindow ()
	Called on window open. More...

void	Close_Internal (bool forceClose=false, int nextWindowID=0, bool enableSound=true)

EVENT_RESULT	OnMouseAction (const CAction &action)

bool	Animate (unsigned int currentTime) override

bool	CheckAnimation (ANIMATION_TYPE animType) override

virtual void	SaveControlStates ()

virtual void	RestoreControlStates ()

void	OnEditChanged (int id, std::string &text)

bool	SendMessage (int message, int id, int param1=0, int param2=0)

void	LoadControl (TiXmlElement pControl, CGUIControlGroup pGroup, const CRect &rect)

CPoint	GetPosition () const override
	Grabs the window's top,left position in skin coordinates The window origin may change based on `<origin>` tag conditions in the skin. More...

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. More...

std::pair< LookupMap::const_iterator, LookupMap::const_iterator >	GetLookupControls (int controlId) const

void	AddLookup (CGUIControl *control)

void	RemoveLookup (CGUIControl *control)

void	RemoveLookup ()

const LookupMap &	GetLookup () const

void	ClearLookup ()

Protected Member Functions inherited from CGUIControl
virtual bool	OnMouseOver (const CPoint &point)
	Called when the mouse is over the control. Default implementation selects the control. More...

virtual bool	CanFocusFromPoint (const CPoint &point) const
	Test whether we can focus a control from a point on screen. More...

virtual bool	UpdateColors ()

void	UpdateStates (ANIMATION_TYPE type, ANIMATION_PROCESS currentProcess, ANIMATION_STATE currentState)

bool	SendWindowMessage (CGUIMessage &message) const

Protected Member Functions inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
	CountingLockable ()=default

void	lock ()

bool	try_lock ()

void	unlock ()

unsigned int	exit (unsigned int leave=0)

void	restore (unsigned int restoreCount)

XbmcThreads::CRecursiveMutex &	get_underlying ()

Protected Attributes
std::vector< int >	m_idRange

RESOLUTION_INFO	m_coordsRes

bool	m_needsScaling

bool	m_windowLoaded

LOAD_TYPE	m_loadType

bool	m_dynamicResourceAlloc

bool	m_closing

bool	m_active

KODI::GUILIB::GUIINFO::CGUIInfoColor	m_clearBackground

int	m_renderOrder

std::vector< COrigin >	m_origins

int	m_lastControlID

std::vector< CControlState >	m_controlStates

int	m_previousWindow

bool	m_animationsEnabled

CGUIAction	m_loadActions

CGUIAction	m_unloadActions

TiXmlElement *	m_windowXMLRootElement

bool	m_manualRunActions

int	m_exclusiveMouseControl
	id of child control that wishes to receive all mouse events More...

int	m_menuControlID

int	m_menuLastFocusedControlID

bool	m_custom

Protected Attributes inherited from CGUIControlGroup
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	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

GUICONTROLSTATS *	m_controlStats

CGUIControl *	m_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< CAnimation >	m_animations

CPoint	m_camera

bool	m_hasCamera

float	m_stereo

TransformMatrix	m_transform

TransformMatrix	m_cachedTransform

unsigned int	m_controlDirtyState

CRect	m_renderRegion

Protected Attributes inherited from XbmcThreads::CountingLockable< XbmcThreads::CRecursiveMutex >
XbmcThreads::CRecursiveMutex	mutex

unsigned int	count

Additional Inherited Members
Protected Types inherited from CGUIControlGroup
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

Static Protected Attributes inherited from CGUIControl
static const unsigned int	DIRTY_STATE_CONTROL = 1

static const unsigned int	DIRTY_STATE_CHILD = 2

Member Enumeration Documentation

◆ LOAD_TYPE

enum CGUIWindow::LOAD_TYPE

Enumerator
LOAD_EVERY_TIME
LOAD_ON_GUI_INIT
KEEP_IN_MEMORY

Constructor & Destructor Documentation

◆ CGUIWindow()

CGUIWindow::CGUIWindow	(	int	id,
		const std::string &	xmlFile
	)

◆ ~CGUIWindow()

CGUIWindow::~CGUIWindow ( void )

override

Member Function Documentation

◆ AfterRender()

void CGUIWindow::AfterRender ( )

Do any post render activities. Check if window closing animation is finished and finalize window closing.

◆ AllocResources() [1/2]

void CGUIControlGroup::AllocResources ( )

overridevirtual

Reimplemented from CGUIControlGroup.

◆ AllocResources() [2/2]

void CGUIWindow::AllocResources ( bool forceLoad = false )

virtual

Reimplemented in KodiAPI::GUI::CGUIAddonWindow, ADDON::CGUIAddonWindow, and CGUIWindowSettingsScreenCalibration.

◆ Animate()

bool CGUIWindow::Animate ( unsigned int currentTime )

overrideprotectedvirtual

Reimplemented from CGUIControl.

◆ CanBeActivated()

virtual bool CGUIWindow::CanBeActivated ( ) const

inlinevirtual

Reimplemented in PVR::CGUIDialogPVRTimerSettings, and PVR::CGUIWindowPVRBase.

◆ CenterWindow()

void CGUIWindow::CenterWindow ( )

◆ CheckAnimation()

bool CGUIWindow::CheckAnimation ( ANIMATION_TYPE animType )

overrideprotectedvirtual

Reimplemented from CGUIControl.

◆ ClearAll()

void CGUIWindow::ClearAll ( )

overridevirtual

Reimplemented from CGUIControlGroup.

◆ ClearBackground()

void CGUIWindow::ClearBackground ( )

virtual

Clear the background (if necessary) prior to rendering the window.

Reimplemented in KODI::RETRO::CGameWindowFullScreen, and CGUIWindowFullScreen.

◆ ClearProperties()

void CGUIWindow::ClearProperties ( )

Clear a all the window's properties.

See also: SetProperty, HasProperty, GetProperty

◆ Close()

void CGUIWindow::Close	(	bool	forceClose = `false`,
		int	nextWindowID = `0`,
		bool	enableSound = `true`,
		bool	bWait = `true`
	)

◆ Close_Internal()

void CGUIWindow::Close_Internal	(	bool	forceClose = `false`,
		int	nextWindowID = `0`,
		bool	enableSound = `true`
	)

protected

◆ ControlGroupHasFocus()

bool CGUIWindow::ControlGroupHasFocus	(	int	groupID,
		int	controlID
	)

◆ DisableAnimations()

void CGUIWindow::DisableAnimations ( )

◆ DoProcess()

void CGUIWindow::DoProcess	(	unsigned int	currentTime,
		CDirtyRegionList &	dirtyregions
	)

overridevirtual

Reimplemented from CGUIControl.

Reimplemented in CGUIDialogSettingsBase, and CGUIWindowSettingsScreenCalibration.

◆ DoRender()

void CGUIWindow::DoRender ( )

overridevirtual

Main render function, called every frame. Window classes should override this only if they need to alter how something is rendered. General updating on a per-frame basis should be handled in FrameMove instead, as DoRender is not necessarily re-entrant.

See also: FrameMove

Reimplemented from CGUIControl.

Reimplemented in CGUIWindowSettingsScreenCalibration.

◆ DynamicResourceAlloc()

void CGUIWindow::DynamicResourceAlloc ( bool bOnOff )

overridevirtual

Reimplemented from CGUIControlGroup.

◆ FrameMove()

virtual void CGUIWindow::FrameMove ( )

inlinevirtual

Main update function, called every frame prior to rendering Any window that requires updating on a frame by frame basis (such as to maintain timers and the like) should override this function.

Reimplemented in KODI::RETRO::CGameWindowFullScreen, CGUIDialogButtonMenu, CGUIDialogFileBrowser, CGUIDialogKaiToast, CGUIDialogNumeric, CGUIDialogPlayEject, CGUIDialogSeekBar, KODI::GAME::CDialogGameVideoSelect, CGUIDialogMusicOSD, CGUIWindowMusicNav, CGUIWindowVisualisation, CGUIDialogPictureInfo, CGUIWindowSettingsScreenCalibration, CGUIDialogAudioSettings, CGUIDialogSubtitleSettings, CGUIDialogVideoOSD, CGUIWindowFullScreen, CGUIWindowWeather, CGUIWindowLoginScreen, and CGUIWindowSystemInfo.

◆ FreeResources()

void CGUIWindow::FreeResources ( bool forceUnLoad = false )

overridevirtual

Reimplemented from CGUIControlGroup.

Reimplemented in CGUIWindowSettingsScreenCalibration.

◆ GetCoordsRes()

const RESOLUTION_INFO & CGUIWindow::GetCoordsRes ( ) const

inline

◆ GetCurrentListItem()

virtual CFileItemPtr CGUIWindow::GetCurrentListItem ( int offset = 0 )

inlinevirtual

Reimplemented in CGUIDialogAddonInfo, CGUIDialogFileBrowser, CGUIDialogFavourites, CGUIDialogMusicInfo, CGUIDialogSongInfo, PVR::CGUIDialogPVRChannelManager, PVR::CGUIDialogPVRGuideInfo, PVR::CGUIDialogPVRRecordingInfo, PVR::CGUIWindowPVRGuideBase, CGUIDialogVideoInfo, CGUIMediaWindow, and CGUIWindowLoginScreen.

◆ GetIDRange()

const std::vector< int > & CGUIWindow::GetIDRange ( ) const

inline

◆ GetLoadType()

LOAD_TYPE CGUIWindow::GetLoadType ( )

inline

◆ GetPosition()

CPoint CGUIWindow::GetPosition ( ) const

overrideprotectedvirtual

Grabs the window's top,left position in skin coordinates The window origin may change based on <origin> tag conditions in the skin.

Returns: the window's origin in skin coordinates

Reimplemented from CGUIControl.

◆ GetPreviousWindow()

int CGUIWindow::GetPreviousWindow ( )

inline

◆ GetProperty()

CVariant CGUIWindow::GetProperty ( const std::string & key ) const

Retrieve a property.

Parameters

key	name of the property to retrieve

Returns: value of the property, empty if it doesn't exist

◆ GetRenderOrder()

int CGUIWindow::GetRenderOrder ( )

inline

◆ GetScaledBounds()

CRect CGUIWindow::GetScaledBounds ( ) const

◆ GetViewContainerID()

virtual int CGUIWindow::GetViewContainerID ( ) const

inlinevirtual

Reimplemented in CGUIDialogFileBrowser, CGUIMediaWindow, and CGUIWindowLoginScreen.

◆ GetViewCount()

virtual int CGUIWindow::GetViewCount ( ) const

inlinevirtual

Reimplemented in CGUIMediaWindow.

◆ HasID()

bool CGUIWindow::HasID ( int controlID ) const

virtual

◆ HasListItems()

virtual bool CGUIWindow::HasListItems ( ) const

inlinevirtual

Reimplemented in CGUIDialogAddonInfo, CGUIDialogFileBrowser, CGUIDialogFavourites, CGUIDialogInfoProviderSettings, CGUIDialogMusicInfo, CGUIDialogSongInfo, PVR::CGUIDialogPVRChannelManager, PVR::CGUIDialogPVRGuideInfo, PVR::CGUIDialogPVRRecordingInfo, CGUIDialogContentSettings, CGUIDialogLibExportSettings, CGUIDialogVideoInfo, CGUIMediaWindow, and CGUIWindowLoginScreen.

◆ HasSaveLastControl()

bool CGUIWindow::HasSaveLastControl ( ) const

inline

◆ HasVisibleControls()

virtual bool CGUIWindow::HasVisibleControls ( )

inlinevirtual

Reimplemented in KODI::RETRO::CGameWindowFullScreen, and CGUIWindowFullScreen.

◆ Initialize()

bool CGUIWindow::Initialize ( void )

◆ IsActive()

bool CGUIWindow::IsActive ( ) const

virtual

◆ IsAnimating()

bool CGUIWindow::IsAnimating ( ANIMATION_TYPE animType )

overridevirtual

Reimplemented from CGUIControlGroup.

◆ IsCustom()

bool CGUIWindow::IsCustom ( ) const

inline

Return if the window is a custom window.

Returns: true if the window is an custom window otherwise false

◆ IsDialog()

virtual bool CGUIWindow::IsDialog ( ) const

inlinevirtual

Reimplemented in KodiAPI::GUI::CGUIAddonWindowDialog, ADDON::CGUIAddonWindowDialog, CGUIDialog, and CGUIWindowSettingsCategory.

◆ IsDialogRunning()

virtual bool CGUIWindow::IsDialogRunning ( ) const

inlinevirtual

Reimplemented in KodiAPI::GUI::CGUIAddonWindowDialog, ADDON::CGUIAddonWindowDialog, and CGUIDialog.

◆ IsMediaWindow()

virtual bool CGUIWindow::IsMediaWindow ( ) const

inlinevirtual

Reimplemented in KodiAPI::GUI::CGUIAddonWindowDialog, ADDON::CGUIAddonWindow, and CGUIMediaWindow.

◆ IsModalDialog()

virtual bool CGUIWindow::IsModalDialog ( ) const

inlinevirtual

Reimplemented in KodiAPI::GUI::CGUIAddonWindowDialog, ADDON::CGUIAddonWindowDialog, and CGUIDialog.

◆ IsSoundEnabled()

virtual bool CGUIWindow::IsSoundEnabled ( ) const

inlinevirtual

Reimplemented in CGUIDialog.

◆ IsVisible()

bool CGUIWindow::IsVisible ( ) const

inlineoverridevirtual

Reimplemented from CGUIControl.

◆ Load() [1/2]

bool CGUIWindow::Load	(	const std::string &	strFileName,
		bool	bContainsPath = `false`
	)

◆ Load() [2/2]

bool CGUIWindow::Load ( TiXmlElement * pRootElement )

protectedvirtual

Loads the window from the given XML element.

Parameters

pRootElement the XML element

Returns: true if the window is loaded from the given XML otherwise false.

Reimplemented in CGUIDialog, and CGUIMediaWindow.

◆ LoadControl()

void CGUIWindow::LoadControl	(	TiXmlElement *	pControl,
		CGUIControlGroup *	pGroup,
		const CRect &	rect
	)

protected

◆ LoadXML()

bool CGUIWindow::LoadXML	(	const std::string &	strPath,
		const std::string &	strLowerPath
	)

protectedvirtual

Load the window XML from the given path.

Parameters

strPath	the path to the window XML
strLowerPath	a lowered path to the window XML

◆ NeedLoad()

bool CGUIWindow::NeedLoad ( ) const

protected

Check if window needs a (re)load. The window need to be (re)loaded when window is not loaded or include conditions values were changed.

◆ OnAction()

bool CGUIWindow::OnAction ( const CAction & action )

overridevirtual

Reimplemented from CGUIControlGroup.

Reimplemented in CGUIDialogMusicInfo, CGUIDialogMusicOSD, CGUIDialogSongInfo, CGUIWindowMusicBase, CGUIWindowMusicNav, CGUIWindowMusicPlayList, CGUIWindowVisualisation, CGUIDialogAccessPoints, CGUIDialogPictureInfo, CGUIWindowSlideShow, PVR::CGUIDialogPVRChannelManager, PVR::CGUIDialogPVRChannelsOSD, PVR::CGUIDialogPVRItemsViewBase, PVR::CGUIWindowPVRBase, PVR::CGUIWindowPVRChannelsBase, PVR::CGUIWindowPVRGuideBase, PVR::CGUIWindowPVRRecordingsBase, PVR::CGUIWindowPVRTimersBase, CGUIDialogSettingsBase, CGUIWindowSettingsCategory, CGUIWindowSettingsScreenCalibration, CGUIDialogFullScreenInfo, CGUIDialogTeletext, CGUIDialogVideoBookmarks, CGUIDialogVideoInfo, CGUIDialogVideoOSD, CGUIWindowFullScreen, CGUIWindowVideoBase, CGUIWindowVideoNav, CGUIWindowVideoPlaylist, CGUIMediaWindow, CGUIWindowFileManager, CGUIWindowHome, CGUIWindowLoginScreen, CGUIWindowScreensaver, CGUIWindowSplash, and CGUIWindowStartup.

◆ OnBack()

◆ OnDeinitWindow()

void CGUIWindow::OnDeinitWindow ( int nextWindowID )

virtual

◆ OnEditChanged()

void CGUIWindow::OnEditChanged	(	int	id,
		std::string &	text
	)

protected

◆ OnInfo()

virtual bool CGUIWindow::OnInfo ( int actionID )

inlinevirtual

Reimplemented in PVR::CGUIDialogPVRGuideInfo, and PVR::CGUIDialogPVRRecordingInfo.

◆ OnInitWindow()

void CGUIWindow::OnInitWindow ( void )

protectedvirtual

Called on window open.

Restores the control state(s)
Sets initial visibility of controls
Queue WindowOpen animation
Set overlay state Override this function and do any window-specific initialisation such as filling control contents and setting control focus before calling the base method.

Reimplemented in KODI::RETRO::CGameWindowFullScreen, CGUIDialogBoxBase, CGUIDialogContextMenu, CGUIDialogGamepad, CGUIDialogKeyboardGeneric, CGUIDialogKeyboardTouch, CGUIDialogMediaFilter, CGUIDialogNumeric, CGUIDialogOK, CGUIDialogPlayEject, CGUIDialogProgress, CGUIDialogSelect, CGUIDialogSmartPlaylistEditor, CGUIDialogSmartPlaylistRule, CGUIDialogYesNo, CGUIDialogFavourites, KODI::GAME::CDialogGameOSD, KODI::GAME::CDialogGameVideoSelect, KODI::GAME::CDialogGameVolume, CGUIDialogInfoProviderSettings, CGUIDialogMusicInfo, CGUIDialogSongInfo, CGUIDialogVisualisationPresetList, CGUIWindowMusicBase, CGUIDialogAccessPoints, CGUIDialogNetworkSetup, CGUIDialogPictureInfo, CGUIWindowPictures, CGUIWindowSettingsProfile, PVR::CGUIDialogPVRChannelGuide, PVR::CGUIDialogPVRChannelManager, PVR::CGUIDialogPVRChannelsOSD, PVR::CGUIDialogPVRGroupManager, PVR::CGUIDialogPVRGuideInfo, PVR::CGUIDialogPVRGuideSearch, PVR::CGUIDialogPVRItemsViewBase, PVR::CGUIDialogPVRRadioRDSInfo, PVR::CGUIWindowPVRGuideBase, CGUIDialogContentSettings, CGUIDialogLibExportSettings, CGUIDialogSettingsBase, CGUIDialogSubtitles, CGUIDialogTeletext, CGUIDialogVideoInfo, CGUIWindowWeather, CGUIMediaWindow, CGUIWindowFileManager, CGUIWindowHome, CGUIWindowLoginScreen, CGUIWindowSplash, KODI::GAME::CGUIControllerWindow, and PVR::CGUIWindowPVRBase.

◆ OnMessage()

bool CGUIWindow::OnMessage ( CGUIMessage & message )

overridevirtual

Reimplemented from CGUIControlGroup.

Reimplemented in CGUIDialogMusicInfo, CGUIDialogMusicOSD, CGUIDialogSongInfo, CGUIDialogVisualisationPresetList, CGUIWindowMusicBase, CGUIWindowMusicNav, CGUIWindowMusicPlayList, CGUIWindowMusicPlaylistEditor, CGUIWindowVisualisation, CGUIDialogNetworkSetup, PERIPHERALS::CGUIDialogPeripherals, PERIPHERALS::CGUIDialogPeripheralSettings, CGUIWindowPictures, CGUIWindowSlideShow, CGUIWindowSettingsProfile, CGUIWindowPrograms, 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, CGUIDialogLibExportSettings, CGUIDialogSettingsBase, CGUIWindowSettingsCategory, CGUIWindowSettingsScreenCalibration, CGUIDialogSubtitles, CGUIDialogSubtitleSettings, CGUIDialogTeletext, CGUIDialogVideoBookmarks, CGUIDialogVideoInfo, CGUIDialogVideoOSD, CGUIWindowFullScreen, CGUIWindowVideoBase, CGUIWindowVideoNav, CGUIWindowVideoPlaylist, CGUIWindowWeather, CGUIMediaWindow, CGUIWindowDebugInfo, CGUIWindowFileManager, CGUIWindowHome, CGUIWindowLoginScreen, CGUIWindowScreensaver, and CGUIWindowSystemInfo.

◆ OnMouseAction()

EVENT_RESULT CGUIWindow::OnMouseAction ( const CAction & action )

protected

◆ OnMouseEvent()

EVENT_RESULT CGUIWindow::OnMouseEvent	(	const CPoint &	point,
		const 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

point	the location in transformed skin coordinates from the upper left corner of the parent control.
event	the mouse event to perform

Returns: EVENT_RESULT corresponding to whether the control handles this event

See also: SendMouseEvent, HitTest, CanFocusFromPoint, CMouseEvent

Reimplemented from CGUIControl.

Reimplemented in CGUIWindowVisualisation, CGUIWindowSlideShow, CGUIDialogVideoOSD, CGUIWindowFullScreen, and CGUIWindowScreensaver.

◆ OnMove()

bool CGUIWindow::OnMove	(	int	fromControl,
		int	moveAction
	)

◆ OnWindowLoaded()

◆ OnWindowUnload()

virtual void CGUIWindow::OnWindowUnload ( void )

inlineprotectedvirtual

Reimplemented in CGUIDialogFileBrowser, CGUIDialogSelect, KODI::GAME::CDialogGameVideoSelect, PVR::CGUIDialogPVRGroupManager, PVR::CGUIDialogPVRItemsViewBase, CGUIDialogVideoBookmarks, CGUIMediaWindow, CGUIWindowLoginScreen, and PVR::CGUIDialogPVRChannelManager.

◆ Prepare()

std::unique_ptr< TiXmlElement > CGUIWindow::Prepare ( TiXmlElement * pRootElement )

protectedvirtual

Prepare the XML for load.

Parameters

pRootElement the original XML element

Returns: the prepared XML (resolved includes, constants and expression)

◆ ResetControlStates()

void CGUIWindow::ResetControlStates ( )

virtual

◆ RestoreControlStates()

void CGUIWindow::RestoreControlStates ( )

protectedvirtual

Reimplemented in PVR::CGUIDialogPVRChannelsOSD, and CGUIMediaWindow.

◆ RunLoadActions()

void CGUIWindow::RunLoadActions ( ) const

◆ RunUnloadActions()

void CGUIWindow::RunUnloadActions ( ) const

◆ SaveControlStates()

void CGUIWindow::SaveControlStates ( )

protectedvirtual

Reimplemented in PVR::CGUIDialogPVRChannelsOSD, and CGUIMediaWindow.

◆ SendMessage()

bool CGUIWindow::SendMessage	(	int	message,
		int	id,
		int	param1 = `0`,
		int	param2 = `0`
	)

protected

◆ SetCoordsRes()

void CGUIWindow::SetCoordsRes ( const RESOLUTION_INFO & res )

inline

◆ SetCustom()

void CGUIWindow::SetCustom ( bool custom )

inline

Mark this window as custom window.

Parameters

custom true if this window is a custom window, false if not

◆ SetDefaults()

void CGUIWindow::SetDefaults ( )

protectedvirtual

Reimplemented in CGUIDialog.

◆ SetID()

void CGUIWindow::SetID ( int id )

overridevirtual

Reimplemented from CGUIControl.

◆ SetInitialVisibility()

void CGUIWindow::SetInitialVisibility ( )

overridevirtual

Reimplemented from CGUIControlGroup.

◆ SetLoadType()

void CGUIWindow::SetLoadType ( LOAD_TYPE loadType )

inline

◆ SetProperty()

void CGUIWindow::SetProperty	(	const std::string &	key,
		const CVariant &	value
	)

Set a property Sets the value of a property referenced by a key.

Parameters

key	name of the property to set
value	value to set, may be a string, integer, boolean or double.

See also: GetProperty

◆ SetRunActionsManually()

void CGUIWindow::SetRunActionsManually ( )

◆ UpdateControlStats()

void CGUIWindow::UpdateControlStats ( )

inlineoverridevirtual

Reimplemented from CGUIControl.

Member Data Documentation

◆ m_active

bool CGUIWindow::m_active

protected

◆ m_animationsEnabled

bool CGUIWindow::m_animationsEnabled

protected

◆ m_clearBackground

KODI::GUILIB::GUIINFO::CGUIInfoColor CGUIWindow::m_clearBackground

protected

◆ m_closing

bool CGUIWindow::m_closing

protected

◆ m_controlStates

std::vector<CControlState> CGUIWindow::m_controlStates

protected

◆ m_coordsRes

RESOLUTION_INFO CGUIWindow::m_coordsRes

protected

◆ m_custom

bool CGUIWindow::m_custom

protected

◆ m_dynamicResourceAlloc

bool CGUIWindow::m_dynamicResourceAlloc

protected

◆ m_exclusiveMouseControl

int CGUIWindow::m_exclusiveMouseControl

protected

id of child control that wishes to receive all mouse events

See also: GUI_MSG_EXCLUSIVE_MOUSE

◆ m_idRange

std::vector<int> CGUIWindow::m_idRange

protected

◆ m_lastControlID

int CGUIWindow::m_lastControlID

protected

◆ m_loadActions

CGUIAction CGUIWindow::m_loadActions

protected

◆ m_loadType

LOAD_TYPE CGUIWindow::m_loadType

protected

◆ m_manualRunActions

bool CGUIWindow::m_manualRunActions

protected

◆ m_menuControlID

int CGUIWindow::m_menuControlID

protected

◆ m_menuLastFocusedControlID

int CGUIWindow::m_menuLastFocusedControlID

protected

◆ m_needsScaling

bool CGUIWindow::m_needsScaling

protected

◆ m_origins

std::vector<COrigin> CGUIWindow::m_origins

protected

◆ m_previousWindow

int CGUIWindow::m_previousWindow

protected

◆ m_renderOrder

int CGUIWindow::m_renderOrder

protected

◆ m_unloadActions

CGUIAction CGUIWindow::m_unloadActions

protected

◆ m_windowLoaded

bool CGUIWindow::m_windowLoaded

protected

◆ m_windowXMLRootElement

TiXmlElement* CGUIWindow::m_windowXMLRootElement

protected

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ LOAD_TYPE

Constructor & Destructor Documentation

◆ CGUIWindow()

◆ ~CGUIWindow()

Member Function Documentation

◆ AfterRender()

◆ AllocResources() [1/2]

◆ AllocResources() [2/2]

◆ Animate()

◆ CanBeActivated()

◆ CenterWindow()

◆ CheckAnimation()

◆ ClearAll()

◆ ClearBackground()

◆ ClearProperties()

◆ Close()

◆ Close_Internal()

◆ ControlGroupHasFocus()

◆ DisableAnimations()

◆ DoProcess()

◆ DoRender()

◆ DynamicResourceAlloc()

◆ FrameMove()

◆ FreeResources()

◆ GetCoordsRes()

◆ GetCurrentListItem()

◆ GetIDRange()

◆ GetLoadType()

◆ GetPosition()

◆ GetPreviousWindow()

◆ GetProperty()

◆ GetRenderOrder()

◆ GetScaledBounds()

◆ GetViewContainerID()

◆ GetViewCount()

◆ HasID()

◆ HasListItems()

◆ HasSaveLastControl()

◆ HasVisibleControls()

◆ Initialize()

◆ IsActive()

◆ IsAnimating()

◆ IsCustom()

◆ IsDialog()

◆ IsDialogRunning()

◆ IsMediaWindow()

◆ IsModalDialog()

◆ IsSoundEnabled()

◆ IsVisible()

◆ Load() [1/2]

◆ Load() [2/2]

◆ LoadControl()

◆ LoadXML()

◆ NeedLoad()

◆ OnAction()

◆ OnBack()

◆ OnDeinitWindow()

◆ OnEditChanged()

◆ OnInfo()

◆ OnInitWindow()

◆ OnMessage()

◆ OnMouseAction()

◆ OnMouseEvent()

◆ OnMove()

◆ OnWindowLoaded()

◆ OnWindowUnload()

◆ Prepare()

◆ ResetControlStates()

◆ RestoreControlStates()

◆ RunLoadActions()

◆ RunUnloadActions()

◆ SaveControlStates()

◆ SendMessage()