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
|
/************************************************************************
*
* 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/__/container/widget.hpp"
#include "ui/__/object.hpp"
#include <filesystem>
#include <functional>
#include <list>
namespace sight::ui::layout
{
/**
* @brief Defines an interface for managing a frame.
*/
class SIGHT_UI_CLASS_API frame_manager : public ui::object
{
public:
SIGHT_DECLARE_CLASS(frame_manager, ui::object);
/// Defines all possible style for a frame
enum style
{
DEFAULT,
stay_on_top,
modal,
fullscreen,
frameless
};
using registry_key_t = std::string;
static const std::string SOFTWARE_UI;
static const std::string FRAME_STATE_UI;
static const std::string FRAME_SIZE_W_UI;
static const std::string FRAME_SIZE_H_UI;
static const std::string FRAME_POSITION_X_UI;
static const std::string FRAME_POSITION_Y_UI;
static const std::string FRAME_SCREEN;
enum class frame_state : std::uint8_t
{
normal = 0, ///< the normal state
iconized = 1, ///< the minimized state
maximized = 2, ///< the maximied state
full_screen = 4 ///< the full screen state
};
struct frame_info final
{
/// Frame name.
std::optional<std::string> m_name {std::nullopt};
/// Optional version number, displayed in the title if specified.
std::optional<std::string> m_version {std::nullopt};
/// Frame icon.
std::optional<std::filesystem::path> m_icon_path {std::nullopt};
/// Frame minimum min width
std::optional<int> m_min_width {std::nullopt};
std::optional<int> m_min_height {std::nullopt};
/// Frame maximum size (max width and max height)
std::optional<int> m_max_width {std::nullopt};
std::optional<int> m_max_height {std::nullopt};
/// Frame style
std::optional<style> m_style {std::nullopt};
/// Frame size
std::optional<int> m_width {std::nullopt};
std::optional<int> m_height {std::nullopt};
/// Frame position
std::optional<int> m_x {std::nullopt};
std::optional<int> m_y {std::nullopt};
/// Frame state (maximize, minized, full screen)
std::optional<frame_state> m_state {std::nullopt};
/// Frame visibility
std::optional<bool> m_visibility {std::nullopt};
std::optional<std::string> m_qss_class {std::nullopt};
/// Configured screen from xml configuration.
std::optional<int> m_configured_screen {std::nullopt};
/// Screen from preferences.
std::optional<int> m_saved_screen {std::nullopt};
};
/// Constructor. Do nothing.
SIGHT_UI_API frame_manager();
/// Destructor. Do nothing.
SIGHT_UI_API ~frame_manager() override = default;
/**
* @brief Configure the layout before creation.
*/
SIGHT_UI_API virtual void initialize(const ui::config_t& _configuration);
SIGHT_UI_API static const registry_key_t REGISTRY_KEY;
/**
* @brief Instantiate frame.
*/
SIGHT_UI_API virtual void create_frame() = 0;
/**
* @brief Destroy frame.
*/
SIGHT_UI_API virtual void destroy_frame() = 0;
/// Return the frame container
virtual ui::container::widget::sptr get_frame()
{
return m_frame;
}
/// Return the first container into the frame
virtual ui::container::widget::sptr get_container()
{
return m_container;
}
using CloseCallback = std::function<void ()>;
SIGHT_UI_API virtual void set_close_callback(CloseCallback _fct);
protected:
/**
* @brief Configuration definition.
* @{ */
const frame_info& get_frame_info() const
{
return m_frame_info;
}
//------------------------------------------------------------------------------
frame_info& get_frame_info()
{
return m_frame_info;
}
//------------------------------------------------------------------------------
void set_frame_info(const frame_info& _frame_info)
{
m_frame_info = _frame_info;
}
/** @} */
ui::container::widget::sptr m_frame;
ui::container::widget::sptr m_container;
CloseCallback m_close_callback;
SIGHT_UI_API void read_config();
SIGHT_UI_API void write_config() const;
private:
static void default_close_callback();
/// Save frame configuration definition
frame_info m_frame_info;
};
} // namespace sight::ui::layout
|
