File: registry.hpp

package info (click to toggle)
sight 25.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 42,180 kB
  • sloc: cpp: 289,476; xml: 17,257; ansic: 9,878; python: 1,379; sh: 144; makefile: 33
file content (217 lines) | stat: -rw-r--r-- 6,469 bytes parent folder | download | duplicates (2)
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
/************************************************************************
 *
 * Copyright (C) 2009-2024 IRCAD France
 * Copyright (C) 2012-2021 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/menu.hpp"
#include "ui/__/container/menu_item.hpp"
#include "ui/__/container/menubar.hpp"
#include "ui/__/container/toolbar.hpp"
#include "ui/__/container/widget.hpp"
#include "ui/__/object.hpp"

// contains helpers to manage all widget in the application.
namespace sight::ui::registry
{

using container_map_t           = std::map<std::string, ui::container::widget::sptr>;
using menu_bar_map_t            = std::map<std::string, ui::container::menubar::sptr>;
using tool_bar_map_t            = std::map<std::string, ui::container::toolbar::sptr>;
using menu_map_t                = std::map<std::string, ui::container::menu::sptr>;
using parent_sids_t             = std::vector<std::string>;
using action_to_parent_map_type = std::map<std::string, parent_sids_t>;

//-----------------------------------------------------------------------------

/**
 * @name    Helper SID-container methods
 */
///@{

/**
 * @brief Registers container associate with service ID.
 */
SIGHT_UI_API void register_sid_container(std::string _sid, ui::container::widget::sptr _container);

/**
 * @brief Unregisters container associate with service ID.
 */
SIGHT_UI_API void unregister_sid_container(std::string _sid);

/**
 * @brief Returns widget associate with service ID, null if  not found.
 */
SIGHT_UI_API ui::container::widget::sptr get_sid_container(std::string _sid);

/**
 * @brief Verifies if a SID exists in the global SID container.
 */
SIGHT_UI_API bool has_sid_container(std::string _sid);

///@}

//-----------------------------------------------------------------------------

/**
 * @name    Helper WID-container methods
 */
///@{

/**
 * @brief Registers container associate with window ID.
 */
SIGHT_UI_API void register_wid_container(std::string _wid, ui::container::widget::sptr _container);

/**
 * @brief Unregisters container associate with window ID.
 */
SIGHT_UI_API void unregister_wid_container(std::string _wid);

/**
 * @brief Returns widget associate with window ID, null if  not found.
 */
SIGHT_UI_API ui::container::widget::sptr get_wid_container(std::string _wid);

/**
 * @brief Verifies if a WID exists in the global WID container.
 */
SIGHT_UI_API bool has_wid_container(std::string _wid);

///@}

//-----------------------------------------------------------------------------

/**
 * @name    Helper SID-menu_bar methods
 */
///@{

/**
 * @brief Registers menubar associate with service ID.
 */
SIGHT_UI_API void register_sid_menu_bar(std::string _sid, ui::container::menubar::sptr _menu_bar);

/**
 * @brief Unregisters menubar associate with service ID.
 */
SIGHT_UI_API void unregister_sid_menu_bar(std::string _sid);
/**
 * @brief Returns menubar associate with service ID.
 */
SIGHT_UI_API ui::container::menubar::sptr get_sid_menu_bar(std::string _sid);
///@}

//-----------------------------------------------------------------------------

/**
 * @name    Helper SID-tool_bar methods
 */
///@{

/**
 * @brief Registers toolbar associate with service ID.
 */
SIGHT_UI_API void register_sid_tool_bar(std::string _sid, ui::container::toolbar::sptr _tool_bar);

/**
 * @brief Unregisters toolbar associate with service ID.
 */
SIGHT_UI_API void unregister_sid_tool_bar(std::string _sid);
/**
 * @brief Returns toolbar associate with service ID.
 */
SIGHT_UI_API ui::container::toolbar::sptr get_sid_tool_bar(std::string _sid);
///@}

//-----------------------------------------------------------------------------

/**
 * @name    Helper SID-menu methods
 */
///@{

/**
 * @brief Registers menu associate with service ID.
 */
SIGHT_UI_API void register_sid_menu(std::string _sid, ui::container::menu::sptr _menu);

/**
 * @brief Unregisters menu associate with service ID.
 */
SIGHT_UI_API void unregister_sid_menu(std::string _sid);
/**
 * @brief Returns menu associate with service ID.
 */
SIGHT_UI_API ui::container::menu::sptr get_sid_menu(std::string _sid);
///@}

//-----------------------------------------------------------------------------

/**
 * @name    Helper action-menu methods
 */
///@{

/**
 * @brief Registers action sid associated with a parent sid.
 */
SIGHT_UI_API void register_action_sid_to_parent_sid(std::string _action_sid, std::string _parent_sid);

/**
 * @brief Unregisters action sid associated with a parent sid.
 */
SIGHT_UI_API void unregister_action_sid_to_parent_sid(std::string _action_sid, std::string _parent_sid);

/**
 * @brief Method called when the action service is stopping.
 * Call parent service actionServiceStopping() method
 */
SIGHT_UI_API void action_service_stopping(std::string _action_sid);

/**
 * @brief Method called when the action service is starting.
 * Call parent service actionServiceStarting() method
 */
SIGHT_UI_API void action_service_starting(std::string _action_sid);

/**
 * @brief Method called when the action service is activated or not.
 * Call parent service actionServiceSetChecked() method
 */
SIGHT_UI_API void action_service_set_checked(std::string _action_sid, bool _is_checked);

/**
 * @brief Method called when the action service is executable or not.
 * Call parent service actionServiceSetEnabled() method
 */
SIGHT_UI_API void action_service_set_enabled(std::string _action_sid, bool _is_enabled);

/**
 * @brief Method called when the action service is visible or not.
 * Call parent service actionServiceSetVisible() method
 */
SIGHT_UI_API void action_service_set_visible(std::string _action_sid, bool _is_visible);
///@}

} // namespace sight::ui::registry