Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
Public Member Functions | List of all members
CHelper_libKODI_guilib Class Reference

#include <libKODI_guilib.h>

Public Member Functions

 CHelper_libKODI_guilib ()
 
 ~CHelper_libKODI_guilib ()
 
bool RegisterMe (void *handle)
 
void Lock ()
 
void Unlock ()
 
int GetScreenHeight ()
 
int GetScreenWidth ()
 
int GetVideoResolution ()
 
CAddonGUIWindow * Window_create (const char *xmlFilename, const char *defaultSkin, bool forceFallback, bool asDialog)
 
void Window_destroy (CAddonGUIWindow *p)
 
CAddonGUISpinControl * Control_getSpin (CAddonGUIWindow *window, int controlId)
 
void Control_releaseSpin (CAddonGUISpinControl *p)
 
CAddonGUIRadioButton * Control_getRadioButton (CAddonGUIWindow *window, int controlId)
 
void Control_releaseRadioButton (CAddonGUIRadioButton *p)
 
CAddonGUIProgressControl * Control_getProgress (CAddonGUIWindow *window, int controlId)
 
void Control_releaseProgress (CAddonGUIProgressControl *p)
 
CAddonListItem * ListItem_create (const char *label, const char *label2, const char *iconImage, const char *thumbnailImage, const char *path)
 
void ListItem_destroy (CAddonListItem *p)
 
CAddonGUIRenderingControl * Control_getRendering (CAddonGUIWindow *window, int controlId)
 
void Control_releaseRendering (CAddonGUIRenderingControl *p)
 
CAddonGUISliderControl * Control_getSlider (CAddonGUIWindow *window, int controlId)
 
void Control_releaseSlider (CAddonGUISliderControl *p)
 
CAddonGUISettingsSliderControl * Control_getSettingsSlider (CAddonGUIWindow *window, int controlId)
 
void Control_releaseSettingsSlider (CAddonGUISettingsSliderControl *p)
 
GUI Keyboard functions
bool Dialog_Keyboard_ShowAndGetInput (char &strText, unsigned int iMaxStringSize, const char *strHeading, bool allowEmptyResult, bool hiddenInput, unsigned int autoCloseMs=0)
 
bool Dialog_Keyboard_ShowAndGetInput (char &strText, unsigned int iMaxStringSize, bool allowEmptyResult, unsigned int autoCloseMs=0)
 
bool Dialog_Keyboard_ShowAndGetNewPassword (char &strNewPassword, unsigned int iMaxStringSize, const char *strHeading, bool allowEmptyResult, unsigned int autoCloseMs=0)
 
bool Dialog_Keyboard_ShowAndGetNewPassword (char &strNewPassword, unsigned int iMaxStringSize, unsigned int autoCloseMs=0)
 
bool Dialog_Keyboard_ShowAndVerifyNewPassword (char &strNewPassword, unsigned int iMaxStringSize, const char *strHeading, bool allowEmptyResult, unsigned int autoCloseMs=0)
 
bool Dialog_Keyboard_ShowAndVerifyNewPassword (char &strNewPassword, unsigned int iMaxStringSize, unsigned int autoCloseMs=0)
 
int Dialog_Keyboard_ShowAndVerifyPassword (char &strPassword, unsigned int iMaxStringSize, const char *strHeading, int iRetries, unsigned int autoCloseMs=0)
 
bool Dialog_Keyboard_ShowAndGetFilter (char &strText, unsigned int iMaxStringSize, bool searching, unsigned int autoCloseMs=0)
 
bool Dialog_Keyboard_SendTextToActiveKeyboard (const char *aTextString, bool closeKeyboard=false)
 
bool Dialog_Keyboard_isKeyboardActivated ()
 
GUI Numeric functions
bool Dialog_Numeric_ShowAndVerifyNewPassword (char &strNewPassword, unsigned int iMaxStringSize)
 
int Dialog_Numeric_ShowAndVerifyPassword (char &strPassword, unsigned int iMaxStringSize, const char *strHeading, int iRetries)
 
bool Dialog_Numeric_ShowAndVerifyInput (char &strPassword, unsigned int iMaxStringSize, const char *strHeading, bool bGetUserInput)
 
bool Dialog_Numeric_ShowAndGetTime (tm &time, const char *strHeading)
 
bool Dialog_Numeric_ShowAndGetDate (tm &date, const char *strHeading)
 
bool Dialog_Numeric_ShowAndGetIPAddress (char &strIPAddress, unsigned int iMaxStringSize, const char *strHeading)
 
bool Dialog_Numeric_ShowAndGetNumber (char &strInput, unsigned int iMaxStringSize, const char *strHeading, unsigned int iAutoCloseTimeoutMs=0)
 
bool Dialog_Numeric_ShowAndGetSeconds (char &strTime, unsigned int iMaxStringSize, const char *strHeading)
 
GUI File browser functions
bool Dialog_FileBrowser_ShowAndGetFile (const char *directory, const char *mask, const char *heading, char &strPath, unsigned int iMaxStringSize, bool useThumbs=false, bool useFileDirectories=false, bool singleList=false)
 
GUI OK Dialog functions
void Dialog_OK_ShowAndGetInput (const char *heading, const char *text)
 
void Dialog_OK_ShowAndGetInput (const char *heading, const char *line0, const char *line1, const char *line2)
 
GUI Yes No Dialog functions
bool Dialog_YesNo_ShowAndGetInput (const char *heading, const char *text, bool &bCanceled, const char *noLabel="", const char *yesLabel="")
 
bool Dialog_YesNo_ShowAndGetInput (const char *heading, const char *line0, const char *line1, const char *line2, const char *noLabel="", const char *yesLabel="")
 
bool Dialog_YesNo_ShowAndGetInput (const char *heading, const char *line0, const char *line1, const char *line2, bool &bCanceled, const char *noLabel="", const char *yesLabel="")
 
GUI Text viewer Dialog
void Dialog_TextViewer (const char *heading, const char *text)
 

GUI select Dialog

int Dialog_Select (const char *heading, const char *entries[], unsigned int size, int selected=-1)
 

Constructor & Destructor Documentation

◆ CHelper_libKODI_guilib()

CHelper_libKODI_guilib::CHelper_libKODI_guilib ( )
inline

◆ ~CHelper_libKODI_guilib()

CHelper_libKODI_guilib::~CHelper_libKODI_guilib ( )
inline

Member Function Documentation

◆ Control_getProgress()

CAddonGUIProgressControl * CHelper_libKODI_guilib::Control_getProgress ( CAddonGUIWindow *  window,
int  controlId 
)
inline

◆ Control_getRadioButton()

CAddonGUIRadioButton * CHelper_libKODI_guilib::Control_getRadioButton ( CAddonGUIWindow *  window,
int  controlId 
)
inline

◆ Control_getRendering()

CAddonGUIRenderingControl * CHelper_libKODI_guilib::Control_getRendering ( CAddonGUIWindow *  window,
int  controlId 
)
inline

◆ Control_getSettingsSlider()

CAddonGUISettingsSliderControl * CHelper_libKODI_guilib::Control_getSettingsSlider ( CAddonGUIWindow *  window,
int  controlId 
)
inline

◆ Control_getSlider()

CAddonGUISliderControl * CHelper_libKODI_guilib::Control_getSlider ( CAddonGUIWindow *  window,
int  controlId 
)
inline

◆ Control_getSpin()

CAddonGUISpinControl * CHelper_libKODI_guilib::Control_getSpin ( CAddonGUIWindow *  window,
int  controlId 
)
inline

◆ Control_releaseProgress()

void CHelper_libKODI_guilib::Control_releaseProgress ( CAddonGUIProgressControl *  p)
inline

◆ Control_releaseRadioButton()

void CHelper_libKODI_guilib::Control_releaseRadioButton ( CAddonGUIRadioButton *  p)
inline

◆ Control_releaseRendering()

void CHelper_libKODI_guilib::Control_releaseRendering ( CAddonGUIRenderingControl *  p)
inline

◆ Control_releaseSettingsSlider()

void CHelper_libKODI_guilib::Control_releaseSettingsSlider ( CAddonGUISettingsSliderControl *  p)
inline

◆ Control_releaseSlider()

void CHelper_libKODI_guilib::Control_releaseSlider ( CAddonGUISliderControl *  p)
inline

◆ Control_releaseSpin()

void CHelper_libKODI_guilib::Control_releaseSpin ( CAddonGUISpinControl *  p)
inline

◆ Dialog_FileBrowser_ShowAndGetFile()

bool CHelper_libKODI_guilib::Dialog_FileBrowser_ShowAndGetFile ( const char *  directory,
const char *  mask,
const char *  heading,
char &  strPath,
unsigned int  iMaxStringSize,
bool  useThumbs = false,
bool  useFileDirectories = false,
bool  singleList = false 
)
inline

◆ Dialog_Keyboard_isKeyboardActivated()

bool CHelper_libKODI_guilib::Dialog_Keyboard_isKeyboardActivated ( )
inline

◆ Dialog_Keyboard_SendTextToActiveKeyboard()

bool CHelper_libKODI_guilib::Dialog_Keyboard_SendTextToActiveKeyboard ( const char *  aTextString,
bool  closeKeyboard = false 
)
inline

◆ Dialog_Keyboard_ShowAndGetFilter()

bool CHelper_libKODI_guilib::Dialog_Keyboard_ShowAndGetFilter ( char &  strText,
unsigned int  iMaxStringSize,
bool  searching,
unsigned int  autoCloseMs = 0 
)
inline

◆ Dialog_Keyboard_ShowAndGetInput() [1/2]

bool CHelper_libKODI_guilib::Dialog_Keyboard_ShowAndGetInput ( char &  strText,
unsigned int  iMaxStringSize,
bool  allowEmptyResult,
unsigned int  autoCloseMs = 0 
)
inline

◆ Dialog_Keyboard_ShowAndGetInput() [2/2]

bool CHelper_libKODI_guilib::Dialog_Keyboard_ShowAndGetInput ( char &  strText,
unsigned int  iMaxStringSize,
const char *  strHeading,
bool  allowEmptyResult,
bool  hiddenInput,
unsigned int  autoCloseMs = 0 
)
inline

◆ Dialog_Keyboard_ShowAndGetNewPassword() [1/2]

bool CHelper_libKODI_guilib::Dialog_Keyboard_ShowAndGetNewPassword ( char &  strNewPassword,
unsigned int  iMaxStringSize,
const char *  strHeading,
bool  allowEmptyResult,
unsigned int  autoCloseMs = 0 
)
inline

◆ Dialog_Keyboard_ShowAndGetNewPassword() [2/2]

bool CHelper_libKODI_guilib::Dialog_Keyboard_ShowAndGetNewPassword ( char &  strNewPassword,
unsigned int  iMaxStringSize,
unsigned int  autoCloseMs = 0 
)
inline

◆ Dialog_Keyboard_ShowAndVerifyNewPassword() [1/2]

bool CHelper_libKODI_guilib::Dialog_Keyboard_ShowAndVerifyNewPassword ( char &  strNewPassword,
unsigned int  iMaxStringSize,
const char *  strHeading,
bool  allowEmptyResult,
unsigned int  autoCloseMs = 0 
)
inline

◆ Dialog_Keyboard_ShowAndVerifyNewPassword() [2/2]

bool CHelper_libKODI_guilib::Dialog_Keyboard_ShowAndVerifyNewPassword ( char &  strNewPassword,
unsigned int  iMaxStringSize,
unsigned int  autoCloseMs = 0 
)
inline

◆ Dialog_Keyboard_ShowAndVerifyPassword()

int CHelper_libKODI_guilib::Dialog_Keyboard_ShowAndVerifyPassword ( char &  strPassword,
unsigned int  iMaxStringSize,
const char *  strHeading,
int  iRetries,
unsigned int  autoCloseMs = 0 
)
inline

◆ Dialog_Numeric_ShowAndGetDate()

bool CHelper_libKODI_guilib::Dialog_Numeric_ShowAndGetDate ( tm &  date,
const char *  strHeading 
)
inline

◆ Dialog_Numeric_ShowAndGetIPAddress()

bool CHelper_libKODI_guilib::Dialog_Numeric_ShowAndGetIPAddress ( char &  strIPAddress,
unsigned int  iMaxStringSize,
const char *  strHeading 
)
inline

◆ Dialog_Numeric_ShowAndGetNumber()

bool CHelper_libKODI_guilib::Dialog_Numeric_ShowAndGetNumber ( char &  strInput,
unsigned int  iMaxStringSize,
const char *  strHeading,
unsigned int  iAutoCloseTimeoutMs = 0 
)
inline

◆ Dialog_Numeric_ShowAndGetSeconds()

bool CHelper_libKODI_guilib::Dialog_Numeric_ShowAndGetSeconds ( char &  strTime,
unsigned int  iMaxStringSize,
const char *  strHeading 
)
inline

◆ Dialog_Numeric_ShowAndGetTime()

bool CHelper_libKODI_guilib::Dialog_Numeric_ShowAndGetTime ( tm &  time,
const char *  strHeading 
)
inline

◆ Dialog_Numeric_ShowAndVerifyInput()

bool CHelper_libKODI_guilib::Dialog_Numeric_ShowAndVerifyInput ( char &  strPassword,
unsigned int  iMaxStringSize,
const char *  strHeading,
bool  bGetUserInput 
)
inline

◆ Dialog_Numeric_ShowAndVerifyNewPassword()

bool CHelper_libKODI_guilib::Dialog_Numeric_ShowAndVerifyNewPassword ( char &  strNewPassword,
unsigned int  iMaxStringSize 
)
inline

◆ Dialog_Numeric_ShowAndVerifyPassword()

int CHelper_libKODI_guilib::Dialog_Numeric_ShowAndVerifyPassword ( char &  strPassword,
unsigned int  iMaxStringSize,
const char *  strHeading,
int  iRetries 
)
inline

◆ Dialog_OK_ShowAndGetInput() [1/2]

void CHelper_libKODI_guilib::Dialog_OK_ShowAndGetInput ( const char *  heading,
const char *  line0,
const char *  line1,
const char *  line2 
)
inline

◆ Dialog_OK_ShowAndGetInput() [2/2]

void CHelper_libKODI_guilib::Dialog_OK_ShowAndGetInput ( const char *  heading,
const char *  text 
)
inline

◆ Dialog_Select()

int CHelper_libKODI_guilib::Dialog_Select ( const char *  heading,
const char *  entries[],
unsigned int  size,
int  selected = -1 
)
inline

◆ Dialog_TextViewer()

void CHelper_libKODI_guilib::Dialog_TextViewer ( const char *  heading,
const char *  text 
)
inline

◆ Dialog_YesNo_ShowAndGetInput() [1/3]

bool CHelper_libKODI_guilib::Dialog_YesNo_ShowAndGetInput ( const char *  heading,
const char *  line0,
const char *  line1,
const char *  line2,
bool &  bCanceled,
const char *  noLabel = "",
const char *  yesLabel = "" 
)
inline

◆ Dialog_YesNo_ShowAndGetInput() [2/3]

bool CHelper_libKODI_guilib::Dialog_YesNo_ShowAndGetInput ( const char *  heading,
const char *  line0,
const char *  line1,
const char *  line2,
const char *  noLabel = "",
const char *  yesLabel = "" 
)
inline

◆ Dialog_YesNo_ShowAndGetInput() [3/3]

bool CHelper_libKODI_guilib::Dialog_YesNo_ShowAndGetInput ( const char *  heading,
const char *  text,
bool &  bCanceled,
const char *  noLabel = "",
const char *  yesLabel = "" 
)
inline

◆ GetScreenHeight()

int CHelper_libKODI_guilib::GetScreenHeight ( )
inline

◆ GetScreenWidth()

int CHelper_libKODI_guilib::GetScreenWidth ( )
inline

◆ GetVideoResolution()

int CHelper_libKODI_guilib::GetVideoResolution ( )
inline

◆ ListItem_create()

CAddonListItem * CHelper_libKODI_guilib::ListItem_create ( const char *  label,
const char *  label2,
const char *  iconImage,
const char *  thumbnailImage,
const char *  path 
)
inline

◆ ListItem_destroy()

void CHelper_libKODI_guilib::ListItem_destroy ( CAddonListItem *  p)
inline

◆ Lock()

void CHelper_libKODI_guilib::Lock ( )
inline

◆ RegisterMe()

bool CHelper_libKODI_guilib::RegisterMe ( void *  handle)
inline

◆ Unlock()

void CHelper_libKODI_guilib::Unlock ( )
inline

◆ Window_create()

CAddonGUIWindow * CHelper_libKODI_guilib::Window_create ( const char *  xmlFilename,
const char *  defaultSkin,
bool  forceFallback,
bool  asDialog 
)
inline

◆ Window_destroy()

void CHelper_libKODI_guilib::Window_destroy ( CAddonGUIWindow *  p)
inline
The documentation for this class was generated from the following file: