Bitcoin Core  22.99.0
P2P Digital Currency
ui_interface.h
Go to the documentation of this file.
1 // Copyright (c) 2010 Satoshi Nakamoto
2 // Copyright (c) 2012-2020 The Bitcoin Core developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 
6 #ifndef BITCOIN_NODE_UI_INTERFACE_H
7 #define BITCOIN_NODE_UI_INTERFACE_H
8 
9 #include <functional>
10 #include <memory>
11 #include <string>
12 
13 class CBlockIndex;
14 enum class SynchronizationState;
15 struct bilingual_str;
16 
17 namespace boost {
18 namespace signals2 {
19 class connection;
20 }
21 } // namespace boost
22 
25 {
26 public:
29  {
31  ICON_WARNING = (1U << 0),
32  ICON_ERROR = (1U << 1),
38 
40  BTN_OK = 0x00000400U, // QMessageBox::Ok
41  BTN_YES = 0x00004000U, // QMessageBox::Yes
42  BTN_NO = 0x00010000U, // QMessageBox::No
43  BTN_ABORT = 0x00040000U, // QMessageBox::Abort
44  BTN_RETRY = 0x00080000U, // QMessageBox::Retry
45  BTN_IGNORE = 0x00100000U, // QMessageBox::Ignore
46  BTN_CLOSE = 0x00200000U, // QMessageBox::Close
47  BTN_CANCEL = 0x00400000U, // QMessageBox::Cancel
48  BTN_DISCARD = 0x00800000U, // QMessageBox::Discard
49  BTN_HELP = 0x01000000U, // QMessageBox::Help
50  BTN_APPLY = 0x02000000U, // QMessageBox::Apply
51  BTN_RESET = 0x04000000U, // QMessageBox::Reset
58 
60  MODAL = 0x10000000U,
61 
63  SECURE = 0x40000000U,
64 
69  };
70 
71 #define ADD_SIGNALS_DECL_WRAPPER(signal_name, rtype, ...) \
72  rtype signal_name(__VA_ARGS__); \
73  using signal_name##Sig = rtype(__VA_ARGS__); \
74  boost::signals2::connection signal_name##_connect(std::function<signal_name##Sig> fn);
75 
77  ADD_SIGNALS_DECL_WRAPPER(ThreadSafeMessageBox, bool, const bilingual_str& message, const std::string& caption, unsigned int style);
78 
80  ADD_SIGNALS_DECL_WRAPPER(ThreadSafeQuestion, bool, const bilingual_str& message, const std::string& noninteractive_message, const std::string& caption, unsigned int style);
81 
83  ADD_SIGNALS_DECL_WRAPPER(InitMessage, void, const std::string& message);
84 
86  ADD_SIGNALS_DECL_WRAPPER(NotifyNumConnectionsChanged, void, int newNumConnections);
87 
89  ADD_SIGNALS_DECL_WRAPPER(NotifyNetworkActiveChanged, void, bool networkActive);
90 
95 
100  ADD_SIGNALS_DECL_WRAPPER(ShowProgress, void, const std::string& title, int nProgress, bool resume_possible);
101 
103  ADD_SIGNALS_DECL_WRAPPER(NotifyBlockTip, void, SynchronizationState, const CBlockIndex*);
104 
107 
110 };
111 
113 void InitWarning(const bilingual_str& str);
114 
116 bool InitError(const bilingual_str& str);
117 constexpr auto AbortError = InitError;
118 
120 
121 #endif // BITCOIN_NODE_UI_INTERFACE_H
CClientUIInterface::MSG_INFORMATION
@ MSG_INFORMATION
Predefined combinations for certain default usage cases.
Definition: ui_interface.h:66
CClientUIInterface::MODAL
@ MODAL
Force blocking, modal message box dialog (not just OS notification)
Definition: ui_interface.h:60
CClientUIInterface::BTN_ABORT
@ BTN_ABORT
Definition: ui_interface.h:43
CClientUIInterface
Signals for UI communication.
Definition: ui_interface.h:24
NotifyAlertChanged
static void NotifyAlertChanged(ClientModel *clientmodel)
Definition: clientmodel.cpp:262
InitMessage
static void InitMessage(SplashScreen *splash, const std::string &message)
Definition: splashscreen.cpp:174
ShowProgress
static void ShowProgress(ClientModel *clientmodel, const std::string &title, int nProgress)
Definition: clientmodel.cpp:238
CClientUIInterface::BTN_DISCARD
@ BTN_DISCARD
Definition: ui_interface.h:48
bilingual_str
Bilingual messages:
Definition: translation.h:16
InitError
bool InitError(const bilingual_str &str)
Show error message.
Definition: ui_interface.cpp:56
CClientUIInterface::ICON_WARNING
@ ICON_WARNING
Definition: ui_interface.h:31
CClientUIInterface::BTN_OK
@ BTN_OK
These values are taken from qmessagebox.h "enum StandardButton" to be directly usable.
Definition: ui_interface.h:40
InitWarning
void InitWarning(const bilingual_str &str)
Show warning message.
Definition: ui_interface.cpp:62
CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER
ADD_SIGNALS_DECL_WRAPPER(ThreadSafeMessageBox, bool, const bilingual_str &message, const std::string &caption, unsigned int style)
Show message box.
CClientUIInterface::SECURE
@ SECURE
Do not print contents of message to debug log.
Definition: ui_interface.h:63
CClientUIInterface::ICON_MASK
@ ICON_MASK
Mask of all available icons in CClientUIInterface::MessageBoxFlags This needs to be updated,...
Definition: ui_interface.h:37
CClientUIInterface::MSG_WARNING
@ MSG_WARNING
Definition: ui_interface.h:67
CClientUIInterface::BTN_RESET
@ BTN_RESET
Definition: ui_interface.h:51
BannedListChanged
static void BannedListChanged(ClientModel *clientmodel)
Definition: clientmodel.cpp:269
NotifyHeaderTip
static bool NotifyHeaderTip(CChainState &chainstate) LOCKS_EXCLUDED(cs_main)
Definition: validation.cpp:2504
CClientUIInterface::BTN_IGNORE
@ BTN_IGNORE
Definition: ui_interface.h:45
CClientUIInterface::BTN_CANCEL
@ BTN_CANCEL
Definition: ui_interface.h:47
CClientUIInterface::BTN_HELP
@ BTN_HELP
Definition: ui_interface.h:49
CClientUIInterface::MSG_ERROR
@ MSG_ERROR
Definition: ui_interface.h:68
CClientUIInterface::ICON_INFORMATION
@ ICON_INFORMATION
Definition: ui_interface.h:30
CClientUIInterface::BTN_RETRY
@ BTN_RETRY
Definition: ui_interface.h:44
CClientUIInterface::BTN_YES
@ BTN_YES
Definition: ui_interface.h:41
ThreadSafeMessageBox
static bool ThreadSafeMessageBox(BitcoinGUI *gui, const bilingual_str &message, const std::string &caption, unsigned int style)
Definition: bitcoingui.cpp:1439
NotifyNumConnectionsChanged
static void NotifyNumConnectionsChanged(ClientModel *clientmodel, int newNumConnections)
Definition: clientmodel.cpp:247
CClientUIInterface::BTN_APPLY
@ BTN_APPLY
Definition: ui_interface.h:50
CClientUIInterface::BTN_CLOSE
@ BTN_CLOSE
Definition: ui_interface.h:46
CClientUIInterface::ICON_ERROR
@ ICON_ERROR
Definition: ui_interface.h:32
CClientUIInterface::BTN_MASK
@ BTN_MASK
Mask of all available buttons in CClientUIInterface::MessageBoxFlags This needs to be updated,...
Definition: ui_interface.h:56
SynchronizationState
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:93
AbortError
constexpr auto AbortError
Definition: ui_interface.h:117
CBlockIndex
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:145
CClientUIInterface::MessageBoxFlags
MessageBoxFlags
Flags for CClientUIInterface::ThreadSafeMessageBox.
Definition: ui_interface.h:28
NotifyNetworkActiveChanged
static void NotifyNetworkActiveChanged(ClientModel *clientmodel, bool networkActive)
Definition: clientmodel.cpp:255
uiInterface
CClientUIInterface uiInterface
Definition: ui_interface.cpp:12
CClientUIInterface::BTN_NO
@ BTN_NO
Definition: ui_interface.h:42