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
|
/************************************************************************
*
* Copyright (C) 2009-2025 IRCAD France
* Copyright (C) 2012-2019 IHU Strasbourg
*
* This file is part of Sight.
*
* Sight is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Sight 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sight. If not, see <https://www.gnu.org/licenses/>.
*
***********************************************************************/
#pragma once
#include <sight/ui/__/config.hpp>
#include "ui/__/object.hpp"
#include <functional>
#include <string>
namespace sight::ui::dialog
{
/**
* @brief Defines the generic Progress dialog for UI.
* @todo add methods for behavior like autoClose, flying window or in status bar
*/
class SIGHT_UI_CLASS_API pulse_progress_base : public ui::object
{
public:
SIGHT_DECLARE_CLASS(pulse_progress_base, ui::object);
using factory_registry_key_t = std::string;
using Stuff = std::function<void ()>;
using MilliSecond = std::uint64_t;
/// this *unique* key should be used *for all* factory for specific location(qt,wx,...)
SIGHT_UI_API static const factory_registry_key_t REGISTRY_KEY;
SIGHT_UI_API ~pulse_progress_base() override = default;
SIGHT_UI_API pulse_progress_base() = default;
///set the title for the dialog
SIGHT_UI_API virtual void set_title(const std::string& _title) = 0;
///set the message for the dialog
SIGHT_UI_API virtual void set_message(const std::string& _msg) = 0;
///set the stuff
SIGHT_UI_API virtual void set_stuff(Stuff _stuff);
///set the frequency
SIGHT_UI_API virtual void set_frequency(MilliSecond _frequency);
///allow to cancel the dialog
SIGHT_UI_API virtual void set_cancellable(bool _cancellable);
///show the pulse progress dialog
SIGHT_UI_API virtual void show() = 0;
protected:
Stuff m_stuff;
MilliSecond m_frequency {1};
bool m_cancellable {true};
};
} // namespace sight::ui::dialog
|
