XBMCAddon::xbmcgui::WindowDialog Class Reference

#include <WindowDialog.h>

Inheritance diagram for XBMCAddon::xbmcgui::WindowDialog:

Public Member Functions
	WindowDialog ()
	~WindowDialog () override
bool	OnMessage (CGUIMessage &message) override
bool	OnAction (const CAction &action) override
void	OnDeinitWindow (int nextWindowID) override
bool	IsDialogRunning () const override
bool	IsModalDialog () const override
bool	IsDialog () const override
void	show () override
void	close () override
Public Member Functions inherited from XBMCAddon::xbmcgui::Window
	Window (int existingWindowId=-1)
	~Window () override
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 ()
	onAction (...)
	Function: onAction(self, Action action) onAction method.
void	onControl (...)
	Function: onControl(self, Control) onControl method.
	onClick (...)
	Function: onClick(self, int controlId) onClick method.
	onDoubleClick (...)
	Function: onDoubleClick(self, int controlId) onDoubleClick method.
	onFocus (...)
	Function: onFocus(self, int controlId) onFocus method.
	onInit (...)
	Function: onInit(self) onInit method.
	show ()
	Function: show() Show this window.
	setFocus (...)
	Function: setFocus(Control) Give the supplied control focus.
	setFocusId (...)
	Function: setFocusId(ControlId) Gives the control with the supplied focus.
	getFocus ()
	Function: getFocus(Control) Returns the control which is focused.
	getFocusId ()
	Function: getFocusId(int) Returns the id of the control which is focused.
	removeControl (...)
	Function: removeControl(Control) Removes the control from this window.
	removeControls (...)
	Function: removeControls(List) Removes a list of controls from this window.
	getHeight ()
	Function: getHeight() Returns the height of this Window instance.
	getWidth ()
	Function: getWidth() Returns the width of this Window instance.
	setProperty (...)
	Function: setProperty(key, value) Sets a window property, similar to an infolabel.
	getProperty (...)
	Function: getProperty(key) Returns a window property as a string, similar to an infolabel.
	clearProperty (...)
	Function: clearProperty(key) Clears the specific window property.
	clearProperties ()
	Function: clearProperties() Clears all window properties.
	close ()
	Function: close() Closes this window.
	doModal ()
	Function: doModal() Display this window until close() is called.
	addControl (...)
	Function: addControl(Control) Add a Control to this window.
	addControls (...)
	Function: addControls(List) Add a list of Controls to this window.
	getControl (...)
	Function: getControl(controlId) Gets the control from this window.
Public Member Functions inherited from XBMCAddon::AddonCallback
	~AddonCallback () override
void	setHandler (CallbackHandler *_handler)
void	invokeCallback (Callback *callback)
Public Member Functions inherited from XBMCAddon::AddonClass
	AddonClass ()
virtual	~AddonClass ()
const char *	GetClassname () const
LanguageHook *	GetLanguageHook ()
bool	isDeallocating ()
void	Release () const
void	Acquire () const

Additional Inherited Members
Static Public Member Functions inherited from XBMCAddon::AddonClass
static short	getNumAddonClasses ()
Protected Member Functions inherited from XBMCAddon::xbmcgui::Window
	Window (bool discrim)
void	deallocating () override
void	setWindow (InterceptorBase *_window)
void	popActiveWindowId ()
Control *	GetControlById (int iControlId, CCriticalSection *gc)
SWIGHIDDENVIRTUAL void	PulseActionEvent ()
SWIGHIDDENVIRTUAL bool	WaitForActionEvent (unsigned int milliseconds)
Protected Member Functions inherited from XBMCAddon::AddonCallback
bool	hasHandler ()
	AddonCallback ()
Static Protected Member Functions inherited from XBMCAddon::xbmcgui::Window
static int	getNextAvailableWindowId ()
Static Protected Member Functions inherited from XBMCAddon::AddonClass
static short	getNextClassIndex ()
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

Constructor & Destructor Documentation

WindowDialog()

XBMCAddon::xbmcgui::WindowDialog::WindowDialog

(

)

~WindowDialog()

XBMCAddon::xbmcgui::WindowDialog::~WindowDialog ( )

override

Member Function Documentation

close()

void XBMCAddon::xbmcgui::WindowDialog::close ( )

inlineoverride

IsDialog()

bool XBMCAddon::xbmcgui::WindowDialog::IsDialog ( ) const

inlineoverride

IsDialogRunning()

bool XBMCAddon::xbmcgui::WindowDialog::IsDialogRunning ( ) const

inlineoverride

IsModalDialog()

bool XBMCAddon::xbmcgui::WindowDialog::IsModalDialog ( ) const

inlineoverride

OnAction()

bool XBMCAddon::xbmcgui::WindowDialog::OnAction ( const CAction & action )

override

OnDeinitWindow()

void XBMCAddon::xbmcgui::WindowDialog::OnDeinitWindow ( int nextWindowID )

override

OnMessage()

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

override

show()

void XBMCAddon::xbmcgui::WindowDialog::show ( )

inlineoverride

---

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

• WindowDialog.h
• WindowDialog.cpp