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
|
/************************************************************************
*
* Copyright (C) 2023-2025 IRCAD France
*
* 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/service/config.hpp>
#include "service/base.hpp"
#include <core/com/signal.hpp>
#include <core/com/signals.hpp>
#include <array>
#include <chrono>
#include <optional>
namespace sight::service
{
/// Defines Notification type
struct SIGHT_SERVICE_CLASS_API notification final
{
// Notification Type (changes Qss style).
// Used for sound reproduction, beware when modifying the order.
enum class type : uint8_t
{
info = 0,
progress,
success,
failure
} m_type {type::info};
/// Where to display notifications.
enum class position : uint8_t
{
top_right = 0,
top_left,
bottom_right,
bottom_left,
centered,
centered_top,
centered_bottom
} m_position {position::top_right};
std::string m_message {};
std::optional<std::chrono::milliseconds> m_duration {std::chrono::seconds(3)};
std::string m_channel {};
std::optional<bool> m_closable {std::nullopt};
std::array<int, 2> m_size {200, 60};
std::optional<bool> m_sound {std::nullopt};
};
/**
* Interface for services that need to display notifications to user.
*
* @section Signals Signals
* - \b notified(Notification notification): Emitted when the service wants to pop a notification.
* - \b notification_closed(std::string channel): Emitted when the service wants to close a notification.
*
* @section XML XML Configuration
*
* @code{.xml}
<service type="...">
<notification>
<channel key="key1" uid="INFO" />
<channel key="key2" uid="${ERROR_CHANNEL}" />
</notification>
</service>
@endcode
*
* @subsection Configuration Configuration
* - \b notification (optional): Specific notification configuration
* - \b channel (optional): Specific channel configuration
* - \b key: The key used in the service to map the uid.
* - \b uid: The uid that identify the channel. All notification request that use the same channel, will share the
* same notification dialog widget
*/
class SIGHT_SERVICE_CLASS_API notifier
{
public:
SIGHT_SERVICE_API notifier(core::com::signals& _signals) noexcept;
virtual ~notifier() noexcept = default;
/// Defines signals for notifier
struct SIGHT_SERVICE_CLASS_API signals final
{
using notification_t = core::com::signal<void (notification)>;
static inline const core::com::signals::key_t NOTIFIED = "notified";
using channel_t = core::com::signal<void (std::string)>;
static inline const core::com::signals::key_t NOTIFICATION_CLOSED = "notification_closed";
};
protected:
/// Emits notification signal
/// @param[in] _notification
/// @{
SIGHT_SERVICE_API void notify(notification _notification) const;
inline void notify(
notification::type _type,
std::string _message,
std::string _channel = "",
bool sound = false
) const;
inline void info(std::string _message, std::string _channel = "", bool sound = false) const;
inline void success(std::string _message, std::string _channel = "", bool sound = false) const;
inline void failure(std::string _message, std::string _channel = "", bool sound = false) const;
/// @}
/// Emits close channel signal
SIGHT_SERVICE_API void close_notification(std::string _channel) const;
/// Method to call to configure notification "channels"
SIGHT_SERVICE_API void initialize(const service::config_t& _config);
/// Signal emitted when notify() is called
const signals::notification_t::sptr m_notified_sig {std::make_shared<signals::notification_t>()};
/// Signal emitted when closeChannel() is called
const signals::channel_t::sptr m_notification_closed_sig {std::make_shared<signals::channel_t>()};
private:
std::map<std::string, std::string> m_channels {{std::string(""), std::string("")}};
};
//------------------------------------------------------------------------------
inline void notifier::notify(
notification::type _type,
std::string _message,
std::string _channel,
bool _sound
) const
{
this->notify(
{
.m_type = std::move(_type),
.m_message = std::move(_message),
.m_channel = std::move(_channel),
.m_sound = std::move(_sound)
});
}
//------------------------------------------------------------------------------
inline void notifier::info(std::string _message, std::string _channel, bool _sound) const
{
this->notify(notification::type::info, std::move(_message), std::move(_channel), std::move(_sound));
}
//------------------------------------------------------------------------------
inline void notifier::success(std::string _message, std::string _channel, bool _sound) const
{
this->notify(notification::type::success, std::move(_message), std::move(_channel), std::move(_sound));
}
//------------------------------------------------------------------------------
inline void notifier::failure(std::string _message, std::string _channel, bool _sound) const
{
this->notify(notification::type::failure, std::move(_message), std::move(_channel), std::move(_sound));
}
} // namespace sight::service
|
