Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
CAddonGUIWindow Class Reference

#include <libKODI_guilib.h>

Inheritance diagram for CAddonGUIWindow:
CAddonGUIControlBase

Public Member Functions

 CAddonGUIWindow (AddonCB *hdl, KodiAPI::GUI::CB_GUILib *cb, const char *xmlFilename, const char *defaultSkin, bool forceFallback, bool asDialog)
 
 ~CAddonGUIWindow () override
 
bool Show ()
 
void Close ()
 
void DoModal ()
 
bool SetFocusId (int iControlId)
 
int GetFocusId ()
 
bool SetCoordinateResolution (int res)
 
void SetProperty (const char *key, const char *value)
 
void SetPropertyInt (const char *key, int value)
 
void SetPropertyBool (const char *key, bool value)
 
void SetPropertyDouble (const char *key, double value)
 
const char * GetProperty (const char *key) const
 
int GetPropertyInt (const char *key) const
 
bool GetPropertyBool (const char *key) const
 
double GetPropertyDouble (const char *key) const
 
void ClearProperties ()
 
int GetListSize ()
 
void ClearList ()
 
GUIHANDLE AddStringItem (const char *name, int itemPosition=-1)
 
void AddItem (GUIHANDLE item, int itemPosition=-1)
 
void AddItem (CAddonListItem *item, int itemPosition=-1)
 
void RemoveItem (int itemPosition)
 
GUIHANDLE GetListItem (int listPos)
 
void SetCurrentListPosition (int listPos)
 
int GetCurrentListPosition ()
 
void SetControlLabel (int controlId, const char *label)
 
void MarkDirtyRegion ()
 
bool OnClick (int controlId)
 
bool OnFocus (int controlId)
 
bool OnInit ()
 
bool OnAction (int actionId)
 
- Public Member Functions inherited from CAddonGUIControlBase
GUIHANDLE GetControlHandle () const
 

Public Attributes

GUIHANDLE m_cbhdl
 
bool(* CBOnInit )(GUIHANDLE cbhdl)
 
bool(* CBOnFocus )(GUIHANDLE cbhdl, int controlId)
 
bool(* CBOnClick )(GUIHANDLE cbhdl, int controlId)
 
bool(* CBOnAction )(GUIHANDLE cbhdl, int actionId)
 

Static Protected Member Functions

static bool OnInitCB (GUIHANDLE cbhdl)
 
static bool OnFocusCB (GUIHANDLE cbhdl, int controlId)
 
static bool OnClickCB (GUIHANDLE cbhdl, int controlId)
 
static bool OnActionCB (GUIHANDLE cbhdl, int actionId)
 

Additional Inherited Members

- Protected Member Functions inherited from CAddonGUIControlBase
 CAddonGUIControlBase (AddonCB *hdl, KodiAPI::GUI::CB_GUILib *cb, CAddonGUIControlBase *window)
 
virtual ~CAddonGUIControlBase ()=default
 
- Protected Attributes inherited from CAddonGUIControlBase
GUIHANDLE m_controlHandle
 
AddonCBm_Handle
 
KodiAPI::GUI::CB_GUILibm_cb
 
CAddonGUIControlBasem_Window
 

Constructor & Destructor Documentation

◆ CAddonGUIWindow()

CAddonGUIWindow::CAddonGUIWindow ( AddonCB hdl,
KodiAPI::GUI::CB_GUILib cb,
const char *  xmlFilename,
const char *  defaultSkin,
bool  forceFallback,
bool  asDialog 
)
inline

◆ ~CAddonGUIWindow()

CAddonGUIWindow::~CAddonGUIWindow ( )
inlineoverride

Member Function Documentation

◆ AddItem() [1/2]

void CAddonGUIWindow::AddItem ( CAddonListItem item,
int  itemPosition = -1 
)
inline

◆ AddItem() [2/2]

void CAddonGUIWindow::AddItem ( GUIHANDLE  item,
int  itemPosition = -1 
)
inline

◆ AddStringItem()

GUIHANDLE CAddonGUIWindow::AddStringItem ( const char *  name,
int  itemPosition = -1 
)
inline

◆ ClearList()

void CAddonGUIWindow::ClearList ( )
inline

◆ ClearProperties()

void CAddonGUIWindow::ClearProperties ( )
inline

◆ Close()

void CAddonGUIWindow::Close ( )
inline

◆ DoModal()

void CAddonGUIWindow::DoModal ( )
inline

◆ GetCurrentListPosition()

int CAddonGUIWindow::GetCurrentListPosition ( )
inline

◆ GetFocusId()

int CAddonGUIWindow::GetFocusId ( )
inline

◆ GetListItem()

GUIHANDLE CAddonGUIWindow::GetListItem ( int  listPos)
inline

◆ GetListSize()

int CAddonGUIWindow::GetListSize ( )
inline

◆ GetProperty()

const char * CAddonGUIWindow::GetProperty ( const char *  key) const
inline

◆ GetPropertyBool()

bool CAddonGUIWindow::GetPropertyBool ( const char *  key) const
inline

◆ GetPropertyDouble()

double CAddonGUIWindow::GetPropertyDouble ( const char *  key) const
inline

◆ GetPropertyInt()

int CAddonGUIWindow::GetPropertyInt ( const char *  key) const
inline

◆ MarkDirtyRegion()

void CAddonGUIWindow::MarkDirtyRegion ( )
inline

◆ OnAction()

bool CAddonGUIWindow::OnAction ( int  actionId)
inline

◆ OnActionCB()

bool CAddonGUIWindow::OnActionCB ( GUIHANDLE  cbhdl,
int  actionId 
)
inlinestaticprotected

◆ OnClick()

bool CAddonGUIWindow::OnClick ( int  controlId)
inline

◆ OnClickCB()

bool CAddonGUIWindow::OnClickCB ( GUIHANDLE  cbhdl,
int  controlId 
)
inlinestaticprotected

◆ OnFocus()

bool CAddonGUIWindow::OnFocus ( int  controlId)
inline

◆ OnFocusCB()

bool CAddonGUIWindow::OnFocusCB ( GUIHANDLE  cbhdl,
int  controlId 
)
inlinestaticprotected

◆ OnInit()

bool CAddonGUIWindow::OnInit ( )
inline

◆ OnInitCB()

bool CAddonGUIWindow::OnInitCB ( GUIHANDLE  cbhdl)
inlinestaticprotected

◆ RemoveItem()

void CAddonGUIWindow::RemoveItem ( int  itemPosition)
inline

◆ SetControlLabel()

void CAddonGUIWindow::SetControlLabel ( int  controlId,
const char *  label 
)
inline

◆ SetCoordinateResolution()

bool CAddonGUIWindow::SetCoordinateResolution ( int  res)
inline

◆ SetCurrentListPosition()

void CAddonGUIWindow::SetCurrentListPosition ( int  listPos)
inline

◆ SetFocusId()

bool CAddonGUIWindow::SetFocusId ( int  iControlId)
inline

◆ SetProperty()

void CAddonGUIWindow::SetProperty ( const char *  key,
const char *  value 
)
inline

◆ SetPropertyBool()

void CAddonGUIWindow::SetPropertyBool ( const char *  key,
bool  value 
)
inline

◆ SetPropertyDouble()

void CAddonGUIWindow::SetPropertyDouble ( const char *  key,
double  value 
)
inline

◆ SetPropertyInt()

void CAddonGUIWindow::SetPropertyInt ( const char *  key,
int  value 
)
inline

◆ Show()

bool CAddonGUIWindow::Show ( )
inline

Member Data Documentation

◆ CBOnAction

bool(* CAddonGUIWindow::CBOnAction) (GUIHANDLE cbhdl, int actionId)

◆ CBOnClick

bool(* CAddonGUIWindow::CBOnClick) (GUIHANDLE cbhdl, int controlId)

◆ CBOnFocus

bool(* CAddonGUIWindow::CBOnFocus) (GUIHANDLE cbhdl, int controlId)

◆ CBOnInit

bool(* CAddonGUIWindow::CBOnInit) (GUIHANDLE cbhdl)

◆ m_cbhdl

GUIHANDLE CAddonGUIWindow::m_cbhdl

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