File: Keyboard.h

package info (click to toggle)
kodi 2%3A20.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 143,820 kB
  • sloc: cpp: 664,925; xml: 68,398; ansic: 37,223; python: 6,903; sh: 4,209; javascript: 2,325; makefile: 1,754; perl: 969; java: 513; cs: 390; objc: 340
file content (94 lines) | stat: -rw-r--r-- 4,181 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "addons/kodi-dev-kit/include/kodi/c-api/gui/dialogs/keyboard.h"

extern "C"
{

  struct AddonGlobalInterface;

  namespace ADDON
  {

  /*!
   * @brief Global gui Add-on to Kodi callback functions
   *
   * To hold functions not related to a instance type and usable for
   * every add-on type.
   *
   * Related add-on header is "./xbmc/addons/kodi-dev-kit/include/kodi/gui/dialogs/Keyboard.h"
   */
  struct Interface_GUIDialogKeyboard
  {
    static void Init(AddonGlobalInterface* addonInterface);
    static void DeInit(AddonGlobalInterface* addonInterface);

    /*!
     * @brief callback functions from add-on to kodi
     *
     * @note To add a new function use the "_" style to directly identify an
     * add-on callback function. Everything with CamelCase is only to be used
     * in Kodi.
     *
     * The parameter `kodiBase` is used to become the pointer for a `CAddonDll`
     * class.
     */
    //@{
    static bool show_and_get_input_with_head(KODI_HANDLE kodiBase,
                                             const char* text_in,
                                             char** text_out,
                                             const char* heading,
                                             bool allow_empty_result,
                                             bool hidden_input,
                                             unsigned int auto_close_ms);
    static bool show_and_get_input(KODI_HANDLE kodiBase,
                                   const char* text_in,
                                   char** text_out,
                                   bool allow_empty_result,
                                   unsigned int auto_close_ms);
    static bool show_and_get_new_password_with_head(KODI_HANDLE kodiBase,
                                                    const char* password_in,
                                                    char** password_out,
                                                    const char* heading,
                                                    bool allow_empty_result,
                                                    unsigned int auto_close_ms);
    static bool show_and_get_new_password(KODI_HANDLE kodiBase,
                                          const char* password_in,
                                          char** password_out,
                                          unsigned int auto_close_ms);
    static bool show_and_verify_new_password_with_head(KODI_HANDLE kodiBase,
                                                       char** password_out,
                                                       const char* heading,
                                                       bool allowEmpty,
                                                       unsigned int auto_close_ms);
    static bool show_and_verify_new_password(KODI_HANDLE kodiBase,
                                             char** password_out,
                                             unsigned int auto_close_ms);
    static int show_and_verify_password(KODI_HANDLE kodiBase,
                                        const char* password_in,
                                        char** password_out,
                                        const char* heading,
                                        int retries,
                                        unsigned int auto_close_ms);
    static bool show_and_get_filter(KODI_HANDLE kodiBase,
                                    const char* text_in,
                                    char** text_out,
                                    bool searching,
                                    unsigned int auto_close_ms);
    static bool send_text_to_active_keyboard(KODI_HANDLE kodiBase,
                                             const char* text,
                                             bool close_keyboard);
    static bool is_keyboard_activated(KODI_HANDLE kodiBase);
    //@}
  };

  } /* namespace ADDON */
} /* extern "C" */