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
|
/************************************************************************
*
* Copyright (C) 2018-2024 IRCAD France
* Copyright (C) 2018-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/__/service.hpp"
#include <activity/extension/activity.hpp>
#include <activity/launcher.hpp>
#include <core/com/slots.hpp>
#include <data/activity.hpp>
namespace sight::ui
{
/**
* @brief Defines the base class for services displaying activity view
*
* @section Slots Slots
* - \b launch_activity( data::activity::sptr ): This slot allows to create a view for the given activity.
*
* * @section XML XML Configuration
* @code{.xml}
<service type="sight::module::ui::qt::activity::dynamic_view" auto_connect="true" >
<mainActivity id="SDBActivity" />
<parameters>
<parameter replace="SERIES_SET" by="medicalData" />
<parameter replace="ICON_PATH" by="sight::module::ui::icons/app.ico" />
</parameters>
</service>
@endcode
* - \b mainActivity (optional): information about the main activity (first tab). The activity will be generated.
* This activity must not have requirement.
* - \b id : identifier of the activity
* - \b parameters (optional) : additional parameters used to launch the activities
* - \b parameter: defines a parameter
* - \b replace: name of the parameter as defined in the config
* - \b by: defines the string that will replace the parameter name.
*/
class SIGHT_UI_CLASS_API activity_view : public ui::service,
public activity::launcher
{
public:
SIGHT_DECLARE_CLASS(activity_view, ui::service);
SIGHT_UI_API static const core::com::slots::key_t LAUNCH_ACTIVITY_SLOT;
protected:
using parameter_t = activity::extension::activity_config_param;
using parameters_t = activity::extension::activity_config_params_type;
/// Constructor. Do nothing.
SIGHT_UI_API activity_view();
/// Destructor. Do nothing.
SIGHT_UI_API ~activity_view() override = default;
/// Parses the configuration
SIGHT_UI_API void configuring() override;
/**
* @brief Slot: Launch the given activity in a new tab.
* @note The same activity cannot be launch in two different tabs.
*/
SIGHT_UI_API virtual void launch_activity(data::activity::sptr _activity) = 0;
/**
* @brief Check if the activity is valid by calling the activity validator.
* @return Return true if the given activity is valid
*/
SIGHT_UI_API virtual bool validate_activity(data::activity::sptr _activity) const;
/// Create the activity given in 'mainActivity' configuration
SIGHT_UI_API data::activity::sptr create_main_activity() const override;
/// Input data to pass to the configuration
data::ptr_vector<data::object, data::access::inout> m_data {this, "data"};
};
} // namespace sight::ui
|
