Callback functions from Kodi to add-on

Detailed Description

GUI window callback functions.
Functions to handle control callbacks from Kodi

---

Go back to normal functions from CWindow

Function Documentation

OnInit()

virtual bool OnInit ( )

inlinevirtual

OnInit method.

Returns

Return true if initialize was done successful

OnFocus()

virtual bool OnFocus ( int controlId )

inlinevirtual

OnFocus method.

Parameters

[in]

controlId

GUI control identifier

Returns

Return true if focus condition was handled there or false to handle them by Kodi itself

OnClick()

virtual bool OnClick ( int controlId )

inlinevirtual

OnClick method.

Parameters

[in]

controlId

GUI control identifier

Returns

Return true if click was handled there or false to handle them by Kodi itself

OnAction()

virtual bool OnAction ( ADDON_ACTION actionId )

inlinevirtual

OnAction method.

Parameters

[in]

actionId

The action id to perform, see kodi_key_action_ids to get list of them

Returns

Return true if action was handled there or false to handle them by Kodi itself

This method will receive all actions that the main program will send to this window.

Note

• By default, only the ADDON_ACTION_PREVIOUS_MENU and ADDON_ACTION_NAV_BACK actions are handled.
• Overwrite this method to let your code handle all actions.
• Don't forget to capture ADDON_ACTION_PREVIOUS_MENU or ADDON_ACTION_NAV_BACK, else the user can't close this window.

---

Example:

..
// Window used with parent / child way
bool cYOUR_CLASS::OnAction(ADDON_ACTION actionId)
{
  switch (action)
  {
    case ADDON_ACTION_PREVIOUS_MENU:
    case ADDON_ACTION_NAV_BACK:
      printf("action received: previous");
      Close();
      return true;
    case ADDON_ACTION_SHOW_INFO:
      printf("action received: show info");
      break;
    case ADDON_ACTION_STOP:
      printf("action received: stop");
      break;
    case ADDON_ACTION_PAUSE:
      printf("action received: pause");
      break;
    default:
      break;
  }
  return false;
}
..

GetContextButtons()

virtual void GetContextButtons ( int itemNumber, std::vector< std::pair< unsigned int, std::string > > & buttons )

inlinevirtual

Get context menu buttons for list entry.

Parameters

[in]	itemNumber	Selected list item entry
[in]	buttons	List where context menus becomes added with his identifier and name

OnContextButton()

virtual bool OnContextButton ( int itemNumber, unsigned int button )

inlinevirtual

Called after selection in context menu.

Parameters

[in]	itemNumber	Selected list item entry
[in]	button	The pressed button id

Returns

true if handled, otherwise false

SetIndependentCallbacks()

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 )

inline

Set independent callbacks

If the class is used independent (with "new CWindow") and not as parent (with "cCLASS_own : public kodi::gui::CWindow") from own must be the callback from Kodi to add-on overdriven with own functions!

Parameters

[in]	cbhdl	The pointer to own handle data structure / class
[in]	CBOnInit	Own defined window init function
[in]	CBOnFocus	Own defined focus function
[in]	CBOnClick	Own defined click function
[in]	CBOnAction	Own defined action function
[in]	CBGetContextButtons	[opt] To get context menu entries for lists function
[in]	CBOnContextButton	[opt] Used context menu entry function

---

Example:

...
 
bool OnInit(kodi::gui::ClientHandle cbhdl)
{
  ...
  return true;
}
 
bool OnFocus(kodi::gui::ClientHandle cbhdl, int controlId)
{
  ...
  return true;
}
 
bool OnClick(kodi::gui::ClientHandle cbhdl, int controlId)
{
  ...
  return true;
}
 
bool OnAction(kodi::gui::ClientHandle cbhdl, ADDON_ACTION actionId)
{
  ...
  return true;
}
 
...
// Somewhere where you create the window
CWindow myWindow = new CWindow;
myWindow->SetIndependentCallbacks(myWindow, OnInit, OnFocus, OnClick, OnAction);
...