Bitcoin Core  24.99.0
P2P Digital Currency
interface_ui.h
Go to the documentation of this file.
1 // Copyright (c) 2010 Satoshi Nakamoto
2 // Copyright (c) 2012-2021 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_INTERFACE_UI_H
7 #define BITCOIN_NODE_INTERFACE_UI_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:
28  enum MessageBoxFlags : uint32_t {
30  ICON_WARNING = (1U << 0),
31  ICON_ERROR = (1U << 1),
37 
39  BTN_OK = 0x00000400U, // QMessageBox::Ok
40  BTN_YES = 0x00004000U, // QMessageBox::Yes
41  BTN_NO = 0x00010000U, // QMessageBox::No
42  BTN_ABORT = 0x00040000U, // QMessageBox::Abort
43  BTN_RETRY = 0x00080000U, // QMessageBox::Retry
44  BTN_IGNORE = 0x00100000U, // QMessageBox::Ignore
45  BTN_CLOSE = 0x00200000U, // QMessageBox::Close
46  BTN_CANCEL = 0x00400000U, // QMessageBox::Cancel
47  BTN_DISCARD = 0x00800000U, // QMessageBox::Discard
48  BTN_HELP = 0x01000000U, // QMessageBox::Help
49  BTN_APPLY = 0x02000000U, // QMessageBox::Apply
50  BTN_RESET = 0x04000000U, // QMessageBox::Reset
57 
59  MODAL = 0x10000000U,
60 
62  SECURE = 0x40000000U,
63 
68  };
69 
70 #define ADD_SIGNALS_DECL_WRAPPER(signal_name, rtype, ...) \
71  rtype signal_name(__VA_ARGS__); \
72  using signal_name##Sig = rtype(__VA_ARGS__); \
73  boost::signals2::connection signal_name##_connect(std::function<signal_name##Sig> fn);
74 
76  ADD_SIGNALS_DECL_WRAPPER(ThreadSafeMessageBox, bool, const bilingual_str& message, const std::string& caption, unsigned int style);
77 
79  ADD_SIGNALS_DECL_WRAPPER(ThreadSafeQuestion, bool, const bilingual_str& message, const std::string& noninteractive_message, const std::string& caption, unsigned int style);
80 
82  ADD_SIGNALS_DECL_WRAPPER(InitMessage, void, const std::string& message);
83 
85  ADD_SIGNALS_DECL_WRAPPER(InitWallet, void, );
86 
88  ADD_SIGNALS_DECL_WRAPPER(NotifyNumConnectionsChanged, void, int newNumConnections);
89 
91  ADD_SIGNALS_DECL_WRAPPER(NotifyNetworkActiveChanged, void, bool networkActive);
92 
96  ADD_SIGNALS_DECL_WRAPPER(NotifyAlertChanged, void, );
97 
102  ADD_SIGNALS_DECL_WRAPPER(ShowProgress, void, const std::string& title, int nProgress, bool resume_possible);
103 
106 
108  ADD_SIGNALS_DECL_WRAPPER(NotifyHeaderTip, void, SynchronizationState, int64_t height, int64_t timestamp, bool presync);
109 
111  ADD_SIGNALS_DECL_WRAPPER(BannedListChanged, void, void);
112 };
113 
115 void InitWarning(const bilingual_str& str);
116 
118 bool InitError(const bilingual_str& str);
119 constexpr auto AbortError = InitError;
120 
122 
123 #endif // BITCOIN_NODE_INTERFACE_UI_H
static bool ThreadSafeMessageBox(BitcoinGUI *gui, const bilingual_str &message, const std::string &caption, unsigned int style)
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:152
Signals for UI communication.
Definition: interface_ui.h:25
ADD_SIGNALS_DECL_WRAPPER(BannedListChanged, void, void)
Banlist did change.
ADD_SIGNALS_DECL_WRAPPER(NotifyAlertChanged, void,)
Status bar alerts changed.
ADD_SIGNALS_DECL_WRAPPER(ThreadSafeMessageBox, bool, const bilingual_str &message, const std::string &caption, unsigned int style)
Show message box.
ADD_SIGNALS_DECL_WRAPPER(NotifyNetworkActiveChanged, void, bool networkActive)
Network activity state changed.
ADD_SIGNALS_DECL_WRAPPER(ShowProgress, void, const std::string &title, int nProgress, bool resume_possible)
Show progress e.g.
ADD_SIGNALS_DECL_WRAPPER(NotifyBlockTip, void, SynchronizationState, const CBlockIndex *)
New block has been accepted.
ADD_SIGNALS_DECL_WRAPPER(InitWallet, void,)
Wallet loader created.
ADD_SIGNALS_DECL_WRAPPER(ThreadSafeQuestion, bool, const bilingual_str &message, const std::string &noninteractive_message, const std::string &caption, unsigned int style)
If possible, ask the user a question.
ADD_SIGNALS_DECL_WRAPPER(NotifyHeaderTip, void, SynchronizationState, int64_t height, int64_t timestamp, bool presync)
Best header has changed.
MessageBoxFlags
Flags for CClientUIInterface::ThreadSafeMessageBox.
Definition: interface_ui.h:28
@ ICON_MASK
Mask of all available icons in CClientUIInterface::MessageBoxFlags This needs to be updated,...
Definition: interface_ui.h:36
@ BTN_MASK
Mask of all available buttons in CClientUIInterface::MessageBoxFlags This needs to be updated,...
Definition: interface_ui.h:55
@ BTN_OK
These values are taken from qmessagebox.h "enum StandardButton" to be directly usable.
Definition: interface_ui.h:39
@ MSG_INFORMATION
Predefined combinations for certain default usage cases.
Definition: interface_ui.h:65
@ MODAL
Force blocking, modal message box dialog (not just OS notification)
Definition: interface_ui.h:59
@ SECURE
Do not print contents of message to debug log.
Definition: interface_ui.h:62
ADD_SIGNALS_DECL_WRAPPER(InitMessage, void, const std::string &message)
Progress message during initialization.
ADD_SIGNALS_DECL_WRAPPER(NotifyNumConnectionsChanged, void, int newNumConnections)
Number of network connections changed.
CClientUIInterface uiInterface
void InitWarning(const bilingual_str &str)
Show warning message.
constexpr auto AbortError
Definition: interface_ui.h:119
bool InitError(const bilingual_str &str)
Show error message.
static void ShowProgress(SplashScreen *splash, const std::string &title, int nProgress, bool resume_possible)
static void InitMessage(SplashScreen *splash, const std::string &message)
Bilingual messages:
Definition: translation.h:18
static bool NotifyHeaderTip(Chainstate &chainstate) LOCKS_EXCLUDED(cs_main)
SynchronizationState
Current sync state passed to tip changed callbacks.
Definition: validation.h:88