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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/*
* Copyright (C) 2005-2013 Team XBMC
* http://xbmc.org
*
* This Program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This Program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with XBMC; see the file COPYING. If not, see
* <http://www.gnu.org/licenses/>.
*
*/
#pragma once
#include "AddonClass.h"
#include "Exception.h"
#include "AddonString.h"
class CGUIDialogKeyboardGeneric;
namespace XBMCAddon
{
namespace xbmc
{
XBMCCOMMONS_STANDARD_EXCEPTION(KeyboardException);
///
/// \defgroup python_keyboard Keyboard
/// \ingroup python_xbmc
/// @{
/// @brief **Kodi's keyboard class.**
///
/// \python_class{ xbmc.Keyboard([default, heading, hidden]) }
///
/// Creates a new Keyboard object with default text
/// heading and hidden input flag if supplied.
///
/// @param default : [opt] string - default text entry.
/// @param heading : [opt] string - keyboard heading.
/// @param hidden : [opt] boolean - True for hidden text entry.
///
///
///-------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// kb = xbmc.Keyboard('default', 'heading', True)
/// kb.setDefault('password') # optional
/// kb.setHeading('Enter password') # optional
/// kb.setHiddenInput(True) # optional
/// kb.doModal()
/// if (kb.isConfirmed()):
/// text = kb.getText()
/// ..
/// ~~~~~~~~~~~~~
///
class Keyboard : public AddonClass
{
public:
#ifndef SWIG
String strDefault;
String strHeading;
bool bHidden;
String strText;
bool bConfirmed;
#endif
Keyboard(const String& line = emptyString, const String& heading = emptyString, bool hidden = false);
virtual ~Keyboard();
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_keyboard
/// @brief \python_func{ doModal([autoclose]) }
///-----------------------------------------------------------------------
/// Show keyboard and wait for user action.
///
/// @param autoclose [opt] integer - milliseconds to autoclose
/// dialog. (default=do not autoclose)
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// kb.doModal(30000)
/// ..
/// ~~~~~~~~~~~~~
///
doModal(...);
#else
void doModal(int autoclose = 0);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
// setDefault() Method
///
/// \ingroup python_keyboard
/// @brief \python_func{ setDefault(line) }
///-----------------------------------------------------------------------
/// Set the default text entry.
///
/// @param line string - default text entry.
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// kb.setDefault('password')
/// ..
/// ~~~~~~~~~~~~~
///
setDefault(...);
#else
void setDefault(const String& line = emptyString);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_keyboard
/// @brief \python_func{ setHiddenInput(hidden) }
///-----------------------------------------------------------------------
/// Allows hidden text entry.
///
/// @param hidden boolean - True for hidden text entry.
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// kb.setHiddenInput(True)
/// ..
/// ~~~~~~~~~~~~~
///
setHiddenInput(...);
#else
void setHiddenInput(bool hidden = false);
#endif
// setHeading() Method
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_keyboard
/// @brief \python_func{ setHeading(heading) }
///-----------------------------------------------------------------------
/// Set the keyboard heading.
///
/// @param heading string - keyboard heading.
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// kb.setHeading('Enter password')
/// ..
/// ~~~~~~~~~~~~~
///
setHeading(...);
#else
void setHeading(const String& heading);
#endif
// getText() Method
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_keyboard
/// @brief \python_func{ getText() }
///-----------------------------------------------------------------------
/// Returns the user input as a string.
///
/// @note This will always return the text entry even if you cancel the keyboard.
/// Use the isConfirmed() method to check if user cancelled the keyboard.
///
/// @return get the in keyboard entered text
///
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// text = kb.getText()
/// ..
/// ~~~~~~~~~~~~~
///
getText();
#else
String getText();
#endif
// isConfirmed() Method
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_keyboard
/// @brief \python_func{ isConfirmed() }
///-----------------------------------------------------------------------
/// Returns False if the user cancelled the input.
///
/// @return true if confirmed, if cancelled false
///
///-----------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// if (kb.isConfirmed()):
/// ..
/// ~~~~~~~~~~~~~
///
isConfirmed();
#else
bool isConfirmed();
#endif
};
//@}
}
}
|
