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
|
/************************************************************************
*
* 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 <ui/__/menu.hpp>
namespace sight::module::ui
{
/**
* @brief Defines the default menu for standard application
*/
class menu : public sight::ui::menu
{
public:
SIGHT_DECLARE_SERVICE(menu, sight::ui::menu);
/// Constructor. Do nothing.
menu() noexcept;
/// Destructor. Do nothing.
~menu() noexcept override;
protected:
/** @name Service methods ( override from service::base )
* @{
*/
/**
* @brief Configuring method allows to configure a menu with several actions.
* Example of configuration
* @code{.xml}
<service uid="menubar" type="ui::menubar" impl="sight::module::ui::menubar"
* auto_connect="false"
*>
<gui>
<layout>
<menu name="My menu"/>
<menu name="My menu 2"/>
</layout>
</gui>
<registry>
<menu sid="myMenu" />
<menu sid="myMenu2" />
</registry>
</service>
@endcode
* - \<gui\> \</gui\> : (mandatory) describe the interface of the service.
* - <separator /> : allows to put a separator in the menu
* - \<registry\> \</registry\> : (mandatory) describe the service management.
*
* @warning
* - The number of item in the gui section must be equal or greater than in the registry section.
* - The order of the menu in each section (gui and registry) must be the same.\n
* For example: the menu named "My menu" will be connected with the service which have the sid = "myMenu".
* - A menu bar can't have the same service connected on two different menu.
*
* @see sight::ui::menubar::initialize(),
* sight::ui::layout::menu_manager::initialize()
*/
void configuring() override;
/**
* @brief Create the menu items and start the managed services.
* @see sight::ui::menu::create()
*/
void starting() override;
/**
* @brief Stop all actions and separator of this menu and remove menu to menubar
* @see sight::ui::menu::destroy()
*/
void stopping() override;
/// Updating service, do nothing.
void updating() override;
///@}
};
} // namespace sight::module::ui
|
