Kodi Development  20.0
for Binary and Script based Add-Ons
CWindow

Inherits CAddonGUIControlBase.

Public Member Functions

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

Constructor & Destructor Documentation

◆ ~CWindow()

~CWindow ( )
inlineoverride

Class destructor.


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