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
|
/************************************************************************
*
* Copyright (C) 2009-2024 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 <core/base.hpp>
#include <ui/__/toolbar.hpp>
namespace sight::module::ui
{
/**
* @brief Defines the default toolbar for standard application
*/
class toolbar : public sight::ui::toolbar
{
public:
SIGHT_DECLARE_SERVICE(toolbar, sight::ui::toolbar);
/// Constructor. Do nothing.
toolbar() noexcept;
/// Destructor. Do nothing.
~toolbar() noexcept override;
protected:
/** @name Service methods ( override from service::base )
* @{
*/
/**
* @brief This method create a new tool_bar in frame.
*/
/**
* @brief Create the toolbar
* @see sight::ui::toolbar::create()
*/
void starting() override;
/**
* @brief This method remove the tools situated in the tool_bar.
* @see sight::ui::toolbar::destroy()
*/
void stopping() override;
/**
* @brief This method is used to update services. Do nothing.
*/
void updating() override;
/**
* @brief Configuring method allows to create a toolbar with several actions.
*
* Example of configuration
* @code{.xml}
<service uid="toolbar2" type="ui::toolbar" impl="sight::module::ui::toolbar"
* auto_connect="false"
*>
<gui>
<layout>
<menuItem name="My item 2" style="radio" icon="TutoGui/system.png"/>
<menuItem name="My item 3" style="radio" icon="TutoGui/system.png"/>
<separator />
<menuItem name="My item A" style="radio" icon="TutoGui/monkey.png"/>
<menuItem name="My item B" style="radio" icon="TutoGui/monkey.png"/>
<separator />
<menu name="My menu" />
<separator />
<editor />
</layout>
</gui>
<registry>
<menuItem sid="item2" />
<menuItem sid="item3" />
<menuItem sid="item4" />
<menuItem sid="item5" />
<menu sid="menu" />
<editor sid="editor" />
</registry>
</service>
@endcode
* - \<gui\> \</gui\> : (mandatory) describe the interface of the service.
* - \<registry\> \</registry\> : (mandatory) describe the service management.
* - \<menuItem\> represents action
* - \<menu\> represents menu
* - \<editor\> represents container service (editor, view, ...)
*
* @warning
* - The number of item in the gui section must be EQUAL to the registry section.
* - The order of the item in each section (gui and registry) must be the same.\n
* For example: the item named "My item 2" will be connected with the service which have the sid = "item2".
* - A toolbar can't have the same service connected on two different buttons.
*
* @see sight::ui::toolbar::initialize(),
* sight::ui::layout::toolbar_manager::initialize()
*/
void configuring() override;
/**
* @brief This method is used to give information about the service. Do nothing.
*/
void info(std::ostream& _sstream) override;
///@}
};
} // namespace sight::module::ui
|
