Inherits Window.

Inherited by WindowXMLDialog.

Public Member Functions
	addItem (...)
	`Function: addItem(item[, position])` Add a new item to this Window List. More...

	addItems (...)
	`Function: addItems(items)` Add a list of items to to the window list. More...

SWIGHIDDENVIRTUAL void	AllocResources (bool forceLoad=false)

	clearList ()
	`Function: clearList()` Clear the Window List. More...

SWIGHIDDENVIRTUAL void	FreeResources (bool forceUnLoad=false)

	getCurrentContainerId (...)
	`Function: getCurrentContainerId()` Get the id of the currently visible container. More...

	getCurrentListPosition ()
	`Function: getCurrentListPosition()` Gets the current position in the Window List. More...

	getListItem (...)
	`Function: getListItem(position)` Returns a given ListItem in this Window List. More...

	getListSize ()
	`Function: getListSize()` Returns the number of items in this Window List. More...

bool	IsMediaWindow () const override

bool	OnAction (const CAction &action) override

SWIGHIDDENVIRTUAL bool	OnClick (int iItem)

SWIGHIDDENVIRTUAL bool	OnDoubleClick (int iItem)

bool	OnMessage (CGUIMessage &message) override

SWIGHIDDENVIRTUAL void	Process (unsigned int currentTime, CDirtyRegionList &dirtyregions)

	removeItem (...)
	`Function: removeItem(position)` Removes a specified item based on position, from the Window List. More...

	setContainerProperty (...)
	`Function: setContainerProperty(key, value)` Sets a container property, similar to an infolabel. More...

	setContent (...)
	`Function: setContent(value)` Sets the content type of the container. More...

	setCurrentListPosition (...)
	`Function: setCurrentListPosition(position)` Set the current position in the Window List. More...

	WindowXML (const String &xmlFilename, const String &scriptPath, const String &defaultSkin="Default", const String &defaultRes="720p", bool isMedia=false)

Public Member Functions inherited from Window
	addControl (...)
	`Function: addControl(Control)` Add a Control to this window. More...

	addControls (...)
	`Function: addControls(List)` Add a list of Controls to this window. More...

	clearProperties ()
	`Function: clearProperties()` Clears all window properties. More...

	clearProperty (...)
	`Function: clearProperty(key)` Clears the specific window property. More...

	close ()
	`Function: close()` Closes this window. More...

SWIGHIDDENVIRTUAL void	dispose ()

	doModal ()
	`Function: doModal()` Display this window until close() is called. More...

	getControl (...)
	`Function: getControl(controlId)` Gets the control from this window. More...

	getFocus ()
	`Function: getFocus(Control)` Returns the control which is focused. More...

	getFocusId ()
	`Function: getFocusId(int)` Returns the id of the control which is focused. More...

	getHeight ()
	`Function: getHeight()` Returns the height of this Window instance. More...

	getProperty (...)
	`Function: getProperty(key)` Returns a window property as a string, similar to an infolabel. More...

	getWidth ()
	`Function: getWidth()` Returns the width of this Window instance. More...

void	interceptorClear ()

SWIGHIDDENVIRTUAL bool	IsDialog () const

SWIGHIDDENVIRTUAL bool	IsDialogRunning () const

SWIGHIDDENVIRTUAL bool	IsMediaWindow () const

SWIGHIDDENVIRTUAL bool	IsModalDialog () const

	onAction (...)
	`Function: onAction(self, Action action)` onAction method. More...

SWIGHIDDENVIRTUAL bool	OnAction (const CAction &action)

SWIGHIDDENVIRTUAL bool	OnBack (int actionId)

	onClick (...)
	`Function: onClick(self, int controlId)` onClick method. More...

void	onControl (...)
	`Function: onControl(self, Control)` onControl method. More...

SWIGHIDDENVIRTUAL void	OnDeinitWindow (int nextWindowID)

	onDoubleClick (...)
	`Function: onDoubleClick(self, int controlId)` onDoubleClick method. More...

	onFocus (...)
	`Function: onFocus(self, int controlId)` onFocus method. More...

	onInit (...)
	`Function: onInit(self)` onInit method. More...

SWIGHIDDENVIRTUAL bool	OnMessage (CGUIMessage &message)

	removeControl (...)
	`Function: removeControl(Control)` Removes the control from this window. More...

	removeControls (...)
	`Function: removeControls(List)` Removes a list of controls from this window. More...

	setFocus (...)
	`Function: setFocus(Control)` Give the supplied control focus. More...

	setFocusId (...)
	`Function: setFocusId(ControlId)` Gives the control with the supplied focus. More...

	setProperty (...)
	`Function: setProperty(key, value)` Sets a window property, similar to an infolabel. More...

	show ()
	`Function: show()` Show this window. More...

	Window (int existingWindowId=-1)

Protected Member Functions
SWIGHIDDENVIRTUAL void	GetContextButtons (int itemNumber, CContextButtons &buttons)

SWIGHIDDENVIRTUAL bool	LoadXML (const String &strPath, const String &strPathLower)

void	SetupShares ()

SWIGHIDDENVIRTUAL bool	Update (const String &strPath)

Protected Member Functions inherited from Window
void	deallocating () override

Control *	GetControlById (int iControlId, CCriticalSection *gc)

void	popActiveWindowId ()

SWIGHIDDENVIRTUAL void	PulseActionEvent ()

void	setWindow (InterceptorBase *_window)

SWIGHIDDENVIRTUAL bool	WaitForActionEvent (unsigned int milliseconds)

	Window (bool discrim)

Static Protected Member Functions
static int	lockingGetNextAvailableWindowId ()

Static Protected Member Functions inherited from Window
static int	getNextAvailableWindowId ()

Protected Attributes
WindowXMLInterceptor *	interceptor

bool	m_isMedia

String	m_mediaDir

String	m_scriptPath

Protected Attributes inherited from Window
bool	bModal = false

bool	canPulse = false

bool	destroyAfterDeInit = false

bool	existingWindow = true

int	iCurrentControlId = 3000

int	iOldWindowId = 0

int	iWindowId = -1

CEvent	m_actionEvent

std::vector< AddonClass::Ref< Control > >	vecControls

InterceptorBase *	window

Friends
class	WindowXMLInterceptor

Member Function Documentation

◆ lockingGetNextAvailableWindowId()

static int lockingGetNextAvailableWindowId ( )

staticprotected

This helper retrieves the next available id. It is doesn't assume that the global lock is already being held.

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

/home/alwin/Development/Kodi/kodi-N-sync-addon-doxygen/xbmc/interfaces/legacy/WindowXML.h

Public Member Functions

Function: addItem(item[, position])

Function: addItems(items)

Function: clearList()

Function: getCurrentContainerId()

Function: getCurrentListPosition()

Function: getListItem(position)

Function: getListSize()

Function: removeItem(position)

Function: setContainerProperty(key, value)

Function: setContent(value)

Function: setCurrentListPosition(position)

Function: addControl(Control)

Function: addControls(List)

Function: clearProperties()

Function: clearProperty(key)

Function: close()

Function: doModal()

Function: getControl(controlId)

Function: getFocus(Control)

Function: getFocusId(int)

Function: getHeight()

Function: getProperty(key)

Function: getWidth()

Function: onAction(self, Action action)

Function: onClick(self, int controlId)

Function: onControl(self, Control)

Function: onDoubleClick(self, int controlId)

Function: onFocus(self, int controlId)

Function: onInit(self)

Function: removeControl(Control)

Function: removeControls(List)

Function: setFocus(Control)

Function: setFocusId(ControlId)

Function: setProperty(key, value)

Function: show()

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Member Function Documentation

◆ lockingGetNextAvailableWindowId()

`Function: addItem(item[, position])`

`Function: addItems(items)`

`Function: clearList()`

`Function: getCurrentContainerId()`

`Function: getCurrentListPosition()`

`Function: getListItem(position)`

`Function: getListSize()`

`Function: removeItem(position)`

`Function: setContainerProperty(key, value)`

`Function: setContent(value)`

`Function: setCurrentListPosition(position)`

`Function: addControl(Control)`

`Function: addControls(List)`

`Function: clearProperties()`

`Function: clearProperty(key)`

`Function: close()`

`Function: doModal()`

`Function: getControl(controlId)`

`Function: getFocus(Control)`

`Function: getFocusId(int)`

`Function: getHeight()`

`Function: getProperty(key)`

`Function: getWidth()`

`Function: onAction(self, Action action)`

`Function: onClick(self, int controlId)`

`Function: onControl(self, Control)`

`Function: onDoubleClick(self, int controlId)`

`Function: onFocus(self, int controlId)`

`Function: onInit(self)`

`Function: removeControl(Control)`

`Function: removeControls(List)`

`Function: setFocus(Control)`

`Function: setFocusId(ControlId)`

`Function: setProperty(key, value)`

`Function: show()`