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
|
/************************************************************************
*
* Copyright (C) 2009-2024 IRCAD France
* Copyright (C) 2012-2021 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/__/dialog/input_base.hpp"
namespace sight::ui::dialog
{
/**
* @brief Defines the generic input dialog for GUI.
* Use the Delegate design pattern
*
* Example of use:
* @code{.xml}
ui::dialog::input inputDlg;
inputDlg.setTitle("Identification dialog");
inputDlg.setMessage("Enter Pin Code: ");
inputDlg.set_input ("<Enter your code here>");
std::string inputText = inputDlg.getInput();
@endcode
*/
class SIGHT_UI_CLASS_API input final : public input_base
{
public:
SIGHT_DECLARE_CLASS(input, input_base);
/**
* Opens a default input box with the specified title and message.
*
* @param _title Title of the input box
* @param _message Message of the input box
* @param _text the input text in the input field
* @return Returns text in the input field
*/
SIGHT_UI_API static std::pair<std::string, bool> show_input_dialog(
const std::string& _title,
const std::string& _message,
const std::string& _text = "",
echo_mode _echo_mode = echo_mode::DEFAULT
);
/** @brief Constructor. Create the implementation of the specific input dialog box.
*
* Example of use:
* @code{.xml}
ui::dialog::input inputDlg;
inputDlg.setTitle("Identification dialog");
inputDlg.setMessage("Enter Pin Code: ");
inputDlg.set_input ("<Enter your code here>");
std::string inputText = inputDlg.getInput();
@endcode
*/
SIGHT_UI_API input();
/**
* Constructor. Creates a input box with the specified title and message.
*
* @param _title Title of the input box
* @param _message Message of the input box
* @param _text the input text in the input field
*/
SIGHT_UI_API input(
const std::string& _title,
const std::string& _message,
const std::string& _text = "",
echo_mode _echo_mode = echo_mode::DEFAULT
);
/// Destructor. Do nothing
SIGHT_UI_API ~input() override;
/// Set the title of the input dialog
SIGHT_UI_API void set_title(const std::string& _title) override;
/// Set the message
SIGHT_UI_API void set_message(const std::string& _msg) override;
/// Sets the echo mode used to display input field content
SIGHT_UI_API void set_echo_mode(echo_mode _echo_mode) override;
/// Set the input text in the input field
SIGHT_UI_API void set_input(const std::string& _text) override;
/// Get the input text in the input field
SIGHT_UI_API std::pair<std::string, bool> get_input() override;
protected:
/// Implementation of an input dialog in a specific UI (wx/Qt)
ui::dialog::input_base::sptr m_implementation;
};
} // namespace sight::ui::dialog
|
