CWindow

Inherits CAddonGUIControlBase.

Public Member Functions
void	ClearProperties ()
	Remove all present properties from window.
void	ClearProperty (const std::string &key)
	Clears the specific window property.
void	Close ()
	Closes this window.
	CWindow (const std::string &xmlFilename, const std::string &defaultSkin, bool asDialog, bool isMedia=false)
	Class constructor with needed values for window / dialog.
void	DoModal ()
	Display this window until close() is called.
virtual void	GetContextButtons (int itemNumber, std::vector< std::pair< unsigned int, std::string > > &buttons)
	Get context menu buttons for list entry.
int	GetFocusId ()
	Returns the id of the control which is focused.
std::string	GetProperty (const std::string &key) const
	Returns a window property as a string, similar to an infolabel.
bool	GetPropertyBool (const std::string &key) const
	Returns a window property with boolean value.
double	GetPropertyDouble (const std::string &key) const
	Returns a window property with double value.
int	GetPropertyInt (const std::string &key) const
	Returns a window property with integer value.
void	MarkDirtyRegion ()
	To inform Kodi that it need to render region new.
virtual bool	OnAction (ADDON_ACTION actionId)
	OnAction method.
virtual bool	OnClick (int controlId)
	OnClick method.
virtual bool	OnContextButton (int itemNumber, unsigned int button)
	Called after selection in context menu.
virtual bool	OnFocus (int controlId)
	OnFocus method.
virtual bool	OnInit ()
	OnInit method.
void	SetControlLabel (int controlId, const std::string &label)
	To set the used label on given control id.
void	SetControlSelected (int controlId, bool selected)
	To set the selection on given control id.
void	SetControlVisible (int controlId, bool visible)
	To set the visibility on given control id.
bool	SetFocusId (int controlId)
	Gives the control with the supplied focus.
void	SetIndependentCallbacks (kodi::gui::ClientHandle cbhdl, bool(*CBOnInit)(kodi::gui::ClientHandle cbhdl), bool(*CBOnFocus)(kodi::gui::ClientHandle cbhdl, int controlId), bool(*CBOnClick)(kodi::gui::ClientHandle cbhdl, int controlId), bool(*CBOnAction)(kodi::gui::ClientHandle cbhdl, ADDON_ACTION actionId), void(*CBGetContextButtons)(kodi::gui::ClientHandle cbhdl, int itemNumber, gui_context_menu_pair *buttons, unsigned int *size)=nullptr, bool(*CBOnContextButton)(kodi::gui::ClientHandle cbhdl, int itemNumber, unsigned int button)=nullptr)
	Set independent callbacks
void	SetProperty (const std::string &key, const std::string &value)
	Sets a window property, similar to an infolabel.
void	SetPropertyBool (const std::string &key, bool value)
	Sets a window property with boolean value.
void	SetPropertyDouble (const std::string &key, double value)
	Sets a window property with double value.
void	SetPropertyInt (const std::string &key, int value)
	Sets a window property with integer value.
bool	Show ()
	Show this window.
	~CWindow () override
	Class destructor.
void	ClearList ()
	Function delete all entries in integrated list.
void	AddListItem (const std::shared_ptr< CListItem > &item, int itemPosition=-1)
	To add a list item in the on window integrated list.
void	AddListItem (const std::string &item, int itemPosition=-1)
	To add a list item based upon string in the on window integrated list.
void	RemoveListItem (int itemPosition)
	Remove list item on position.
void	RemoveListItem (const std::shared_ptr< CListItem > &item)
	Remove item with given control class from list.
std::shared_ptr< CListItem >	GetListItem (int listPos)
	To get list item control class on wanted position.
void	SetCurrentListPosition (int listPos)
	To set position of selected part in list.
int	GetCurrentListPosition ()
	To get current selected position in list.
int	GetListSize ()
	To get the amount of entries in the list.
void	SetContainerProperty (const std::string &key, const std::string &value)
	Sets a container property, similar to an infolabel.
void	SetContainerContent (const std::string &value)
	Sets the content type of the container.
int	GetCurrentContainerId ()
	Get the id of the currently visible container.
Public Member Functions inherited from CAddonGUIControlBase
KODI_GUI_LISTITEM_HANDLE	GetControlHandle () const

Additional Inherited Members
Protected Member Functions inherited from CAddonGUIControlBase
	CAddonGUIControlBase (CAddonGUIControlBase *window)
Protected Attributes inherited from CAddonGUIControlBase
KODI_GUI_LISTITEM_HANDLE	m_controlHandle
AddonToKodiFuncTable_Addon *	m_interface
CAddonGUIControlBase *	m_Window

Constructor & Destructor Documentation

~CWindow()

~CWindow ( )

inlineoverride

Class destructor.

---

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

• /github/workspace/xbmc/addons/kodi-dev-kit/include/kodi/gui/Window.h