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
|
/************************************************************************
*
* 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 <core/progress/function.hpp>
#include <boost/signals2.hpp>
#include <functional>
#include <string>
namespace sight::ui::dialog
{
/**
* @brief Defines the generic Progress dialog for UI.
*
* @note inherits from boost::signals2::trackable to auto_disconnect if handler is destroyed before the notifier.
* @todo add methods for behavior like autoClose, flying window or in status bar
*/
class SIGHT_UI_CLASS_API progress_base : public ui::object
{
public:
SIGHT_DECLARE_CLASS(progress_base, ui::object);
using factory_registry_key_t = std::string;
/// 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 ~progress_base() override = default;
SIGHT_UI_API 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;
/// action called by core::tools::progress_adviser
SIGHT_UI_API virtual void operator()(float _percent, std::string _msg) = 0;
SIGHT_UI_API virtual void set_cancel_callback(core::progress::cancel_callback_t _callback);
//------------------------------------------------------------------------------
virtual void set_cancel_raise_exception(bool _raise)
{
m_raise = _raise;
}
//------------------------------------------------------------------------------
virtual bool get_canceled()
{
return m_canceled;
}
//------------------------------------------------------------------------------
virtual void hide_cancel_button()
{
}
//------------------------------------------------------------------------------
virtual void set_process_user_events(bool _process)
{
m_process_user_events = _process;
}
protected:
SIGHT_UI_API virtual void cancel_pressed();
core::progress::cancel_callback_t m_cancel_callback;
bool m_canceled {false};
bool m_raise {true};
///progress bar's current value: [0-100]
int m_value {0};
bool m_process_user_events {true};
protected:
//------------------------------------------------------------------------------
static sptr progress_dialog_factory()
{
ui::object::sptr gui_obj = ui::factory::make(
ui::dialog::progress_base::REGISTRY_KEY
);
ui::dialog::progress_base::sptr progress_dlg =
std::dynamic_pointer_cast<ui::dialog::progress_base>(gui_obj);
return progress_dlg;
}
};
} // namespace sight::ui::dialog
|
