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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
|
#pragma once
/*
* Copyright (C) 2005-2017 Team KODI
* http://kodi.tv
*
* 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 KODI; see the file COPYING. If not, see
* <http://www.gnu.org/licenses/>.
*
*/
#include "definitions.h"
#include "../AddonBase.h"
namespace kodi
{
namespace gui
{
//============================================================================
///
/// \defgroup cpp_kodi_gui_DialogFileBrowser Dialog File Browser
/// \ingroup cpp_kodi_gui
/// @brief \cpp_namespace{ kodi::gui::DialogFileBrowser }
/// **File browser dialog**
///
/// The functions listed below of the class "DialogFileBrowser" offer
/// the possibility to select to a file by the user of the add-on.
///
/// It allows all the options that are possible in Kodi itself and offers all
/// support file types.
///
/// It has the header \ref DialogFileBrowser.h "#include <kodi/gui/DialogFileBrowser.h>"
/// be included to enjoy it.
///
namespace DialogFileBrowser
{
//==========================================================================
///
/// \ingroup cpp_kodi_gui_DialogFileBrowser
/// @brief Directory selection dialog
///
/// @param[in] shares With Shares becomes the available start folders
/// be set.
/// @param[in] heading Dialog header name
/// @param[in,out] path As in the path to start and return value about
/// selected directory
/// @param[in] writeOnly If set only writeable folders are shown.
/// @return False if selection becomes canceled.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.cpp}
/// #include <kodi/gui/DialogFileBrowser.h>
///
/// /*
/// * Example show directory selection dialog with on 'share' (first value)
/// * defined directory types.
/// *
/// * If this becomes leaved empty and 'directory' is empty goes it to the
/// * base path of the hard disk.
/// *
/// * Also can be with path written to 'directory' before the dialog forced
/// * to a start place.
/// */
/// std::string directory;
/// bool ret = kodi::gui::DialogFileBrowser::ShowAndGetDirectory("local|network|removable",
/// "Test directory selection",
/// directory,
/// false);
/// fprintf(stderr, "Selected directory is : %s and was %s\n", directory.c_str(), ret ? "OK" : "Canceled");
/// ~~~~~~~~~~~~~
///
inline bool ShowAndGetDirectory(const std::string& shares, const std::string& heading, std::string& path, bool writeOnly = false)
{
using namespace ::kodi::addon;
char* retString = nullptr;
bool ret = CAddonBase::m_interface->toKodi->kodi_gui->dialogFileBrowser->show_and_get_directory(CAddonBase::m_interface->toKodi->kodiBase,
shares.c_str(), heading.c_str(), path.c_str(), &retString, writeOnly);
if (retString != nullptr)
{
if (std::strlen(retString))
path = retString;
CAddonBase::m_interface->toKodi->free_string(CAddonBase::m_interface->toKodi->kodiBase, retString);
}
return ret;
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_DialogFileBrowser
/// @brief File selection dialog
///
/// @param[in] shares With Shares becomes the available start
/// folders be set.
/// @param[in] mask The mask to filter visible files, e.g.
/// ".m3u|.pls|.b4s|.wpl".
/// @param[in] heading Dialog header name
/// @param[in,out] path As in the path to start and Return value
/// about selected file
/// @param[in] useThumbs If set show thumbs if possible on dialog.
/// @param[in] useFileDirectories If set also packages (e.g. *.zip) are
/// handled as directories.
/// @return False if selection becomes canceled.
///
inline bool ShowAndGetFile(const std::string& shares, const std::string& mask, const std::string& heading,
std::string& path, bool useThumbs = false, bool useFileDirectories = false)
{
using namespace ::kodi::addon;
char* retString = nullptr;
bool ret = CAddonBase::m_interface->toKodi->kodi_gui->dialogFileBrowser->show_and_get_file(CAddonBase::m_interface->toKodi->kodiBase,
shares.c_str(), mask.c_str(), heading.c_str(), path.c_str(), &retString,
useThumbs, useFileDirectories);
if (retString != nullptr)
{
if (std::strlen(retString))
path = retString;
CAddonBase::m_interface->toKodi->free_string(CAddonBase::m_interface->toKodi->kodiBase, retString);
}
return ret;
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_DialogFileBrowser
/// @brief File selection from a directory
///
/// @param[in] directory The directory name where the dialog
/// start, possible are normal names and
/// kodi's special names.
/// @param[in] mask The mask to filter visible files, e.g.
/// ".m3u|.pls|.b4s|.wpl".
/// @param[in] heading Dialog header name
/// @param[in,out] path As in the path to start and Return value
/// about selected file
/// @param[in] useThumbs If set show thumbs if possible on dialog.
/// @param[in] useFileDirectories If set also packages (e.g. *.zip) are
/// handled as directories.
/// @param[in] singleList
/// @return False if selection becomes canceled.
///
inline bool ShowAndGetFileFromDir(const std::string& directory, const std::string& mask, const std::string& heading, std::string& path,
bool useThumbs = false, bool useFileDirectories = false, bool singleList = false)
{
using namespace ::kodi::addon;
char* retString = nullptr;
bool ret = CAddonBase::m_interface->toKodi->kodi_gui->dialogFileBrowser->show_and_get_file_from_dir(CAddonBase::m_interface->toKodi->kodiBase,
directory.c_str(), mask.c_str(), heading.c_str(),
path.c_str(), &retString, useThumbs,
useFileDirectories, singleList);
if (retString != nullptr)
{
if (std::strlen(retString))
path = retString;
CAddonBase::m_interface->toKodi->free_string(CAddonBase::m_interface->toKodi->kodiBase, retString);
}
return ret;
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_DialogFileBrowser
/// @brief File selection dialog to get several in to a list
///
/// @param[in] shares With Shares becomes the available start
/// folders be set.
/// @param[in] mask The mask to filter visible files, e.g.
/// ".m3u|.pls|.b4s|.wpl".
/// @param[in] heading Dialog header name
/// @param[out] fileList Return value about selected files
/// @param[in] useThumbs If set show thumbs if possible on dialog.
/// @param[in] useFileDirectories If set also packages (e.g. *.zip) are
/// handled as directories.
/// @return False if selection becomes canceled.
///
inline bool ShowAndGetFileList(const std::string& shares, const std::string& mask, const std::string& heading,
std::vector<std::string>& fileList, bool useThumbs = false, bool useFileDirectories = false)
{
using namespace ::kodi::addon;
char** list = nullptr;
unsigned int listSize = 0;
bool ret = CAddonBase::m_interface->toKodi->kodi_gui->dialogFileBrowser->show_and_get_file_list(CAddonBase::m_interface->toKodi->kodiBase,
shares.c_str(), mask.c_str(), heading.c_str(), &list, &listSize,
useThumbs, useFileDirectories);
if (ret)
{
for (unsigned int i = 0; i < listSize; ++i)
fileList.push_back(list[i]);
CAddonBase::m_interface->toKodi->kodi_gui->dialogFileBrowser->clear_file_list(CAddonBase::m_interface->toKodi->kodiBase, &list, listSize);
}
return ret;
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_DialogFileBrowser
/// @brief Source selection dialog
///
/// @param[in,out] path As in the path to start and Return value
/// about selected source
/// @param[in] allowNetworkShares Allow also access to network
/// @param[in] additionalShare With additionalShare becomes the available
/// start folders be set (optional).
/// @param[in] type
/// @return False if selection becomes canceled.
///
inline bool ShowAndGetSource(std::string& path, bool allowNetworkShares, const std::string& additionalShare = "", const std::string& type = "")
{
using namespace ::kodi::addon;
char* retString = nullptr;
bool ret = CAddonBase::m_interface->toKodi->kodi_gui->dialogFileBrowser->show_and_get_source(CAddonBase::m_interface->toKodi->kodiBase, path.c_str(), &retString,
allowNetworkShares, additionalShare.c_str(), type.c_str());
if (retString != nullptr)
{
if (std::strlen(retString))
path = retString;
CAddonBase::m_interface->toKodi->free_string(CAddonBase::m_interface->toKodi->kodiBase, retString);
}
return ret;
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_DialogFileBrowser
/// @brief Image selection dialog
///
/// @param[in] shares With Shares becomes the available start folders be
/// set.
/// @param[in] heading Dialog header name
/// @param[out] path Return value about selected image
/// @return False if selection becomes canceled.
///
inline bool ShowAndGetImage(const std::string& shares, const std::string& heading, std::string& path)
{
using namespace ::kodi::addon;
char* retString = nullptr;
bool ret = CAddonBase::m_interface->toKodi->kodi_gui->dialogFileBrowser->show_and_get_image(CAddonBase::m_interface->toKodi->kodiBase,
shares.c_str(), heading.c_str(), path.c_str(), &retString);
if (retString != nullptr)
{
if (std::strlen(retString))
path = retString;
CAddonBase::m_interface->toKodi->free_string(CAddonBase::m_interface->toKodi->kodiBase, retString);
}
return ret;
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_DialogFileBrowser
/// @brief Image selection dialog to get several in to a list
///
/// @param[in] shares With Shares becomes the available start folders
/// be set.
/// @param[in] heading Dialog header name
/// @param[out] file_list Return value about selected images
/// @return False if selection becomes canceled.
///
inline bool ShowAndGetImageList(const std::string& shares, const std::string& heading, std::vector<std::string>& file_list)
{
using namespace ::kodi::addon;
char** list = nullptr;
unsigned int listSize = 0;
bool ret = CAddonBase::m_interface->toKodi->kodi_gui->dialogFileBrowser->show_and_get_image_list(CAddonBase::m_interface->toKodi->kodiBase,
shares.c_str(), heading.c_str(), &list, &listSize);
if (ret)
{
for (unsigned int i = 0; i < listSize; ++i)
file_list.push_back(list[i]);
CAddonBase::m_interface->toKodi->kodi_gui->dialogFileBrowser->clear_file_list(CAddonBase::m_interface->toKodi->kodiBase, &list, listSize);
}
return ret;
}
//--------------------------------------------------------------------------
};
} /* namespace gui */
} /* namespace kodi */
|
