XBMCAddon::xbmcgui::WindowXML Class Reference

Inheritance diagram for XBMCAddon::xbmcgui::WindowXML:

Collaboration diagram for XBMCAddon::xbmcgui::WindowXML:

Public Member Functions
	WindowXML (const String &xmlFilename, const String &scriptPath, const String &defaultSkin="Default", const String &defaultRes="720p", bool isMedia=false)
SWIGHIDDENVIRTUAL void	addItem (const Alternative< String, const ListItem *> &item, int position=INT_MAX)
SWIGHIDDENVIRTUAL void	addItems (const std::vector< Alternative< String, const XBMCAddon::xbmcgui::ListItem * > > &items)
SWIGHIDDENVIRTUAL void	removeItem (int position)
SWIGHIDDENVIRTUAL int	getCurrentListPosition ()
SWIGHIDDENVIRTUAL void	setCurrentListPosition (int position)
SWIGHIDDENVIRTUAL ListItem *	getListItem (int position)
SWIGHIDDENVIRTUAL int	getListSize ()
SWIGHIDDENVIRTUAL void	clearList ()
SWIGHIDDENVIRTUAL void	setContainerProperty (const String &strProperty, const String &strValue)
SWIGHIDDENVIRTUAL void	setContent (const String &strValue)
SWIGHIDDENVIRTUAL int	getCurrentContainerId ()
bool	OnMessage (CGUIMessage &message) override
bool	OnAction (const CAction &action) override
SWIGHIDDENVIRTUAL void	AllocResources (bool forceLoad=false)
SWIGHIDDENVIRTUAL void	FreeResources (bool forceUnLoad=false)
SWIGHIDDENVIRTUAL bool	OnClick (int iItem)
SWIGHIDDENVIRTUAL bool	OnDoubleClick (int iItem)
SWIGHIDDENVIRTUAL void	Process (unsigned int currentTime, CDirtyRegionList &dirtyregions)
bool	IsMediaWindow () const override
Public Member Functions inherited from XBMCAddon::xbmcgui::Window
	Window (int existingWindowId=-1)
	This just creates a default window.
SWIGHIDDENVIRTUAL bool	OnMessage (CGUIMessage &message)
SWIGHIDDENVIRTUAL bool	OnAction (const CAction &action)
SWIGHIDDENVIRTUAL bool	OnBack (int actionId)
SWIGHIDDENVIRTUAL void	OnDeinitWindow (int nextWindowID)
SWIGHIDDENVIRTUAL bool	IsDialogRunning () const
SWIGHIDDENVIRTUAL bool	IsDialog () const
SWIGHIDDENVIRTUAL bool	IsModalDialog () const
SWIGHIDDENVIRTUAL bool	IsMediaWindow () const
SWIGHIDDENVIRTUAL void	dispose ()
void	interceptorClear ()
	This is called from the InterceptorBase destructor to prevent further use of the interceptor from the window.
virtual void	onAction (Action *action)
virtual void	onControl (Control *control)
virtual void	onClick (int controlId)
virtual void	onDoubleClick (int controlId)
virtual void	onFocus (int controlId)
virtual void	onInit ()
SWIGHIDDENVIRTUAL void	show ()
SWIGHIDDENVIRTUAL void	setFocus (Control *pControl)
SWIGHIDDENVIRTUAL void	setFocusId (int iControlId)
SWIGHIDDENVIRTUAL Control *	getFocus ()
SWIGHIDDENVIRTUAL long	getFocusId ()
SWIGHIDDENVIRTUAL void	removeControl (Control *pControl)
SWIGHIDDENVIRTUAL void	removeControls (std::vector< Control *> pControls)
SWIGHIDDENVIRTUAL long	getHeight ()
SWIGHIDDENVIRTUAL long	getWidth ()
SWIGHIDDENVIRTUAL void	setProperty (const char *key, const String &value)
SWIGHIDDENVIRTUAL String	getProperty (const char *key)
SWIGHIDDENVIRTUAL void	clearProperty (const char *key)
SWIGHIDDENVIRTUAL void	clearProperties ()
SWIGHIDDENVIRTUAL void	close ()
SWIGHIDDENVIRTUAL void	doModal ()
SWIGHIDDENVIRTUAL void	addControl (Control *pControl)
SWIGHIDDENVIRTUAL void	addControls (std::vector< Control *> pControls)
SWIGHIDDENVIRTUAL Control *	getControl (int iControlId)
Public Member Functions inherited from XBMCAddon::AddonCallback
void	setHandler (CallbackHandler *_handler)
void	invokeCallback (Callback *callback)
Public Member Functions inherited from XBMCAddon::AddonClass
const char *	GetClassname () const
LanguageHook *	GetLanguageHook ()
bool	isDeallocating ()
	This method should be called while holding a Synchronize on the object. More...
void	Release () const
void	Acquire () const

Protected Member Functions
SWIGHIDDENVIRTUAL bool	LoadXML (const String &strPath, const String &strPathLower)
SWIGHIDDENVIRTUAL void	GetContextButtons (int itemNumber, CContextButtons &buttons)
SWIGHIDDENVIRTUAL bool	Update (const String &strPath)
void	SetupShares ()
Protected Member Functions inherited from XBMCAddon::xbmcgui::Window
	Window (bool discrim)
	This only takes a boolean to allow subclasses to explicitly use it. More...
void	deallocating () override
	This method is meant to be called from the destructor of the lowest level class. More...
void	setWindow (InterceptorBase *_window)
	Child classes MUST call this in their constructors. More...
void	popActiveWindowId ()
	This is a helper method since popping the previous window id is a common function.
Control *	GetControlById (int iControlId, CCriticalSection *gc)
	This is a helper method since getting a control by it's id is a common function. More...
SWIGHIDDENVIRTUAL void	PulseActionEvent ()
SWIGHIDDENVIRTUAL bool	WaitForActionEvent (unsigned int milliseconds)
Protected Member Functions inherited from XBMCAddon::AddonCallback
bool	hasHandler ()

Static Protected Member Functions
static int	lockingGetNextAvailableWindowId ()
	This helper retrieves the next available id. More...
Static Protected Member Functions inherited from XBMCAddon::xbmcgui::Window
static int	getNextAvailableWindowId ()
	This helper retrieves the next available id. More...
Static Protected Member Functions inherited from XBMCAddon::AddonClass
static short	getNextClassIndex ()
	This is meant to be called during static initialization and so isn't synchronized.

Protected Attributes
WindowXMLInterceptor *	interceptor
String	m_scriptPath
String	m_mediaDir
bool	m_isMedia
Protected Attributes inherited from XBMCAddon::xbmcgui::Window
InterceptorBase *	window
int	iWindowId = -1
std::vector< AddonClass::Ref< Control > >	vecControls
int	iOldWindowId = 0
int	iCurrentControlId = 3000
bool	bModal = false
CEvent	m_actionEvent
bool	canPulse = false
bool	existingWindow = true
bool	destroyAfterDeInit = false
Protected Attributes inherited from XBMCAddon::AddonCallback
AddonClass::Ref< CallbackHandler >	handler
Protected Attributes inherited from XBMCAddon::AddonClass
LanguageHook *	languageHook

Friends
class	WindowXMLInterceptor

Additional Inherited Members
Static Public Member Functions inherited from XBMCAddon::AddonClass
static short	getNumAddonClasses ()

Member Function Documentation

lockingGetNextAvailableWindowId()

int XBMCAddon::xbmcgui::WindowXML::lockingGetNextAvailableWindowId ( )

staticprotected

This helper retrieves the next available id.

It is doesn't assume that the global lock is already being held.

OnMessage()

bool XBMCAddon::xbmcgui::WindowXML::OnMessage ( CGUIMessage &  message )

override

Todo:

We shouldn't be dropping down to CGUIWindow in any of this ideally. We have to make up our minds about what python should be doing and what this side of things should be doing

---

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

• xbmc/interfaces/legacy/WindowXML.h
• xbmc/interfaces/legacy/WindowXML.cpp