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
|
/************************************************************************
*
* 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 <ui/__/action.hpp>
#include <filesystem>
namespace sight::module::ui::qt
{
/**
* @brief This action show the help contents.
*/
class show_help : public sight::ui::action
{
public:
SIGHT_DECLARE_SERVICE(show_help, sight::ui::action);
show_help() noexcept = default;
~show_help() noexcept override = default;
protected:
/**
* @brief Configuring method.
*
* XML configuration sample:
* @code{.xml}
<service impl="sight::module::ui::qt::show_help" type="ui::action">
<filename id=".../doc.qhc"/>
</service>
@endcode
* This method is used to configure the service.
*/
void configuring() override;
/// Starts action
void starting() override;
/// Show the frame
void updating() override;
/// Stops action
void stopping() override;
void info(std::ostream& _sstream) override;
private:
/**
* @brief the m_bServiceIsConfigured value is \b true
* if the help files path is known.
*/
bool m_b_service_is_configured {false};
/**
* @brief help files path.
*/
std::filesystem::path m_fs_help_path;
};
} // namespace sight::module::ui::qt
|
