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
|
/************************************************************************
*
* 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/__/detail/registry/menu.hpp"
#include "ui/__/layout/menu_manager.hpp"
#include <service/base.hpp>
namespace sight::ui
{
namespace detail::registry
{
class menu;
}
/**
* @brief Defines the service interface managing the menu.
*/
class SIGHT_UI_CLASS_API menu : public service::base
{
public:
SIGHT_DECLARE_SERVICE(menu, service::base);
/// Method called when an action service is stopping
SIGHT_UI_API void action_service_stopping(std::string _action_srv_sid);
/// Method called when an action service is starting
SIGHT_UI_API void action_service_starting(std::string _action_srv_sid);
/// Method called when the action service is activated
SIGHT_UI_API void action_service_set_checked(std::string _action_srv_sid, bool _is_checked);
/// Method called when the action service is executable
SIGHT_UI_API void action_service_set_enabled(std::string _action_srv_sid, bool _is_enabled);
/// Method called when the action service is visible
SIGHT_UI_API void action_service_set_visible(std::string _action_srv_sid, bool _is_visible);
protected:
SIGHT_UI_API ~menu() override = default;
/**
* @brief Initialize the layout and registry managers.
*
* Example of configuration
* @code{.xml}
<service uid="myMenu" type="ui::menu" impl="sight::module::ui::menu">
<gui>
<layout hideActions="false">
<menuItem name="My item 1" shortcut="1" style="check" />
<separator />
<menuItem name="My item 2" shortcut="2" style="radio" />
<menuItem name="My item 3" shortcut="3" style="radio" />
<separator />
<menu name="My menu" />
<separator />
<menuItem name="Quit" shortcut="Ctrl+Q" specialAction="QUIT" />
</layout>
</gui>
<registry>
<menuItem sid="item1" />
<menuItem sid="item2" />
<menuItem sid="item3" />
<menu sid="myMenu" />
<menuItem sid="actionQuit" />
</registry>
</service>
@endcode
* - \<gui\> \</gui\> : (mandatory) describe the interface of the service. It must contain a layout section.
* - \<layout\> \</layout\> : (mandatory) describe the layout of the service
* - \b hideActions: (optional, default=false): if true, the actions are hidden when they are stopped.
* - \<registry\> \</registry\> : (mandatory) describe the service management.
* - \<menuItem\> represents action
* - \<menu\> represents menu
*
* @warning
* - The number of item in the gui section must be <b> EQUAL </b> to the registry section.
* - The order of the menu item in each section (gui and registry) must be the same.\n
* For example: the menu item named "My item 1" will be connected with the service which have the sid = "item1".
* - A menu can't have the same service connected on two different menu items.
*
* @see ui::registry::menu::initialize(), ui::layout::menu_manager::initialize()
*/
SIGHT_UI_API void initialize();
/// Create the layout and start the managed services.
SIGHT_UI_API void create();
/// Destroy the layout and stop the managed services.
SIGHT_UI_API void destroy();
private:
void initialize_layout_manager(const ui::config_t& _layout_config);
ui::layout::menu_manager::sptr m_layout_manager;
SPTR(ui::detail::registry::menu) m_registry;
/// Flag to hide or disable the actions if the service is stopped
bool m_hide_actions {false};
};
} // namespace sight::ui
|
