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
|
/************************************************************************
*
* 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 <service/base.hpp>
#include <ui/__/action.hpp>
#include <vector>
namespace sight::module::ui
{
/**
* @brief This action is used to modify the layout configuration.
*/
class modify_layout : public sight::ui::action
{
public:
SIGHT_DECLARE_SERVICE(modify_layout, sight::ui::action);
/**
* @brief Constructor. Do nothing.
*/
modify_layout() noexcept = default;
/**
* @brief Destructor. Do nothing.
*/
~modify_layout() noexcept override = default;
protected:
enum class visibility_t : std::uint8_t
{
show,
hide,
show_or_hide,
toggle
};
/**
* @brief This method gives information about the class. Do nothing.
*/
void info(std::ostream& _sstream) override;
/**
* @brief This method starts-updates or stops the specified services
*/
void updating() override;
/**
* @brief This method is used to configure the service parameters: specifies which views to show/hide/mode.
*
* @code{.xml}
<config>
<move uid="srv_uid" wid="new_view_wid" />
<show wid="view_to_show" />
<hide wid="view_to_hide" />
<show_or_hide wid="view_to_show_or_hide" />
<toggle wid="view_to_toggle_visibility" />
<enable uid="action_to_enabled" />
<disable uid="action_to_disabled" />
</config>
@endcode
* - \b move configures the services to move in the new view given by wid
* - \b show configures the element to show
* - \b hide configures the element to hide
* - \b show_or_hide configures the element to show or hide.
* If action is activated, element is shown else it is hidden.
* - \b toggle configures the element to show or hide.
* If the element is visible, element is hidden else it is show.
*
* \<show\>, \<hide\>, \<show_or_hide\> and \<toggle\> tags can have 2 type of attribute :
* - wid to show or hide windows container (view)
* - sid to show or hide a gui container service (editor, view, render...)
*
* The action in the menu/toolbar must be checkable (style="check").
*/
void configuring() override;
void starting() override;
void stopping() override;
private:
/// < fwID, WIDContainer>
using move_srv_vect_t = std::vector<std::pair<std::string, std::string> >;
/// map representing fwID's services and new associated wid parent container
move_srv_vect_t m_move_srv;
/// < wid, showState>
using show_srv_vect_t = std::vector<std::pair<std::string, visibility_t> >;
/// map representing wid container and show state
show_srv_vect_t m_show_srv_wid;
/// map representing sid container and show state
show_srv_vect_t m_show_srv_sid;
/// < fwID, enableState>
using enable_srv_vect_t = std::vector<std::pair<std::string, bool> >;
/// map representing fwID's services and enable state
enable_srv_vect_t m_enable_srv;
};
} // namespace sight::module::ui
|