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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
/*
* 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 "../../AddonBase.h"
#include "../Window.h"
namespace kodi
{
namespace gui
{
namespace controls
{
//============================================================================
///
/// \defgroup cpp_kodi_gui_controls_CEdit Control Edit
/// \ingroup cpp_kodi_gui
/// @brief \cpp_class{ kodi::gui::controls::CEdit }
/// **Editable window text control used as an input control for the osd keyboard
/// and other input fields**
///
/// The edit control allows a user to input text in Kodi. You can choose the
/// font, size, colour, location and header of the text to be displayed.
///
/// It has the header \ref Edit.h "#include <kodi/gui/controls/Edit.h>"
/// be included to enjoy it.
///
/// Here you find the needed skin part for a \ref skin_Edit_control
/// "edit control".
///
/// @note The call of the control is only possible from the corresponding
/// window as its class and identification number is required.
///
//============================================================================
// see gui/definition.h for use of group "cpp_kodi_gui_controls_CEdit_Defs"
///
/// \defgroup cpp_kodi_gui_controls_CEdit_Defs Definitions, structures and enumerators
/// \ingroup cpp_kodi_gui_controls_CEdit
/// @brief **Library definition values**
///
} /* namespace controls */
} /* namespace gui */
} /* namespace kodi */
//============================================================================
///
/// \ingroup cpp_kodi_gui_controls_CEdit_Defs
/// @{
/// @anchor AddonGUIInputType
/// @brief Text input types used on kodi::gui::controls::CEdit
enum AddonGUIInputType
{
/// Text inside edit control only readable
ADDON_INPUT_TYPE_READONLY = -1,
/// Normal text entries
ADDON_INPUT_TYPE_TEXT = 0,
/// To use on edit control only numeric numbers
ADDON_INPUT_TYPE_NUMBER,
/// To insert seconds
ADDON_INPUT_TYPE_SECONDS,
/// To insert time
ADDON_INPUT_TYPE_TIME,
/// To insert a date
ADDON_INPUT_TYPE_DATE,
/// Used for write in IP addresses
ADDON_INPUT_TYPE_IPADDRESS,
/// Text field used as password entry field with not visible text
ADDON_INPUT_TYPE_PASSWORD,
/// Text field used as password entry field with not visible text but
/// returned as MD5 value
ADDON_INPUT_TYPE_PASSWORD_MD5,
/// Use text field for search purpose
ADDON_INPUT_TYPE_SEARCH,
/// Text field as filter
ADDON_INPUT_TYPE_FILTER,
///
ADDON_INPUT_TYPE_PASSWORD_NUMBER_VERIFY_NEW
};
/// @}
//----------------------------------------------------------------------------
namespace kodi
{
namespace gui
{
namespace controls
{
class ATTRIBUTE_HIDDEN CEdit : public CAddonGUIControlBase
{
public:
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CEdit
/// @brief Construct a new control
///
/// @param[in] window related window control class
/// @param[in] controlId Used skin xml control id
///
CEdit(CWindow* window, int controlId) : CAddonGUIControlBase(window)
{
m_controlHandle = m_interface->kodi_gui->window->get_control_edit(
m_interface->kodiBase, m_Window->GetControlHandle(), controlId);
if (!m_controlHandle)
kodi::Log(ADDON_LOG_FATAL,
"kodi::gui::control::CEdit can't create control class from Kodi !!!");
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CEdit
/// @brief Destructor
///
~CEdit() override = default;
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CEdit
/// @brief Set the control on window to visible
///
/// @param[in] visible If true visible, otherwise hidden
///
void SetVisible(bool visible)
{
m_interface->kodi_gui->control_edit->set_visible(m_interface->kodiBase, m_controlHandle,
visible);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CEdit
/// @brief Set's the control's enabled/disabled state
///
/// @param[in] enabled If true enabled, otherwise disabled
///
void SetEnabled(bool enabled)
{
m_interface->kodi_gui->control_edit->set_enabled(m_interface->kodiBase, m_controlHandle,
enabled);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CEdit
/// @brief To set the text string on edit control
///
/// @param[in] label Text to show
///
void SetLabel(const std::string& label)
{
m_interface->kodi_gui->control_edit->set_label(m_interface->kodiBase, m_controlHandle,
label.c_str());
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CEdit
/// @brief Returns the text heading for this edit control.
///
/// @return Heading text
///
std::string GetLabel() const
{
std::string label;
char* ret =
m_interface->kodi_gui->control_edit->get_label(m_interface->kodiBase, m_controlHandle);
if (ret != nullptr)
{
if (std::strlen(ret))
label = ret;
m_interface->free_string(m_interface->kodiBase, ret);
}
return label;
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CEdit
/// @brief Set's text heading for this edit control.
///
/// @param[in] text string or unicode - text string.
///
void SetText(const std::string& text)
{
m_interface->kodi_gui->control_edit->set_text(m_interface->kodiBase, m_controlHandle,
text.c_str());
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CEdit
/// @brief Returns the text value for this edit control.
///
/// @return Text value of control
///
std::string GetText() const
{
std::string text;
char* ret =
m_interface->kodi_gui->control_edit->get_text(m_interface->kodiBase, m_controlHandle);
if (ret != nullptr)
{
if (std::strlen(ret))
text = ret;
m_interface->free_string(m_interface->kodiBase, ret);
}
return text;
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CEdit
/// @brief Set the cursor position on text.
///
/// @param[in] iPosition The position to set
///
void SetCursorPosition(unsigned int iPosition)
{
m_interface->kodi_gui->control_edit->set_cursor_position(m_interface->kodiBase, m_controlHandle,
iPosition);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CEdit
/// @brief To get current cursor position on text field
///
/// @return The current cursor position
///
unsigned int GetCursorPosition()
{
return m_interface->kodi_gui->control_edit->get_cursor_position(m_interface->kodiBase,
m_controlHandle);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_controls_CEdit
/// @brief To set field input type which are defined on \ref AddonGUIInputType
///
/// @param[in] type The \ref AddonGUIInputType "Add-on input type"
/// to use
/// @param[in] heading The heading text for related keyboard
/// dialog
///
void SetInputType(AddonGUIInputType type, const std::string& heading)
{
m_interface->kodi_gui->control_edit->set_input_type(m_interface->kodiBase, m_controlHandle,
static_cast<int>(type), heading.c_str());
}
//--------------------------------------------------------------------------
};
} /* namespace controls */
} /* namespace gui */
} /* namespace kodi */
|
