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
|
/*
* 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 "../definitions.h"
#include "../../AddonBase.h"
//==============================================================================
/// \defgroup cpp_kodi_vfs_Defs Definitions, structures and enumerators
/// \ingroup cpp_kodi_gui_dialogs_Select
/// @brief **Dialog Select definition values**
//------------------------------------------------------------------------------
//==============================================================================
/// \ingroup cpp_kodi_vfs_Defs
/// @brief **Selection entry structure**
///
typedef struct SSelectionEntry
{
//============================================================================
/// Structure constructor
///
/// There becomes selected always set to false.
///
SSelectionEntry() = default;
//----------------------------------------------------------------------------
/// Entry identfication string
std::string id;
/// Entry name to show on GUI dialog
std::string name;
/// Place where entry can be preselected and after return the from user
/// selected is set.
bool selected = false;
} SSelectionEntry;
//------------------------------------------------------------------------------
namespace kodi
{
namespace gui
{
namespace dialogs
{
//============================================================================
///
/// \defgroup cpp_kodi_gui_dialogs_Select Dialog Select
/// \ingroup cpp_kodi_gui
/// @{
/// @brief \cpp_namespace{ kodi::gui::dialogs::Select }
/// **Selection dialog**
///
/// The function listed below permits the call of a dialogue to select of an
/// entry as a key
///
/// It has the header \ref Select.h "#include <kodi/gui/dialogs/Select.h>"
/// be included to enjoy it.
///
///
namespace Select
{
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_Select
/// @brief Show a selection dialog about given parts.
///
/// @param[in] heading Dialog heading name
/// @param[in] entries String list about entries
/// @param[in] selected [opt] Predefined selection (default is
/// <tt>-1</tt> for the first)
/// @param[in] autoclose [opt] To close dialog automatic after the given
/// time in ms. As '0' it stays open.
/// @return The selected entry, if return <tt>-1</tt> was
/// nothing selected or canceled
///
///
///-------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.cpp}
/// #include <kodi/gui/dialogs/Select.h>
///
/// const std::vector<std::string> entries
/// {
/// "Test 1",
/// "Test 2",
/// "Test 3",
/// "Test 4",
/// "Test 5"
/// };
///
/// int selected = kodi::gui::dialogs::Select::Show("Test selection", entries, -1);
/// if (selected < 0)
/// fprintf(stderr, "Item selection canceled\n");
/// else
/// fprintf(stderr, "Selected item is: %i\n", selected);
/// ~~~~~~~~~~~~~
///
inline int Show(const std::string& heading, const std::vector<std::string>& entries, int selected = -1, unsigned int autoclose = 0)
{
using namespace ::kodi::addon;
unsigned int size = entries.size();
const char** cEntries = (const char**)malloc(size*sizeof(const char**));
for (unsigned int i = 0; i < size; ++i)
{
cEntries[i] = entries[i].c_str();
}
int ret = CAddonBase::m_interface->toKodi->kodi_gui->dialogSelect->open(CAddonBase::m_interface->toKodi->kodiBase, heading.c_str(), cEntries, size, selected, autoclose);
free(cEntries);
return ret;
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_Select
/// @brief Show a selection dialog about given parts.
///
/// This function is mostly equal to the other, only becomes the string list
/// here done by a SSelectionEntry, where a ID string can be defined.
///
/// @param[in] heading Dialog heading name
/// @param[in] entries SSelectionEntry list about entries
/// @param[in] selected [opt] Predefined selection (default is
/// <tt>-1</tt> for the first)
/// @param[in] autoclose [opt] To close dialog automatic after the given
/// time in ms. As '0' it stays open.
/// @return The selected entry, if return <tt>-1</tt> was
/// nothing selected or canceled
///
///
///-------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.cpp}
/// #include <kodi/gui/dialogs/Select.h>
///
/// std::vector<SSelectionEntry> entries
/// {
/// { "ID 1", "Test 1", false },
/// { "ID 2", "Test 2", false },
/// { "ID 3", "Test 3", false },
/// { "ID 4", "Test 4", false },
/// { "ID 5", "Test 5", false }
/// };
///
/// int selected = kodi::gui::dialogs::Select::Show("Test selection", entries, -1);
/// if (selected < 0)
/// fprintf(stderr, "Item selection canceled\n");
/// else
/// fprintf(stderr, "Selected item is: %i\n", selected);
/// ~~~~~~~~~~~~~
///
inline int Show(const std::string& heading, std::vector<SSelectionEntry>& entries, int selected = -1, unsigned int autoclose = 0)
{
using namespace ::kodi::addon;
unsigned int size = entries.size();
const char** cEntries = static_cast<const char**>(malloc(size*sizeof(const char*)));
for (unsigned int i = 0; i < size; ++i)
{
cEntries[i] = entries[i].name.c_str();
if (selected == -1 && entries[i].selected)
selected = i;
}
int ret = CAddonBase::m_interface->toKodi->kodi_gui->dialogSelect->open(CAddonBase::m_interface->toKodi->kodiBase, heading.c_str(),
cEntries, size, selected, autoclose);
if (ret >= 0)
{
entries[ret].selected = true;
}
free(cEntries);
return ret;
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_Select
/// @brief Show a multiple selection dialog about given parts.
///
/// @param[in] heading Dialog heading name
/// @param[in] entries SSelectionEntry list about entries
/// @param[in] autoclose [opt] To close dialog automatic after the given
/// time in ms. As '0' it stays open.
/// @return The selected entries, if return <tt>empty</tt> was
/// nothing selected or canceled
///
/// With selected on SSelectionEntry can be a pre selection defined.
///
///-------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.cpp}
/// #include <kodi/gui/dialogs/Select.h>
///
/// std::vector<SSelectionEntry> entries
/// {
/// { "ID 1", "Test 1", false },
/// { "ID 2", "Test 2", false },
/// { "ID 3", "Test 3", false },
/// { "ID 4", "Test 4", false },
/// { "ID 5", "Test 5", false }
/// };
///
/// bool ret = kodi::gui::dialogs::Select::ShowMultiSelect("Test selection", entries);
/// if (!ret)
/// fprintf(stderr, "Selection canceled\n");
/// else
/// {
/// fprintf(stderr, "Selected items:\n");
/// for (const auto& entry : entries)
/// {
/// if (entry.selected)
/// fprintf(stderr, " - %s\n", entry.selected.id.c_str());
/// }
/// }
/// ~~~~~~~~~~~~~
///
inline bool ShowMultiSelect(const std::string& heading, std::vector<SSelectionEntry>& entries, int autoclose = 0)
{
using namespace ::kodi::addon;
unsigned int size = entries.size();
const char** cEntryIDs = static_cast<const char**>(malloc(size*sizeof(const char*)));
const char** cEntryNames = static_cast<const char**>(malloc(size*sizeof(const char*)));
bool* cEntriesSelected = static_cast<bool*>(malloc(size*sizeof(bool)));
for (unsigned int i = 0; i < size; ++i)
{
cEntryIDs[i] = entries[i].id.c_str();
cEntryNames[i] = entries[i].name.c_str();
cEntriesSelected[i] = entries[i].selected;
}
bool ret = CAddonBase::m_interface->toKodi->kodi_gui->dialogSelect->open_multi_select(CAddonBase::m_interface->toKodi->kodiBase,
heading.c_str(), cEntryIDs, cEntryNames,
cEntriesSelected, size, autoclose);
if (ret)
{
for (unsigned int i = 0; i < size; ++i)
entries[i].selected = cEntriesSelected[i];
}
free(cEntryNames);
free(cEntryIDs);
free(cEntriesSelected);
return ret;
}
//--------------------------------------------------------------------------
};
/// @}
} /* namespace dialogs */
} /* namespace gui */
} /* namespace kodi */
|
