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
|
/************************************************************************
*
* 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 <service/base.hpp>
#include <ui/__/object.hpp>
#include <ui/__/parameter.hpp>
namespace sight::ui
{
// Forward declarations
namespace container
{
class widget;
} // namespace container
namespace layout
{
class view;
} // namespace layout
namespace detail::registry
{
class view;
} // namespace detail::registry
namespace builder
{
class toolbar;
class widget;
class slideview;
} // namespace builder
/**
* @brief Defines the service interface managing the layout.
*
* @section Slots Slots
*
* - \b set_enabled(bool isEnabled) : this slot enables the container (if isEnabled = true) or disables it.
* - \b set_enabled_by_param(ui::parameter_t isEnabled) : this slot enables the container (if isEnabled holds boolean
* alternative) or disables it.
* - \b enable() : this slot enables the container.
* - \b disable() : this slot disables the container
* - \b set_visible(bool isVisible) : this slot shows the container (if isVisible = true) or hides it.
* - \b set_visible_by_parameter(ui::parameter_t isVisible) : this slot shows the container (if isEnabled holds boolean
* alternative) or hides it.
* - \b show() : this slot shows the container.
* - \b hide() : this slot hides the container.
* - \b toggle_visibility() : this slot shows the container if it is hidden or hides it if it is shown
* - \b modify_layout(ui::parameter_t parameter, std::string key) : this slot modifies a layout element, depending
* of the key.
*
* @section XML Example of XML configuration
*
* @code{.xml}
<service uid="subView1" type="sight::module::ui::view" auto_connect="false" >
<gui>
<layout type="ui::layout::line" >
<orientation value="horizontal" />
<view caption="view3" />
<view caption="view4" />
<view caption="view5" />
</layout>
<toolbar />
<slideView />
<slideView align="top" size="200" opacity="1.0">
<styleSheet>color: blue; background-color: yellow</styleSheet>
</slideView>
</gui>
<registry>
<parent wid="myView" />
<toolbar sid="toolbar1" />
<view sid="subView3" />
<view wid="subView4" />
<view sid="subView5" />
<slideView sid="slideView1" start="true />
<slideView wid="slideView2" />
</registry>
</service>
@endcode
* - \<layout type="ui::layout::line" \> : give the type of layout.
* - \b type {::ui::layout::line | ui::layout::cardinal | ui::layout::tab |
* ui::layout::toolbox} :
* - \b ui::layout::line : all views will be on the same line or column (it depends of the orientation
* value attribute)
* @see ui::layout::line
* - \b ui::layout::cardinal : all views will be added around a central view define by the align
* attribute.
* @see ui::layout::cardinal
* - \b ui::layout::tab : all views will be draw as tab.
* @see ui::layout::tab
* - \b ui::layout::toolbox : all views will be draw in toolbox.
* @see ui::layout::toolbox
* - \b toolbar: defines the toolbar configuration.
* @see ui::builder::toolbar
* - \b slideView: defines a slide view.
* @see ui::builder::slideview
*
* @note The layout and registry sections can be empty. In this case no subview will be created.
*
* @warning
* - The order of the view in each section (gui and registry) must be the same.\n
* For example: the view caption "view3" will be connected with the service which have the sid = "subView3" and so one
* (it also could be a wid).
*
*
*/
class SIGHT_UI_CLASS_API service : public sight::service::base
{
public:
SIGHT_DECLARE_SERVICE(service, service::base);
SIGHT_UI_API SPTR(ui::container::widget) get_container();
SIGHT_UI_API void set_parent(std::string _wid);
/// @name Slots
/// @{
struct SIGHT_UI_CLASS_API slots : public sight::service::slots
{
using key_t = sight::core::com::slots::key_t;
inline static const key_t SET_ENABLED = "set_enabled";
inline static const key_t SET_ENABLED_BY_PARAM = "set_enabled_by_param";
inline static const key_t ENABLE = "enable";
inline static const key_t DISABLE = "disable";
inline static const key_t SET_VISIBLE = "set_visible";
inline static const key_t SET_VISIBLE_BY_PARAM = "setVisibleByParam";
inline static const key_t SHOW = "show";
inline static const key_t HIDE = "hide";
inline static const key_t TOGGLE_VISIBILITY = "toggle_visibility";
inline static const key_t MODIFY_LAYOUT = "modify_layout";
};
/// SLOT: enable/disable the container
SIGHT_UI_API virtual void set_enabled(bool _is_enabled);
/// SLOT: enable/disable the container using parameter_t (only testing bool alternative).
SIGHT_UI_API virtual void set_enabled_by_parameter(ui::parameter_t);
/// SLOT: enable the container
SIGHT_UI_API virtual void enable();
/// SLOT: disable the container
SIGHT_UI_API virtual void disable();
/// SLOT: show/hide the container
SIGHT_UI_API virtual void set_visible(bool _is_visible);
/// SLOT: show/hide the container using parameter_t (only testing bool alternative).
SIGHT_UI_API virtual void set_visible_by_parameter(ui::parameter_t);
/// SLOT: show the container
SIGHT_UI_API virtual void show();
/// SLOT: hide the container
SIGHT_UI_API virtual void hide();
/// SLOT: show the container if it is hidden or hide it if it is shown
SIGHT_UI_API void toggle_visibility();
/// SLOT: modify a layout element, depending of the key. Forwarded to the view layout manager.
SIGHT_UI_API virtual void modify_layout(ui::parameter_t _parameter, std::string _key);
/// @}
protected:
SIGHT_UI_API service();
SIGHT_UI_API ~service() override = default;
/**
* @brief Initialize managers.
*
@see ui::registry::view::initialize(), ui::layout::view::initialize(),
*::ui::builder::toolbar::initialize()
*/
SIGHT_UI_API void initialize();
/**
* @brief Creates view, sub-views and toolbar containers. Manages sub-views and toobar services.
*
* @pre Parent container must be registered.
*/
SIGHT_UI_API void create();
/// Stops sub-views and toobar services. Destroys view, sub-views and toolbar containers.
SIGHT_UI_API void destroy();
private:
using slide_view_container_t = std::vector<std::shared_ptr<ui::builder::slideview> >;
void initialize_layout_manager(const ui::config_t& _layout_config);
void initialize_tool_bar_builder(const ui::config_t& _tool_bar_config);
void initialize_slide_view_builder(const ui::config_t& _slide_view_config);
bool m_view_layout_manager_is_created {false};
SPTR(ui::layout::view) m_view_layout_manager;
SPTR(ui::detail::registry::view) m_view_registry;
SPTR(ui::builder::toolbar) m_tool_bar_builder;
SPTR(ui::builder::widget) m_container_builder;
slide_view_container_t m_slide_view_builders;
bool m_has_tool_bar {false};
};
} // namespace sight::ui
|
