Window

Inherits AddonCallback.

Inherited by WindowDialog, and WindowXML.

Public Member Functions
	addControl (...)
	Function: addControl(Control) Add a Control to this window.
	addControls (...)
	Function: addControls(List) Add a list of Controls to this window.
	clearProperties ()
	Function: clearProperties() Clears all window properties.
	clearProperty (...)
	Function: clearProperty(key) Clears the specific window property.
	close ()
	Function: close() Closes this window.
SWIGHIDDENVIRTUAL void	dispose ()
	doModal ()
	Function: doModal() Display this window until close() is called.
	getControl (...)
	Function: getControl(controlId) Gets the control from this window.
	getFocus ()
	Function: getFocus(Control) Returns the control which is focused.
	getFocusId ()
	Function: getFocusId(int) Returns the id of the control which is focused.
	getHeight ()
	Function: getHeight() Returns the height of this Window instance.
	getProperty (...)
	Function: getProperty(key) Returns a window property as a string, similar to an infolabel.
	getWidth ()
	Function: getWidth() Returns the width of this Window instance.
void	interceptorClear ()
SWIGHIDDENVIRTUAL bool	IsDialog () const
SWIGHIDDENVIRTUAL bool	IsDialogRunning () const
SWIGHIDDENVIRTUAL bool	IsMediaWindow () const
SWIGHIDDENVIRTUAL bool	IsModalDialog () const
SWIGHIDDENVIRTUAL bool	OnAction (const CAction &action)
	onAction (...)
	Function: onAction(self, Action action) onAction method.
SWIGHIDDENVIRTUAL bool	OnBack (int actionId)
	onClick (...)
	Function: onClick(self, int controlId) onClick method.
void	onControl (...)
	Function: onControl(self, Control) onControl method.
SWIGHIDDENVIRTUAL void	OnDeinitWindow (int nextWindowID)
	onDoubleClick (...)
	Function: onDoubleClick(self, int controlId) onDoubleClick method.
	onFocus (...)
	Function: onFocus(self, int controlId) onFocus method.
	onInit (...)
	Function: onInit(self) onInit method.
SWIGHIDDENVIRTUAL bool	OnMessage (CGUIMessage &message)
	removeControl (...)
	Function: removeControl(Control) Removes the control from this window.
	removeControls (...)
	Function: removeControls(List) Removes a list of controls from this window.
	setFocus (...)
	Function: setFocus(Control) Give the supplied control focus.
	setFocusId (...)
	Function: setFocusId(ControlId) Gives the control with the supplied focus.
	setProperty (...)
	Function: setProperty(key, value) Sets a window property, similar to an infolabel.
	show ()
	Function: show() Show this window.
	Window (int existingWindowId=-1)

Protected Member Functions
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	getNextAvailableWindowId ()

Protected Attributes
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	WindowDialogMixin

Constructor & Destructor Documentation

Window()

Window ( bool discrim )

explicitprotected

This only takes a boolean to allow subclasses to explicitly use it. A default constructor can be used as a concrete class and we need to tell the difference. subclasses should use this constructor and not the other.

Member Function Documentation

getNextAvailableWindowId()

static int getNextAvailableWindowId ( )

staticprotected

This helper retrieves the next available id. It is assumed that the global lock is already being held.

setWindow()

void setWindow ( InterceptorBase * _window )

protected

Child classes MUST call this in their constructors. It should be an instance of Interceptor<P extends CGUIWindow>. Control of memory management for this class is then given to the Window.

popActiveWindowId()

void popActiveWindowId ( )

protected

This is a helper method since popping the previous window id is a common function.

GetControlById()

Control * GetControlById ( int iControlId, CCriticalSection * gc )

protected

This is a helper method since getting a control by it's id is a common function.

interceptorClear()

void interceptorClear ( )

inline

This is called from the InterceptorBase destructor to prevent further use of the interceptor from the window.

---

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

• /github/workspace/xbmc/interfaces/legacy/Window.h