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
|
#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
{
namespace dialogs
{
//============================================================================
///
/// \defgroup cpp_kodi_gui_dialogs_CProgress Dialog Progress
/// \ingroup cpp_kodi_gui
/// @brief \cpp_class{ kodi::gui::dialogs::CProgress }
/// **Progress dialog shown in center**
///
/// The with \ref DialogProgress.h "#include <kodi/gui/dialogs/Progress.h>"
/// given class are basically used to create Kodi's progress dialog with named
/// text fields.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.cpp}
/// #include <kodi/gui/dialogs/Progress.h>
///
/// kodi::gui::dialogs::CProgress *progress = new kodi::gui::dialogs::CProgress;
/// progress->SetHeading("Test progress");
/// progress->SetLine(1, "line 1");
/// progress->SetLine(2, "line 2");
/// progress->SetLine(3, "line 3");
/// progress->SetCanCancel(true);
/// progress->ShowProgressBar(true);
/// progress->Open();
/// for (unsigned int i = 0; i < 100; i += 10)
/// {
/// progress->SetPercentage(i);
/// sleep(1);
/// }
/// delete progress;
/// ~~~~~~~~~~~~~
///
class CProgress
{
public:
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_CProgress
/// @brief Construct a new dialog
///
CProgress()
{
using namespace ::kodi::addon;
m_DialogHandle = CAddonBase::m_interface->toKodi->kodi_gui->dialogProgress->new_dialog(CAddonBase::m_interface->toKodi->kodiBase);
if (!m_DialogHandle)
kodi::Log(ADDON_LOG_FATAL, "kodi::gui::dialogs::CProgress can't create window class from Kodi !!!");
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_CProgress
/// @brief Destructor
///
~CProgress()
{
using namespace ::kodi::addon;
if (m_DialogHandle)
CAddonBase::m_interface->toKodi->kodi_gui->dialogProgress->delete_dialog(CAddonBase::m_interface->toKodi->kodiBase, m_DialogHandle);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_CProgress
/// @brief To open the dialog
///
void Open()
{
using namespace ::kodi::addon;
CAddonBase::m_interface->toKodi->kodi_gui->dialogProgress->open(CAddonBase::m_interface->toKodi->kodiBase, m_DialogHandle);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_CProgress
/// @brief Set the heading title of dialog
///
/// @param[in] heading Title string to use
///
void SetHeading(const std::string& heading)
{
using namespace ::kodi::addon;
CAddonBase::m_interface->toKodi->kodi_gui->dialogProgress->set_heading(CAddonBase::m_interface->toKodi->kodiBase, m_DialogHandle, heading.c_str());
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_CProgress
/// @brief To set the line text field on dialog from 0 - 2
///
/// @param[in] iLine Line number
/// @param[in] line Text string
///
void SetLine(unsigned int iLine, const std::string& line)
{
using namespace ::kodi::addon;
CAddonBase::m_interface->toKodi->kodi_gui->dialogProgress->set_line(CAddonBase::m_interface->toKodi->kodiBase, m_DialogHandle, iLine, line.c_str());
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_CProgress
/// @brief To enable and show cancel button on dialog
///
/// @param[in] canCancel if true becomes it shown
///
void SetCanCancel(bool canCancel)
{
using namespace ::kodi::addon;
CAddonBase::m_interface->toKodi->kodi_gui->dialogProgress->set_can_cancel(CAddonBase::m_interface->toKodi->kodiBase, m_DialogHandle, canCancel);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_CProgress
/// @brief To check dialog for clicked cancel button
///
/// @return True if canceled
///
bool IsCanceled() const
{
using namespace ::kodi::addon;
return CAddonBase::m_interface->toKodi->kodi_gui->dialogProgress->is_canceled(CAddonBase::m_interface->toKodi->kodiBase, m_DialogHandle);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_CProgress
/// @brief Get the current progress position as percent
///
/// @param[in] percentage Position to use from 0 to 100
///
void SetPercentage(int percentage)
{
using namespace ::kodi::addon;
CAddonBase::m_interface->toKodi->kodi_gui->dialogProgress->set_percentage(CAddonBase::m_interface->toKodi->kodiBase, m_DialogHandle, percentage);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_CProgress
/// @brief To set the current progress position as percent
///
/// @return Current Position used from 0 to 100
///
int GetPercentage() const
{
using namespace ::kodi::addon;
return CAddonBase::m_interface->toKodi->kodi_gui->dialogProgress->get_percentage(CAddonBase::m_interface->toKodi->kodiBase, m_DialogHandle);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_CProgress
/// @brief To show or hide progress bar dialog
///
/// @param[in] onOff If true becomes it shown
///
void ShowProgressBar(bool onOff)
{
using namespace ::kodi::addon;
CAddonBase::m_interface->toKodi->kodi_gui->dialogProgress->show_progress_bar(CAddonBase::m_interface->toKodi->kodiBase, m_DialogHandle, onOff);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_CProgress
/// @brief Set the maximum position of progress, needed if `SetProgressAdvance(...)` is used
///
/// @param[in] max Biggest usable position to use
///
void SetProgressMax(int max)
{
using namespace ::kodi::addon;
CAddonBase::m_interface->toKodi->kodi_gui->dialogProgress->set_progress_max(CAddonBase::m_interface->toKodi->kodiBase, m_DialogHandle, max);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_CProgress
/// @brief To increase progress bar by defined step size until reach of maximum position
///
/// @param[in] steps Step size to increase, default is 1
///
void SetProgressAdvance(int steps=1)
{
using namespace ::kodi::addon;
CAddonBase::m_interface->toKodi->kodi_gui->dialogProgress->set_progress_advance(CAddonBase::m_interface->toKodi->kodiBase, m_DialogHandle, steps);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui_dialogs_CProgress
/// @brief To check progress was canceled on work
///
/// @return True if aborted
///
bool Abort()
{
using namespace ::kodi::addon;
return CAddonBase::m_interface->toKodi->kodi_gui->dialogProgress->abort(CAddonBase::m_interface->toKodi->kodiBase, m_DialogHandle);
}
//--------------------------------------------------------------------------
private:
void* m_DialogHandle;
};
} /* namespace dialogs */
} /* namespace gui */
} /* namespace kodi */
|
