Bitcoin Core  0.18.99
P2P Digital Currency
Public Types | Public Member Functions | List of all members
CClientUIInterface Class Reference

Signals for UI communication. More...

#include <ui_interface.h>

Public Types

enum  MessageBoxFlags {
  ICON_INFORMATION = 0, ICON_WARNING = (1U << 0), ICON_ERROR = (1U << 1), ICON_MASK = (ICON_INFORMATION | ICON_WARNING | ICON_ERROR),
  BTN_OK = 0x00000400U, BTN_YES = 0x00004000U, BTN_NO = 0x00010000U, BTN_ABORT = 0x00040000U,
  BTN_RETRY = 0x00080000U, BTN_IGNORE = 0x00100000U, BTN_CLOSE = 0x00200000U, BTN_CANCEL = 0x00400000U,
  BTN_DISCARD = 0x00800000U, BTN_HELP = 0x01000000U, BTN_APPLY = 0x02000000U, BTN_RESET = 0x04000000U,
  BTN_MASK, MODAL = 0x10000000U, MSG_NOPREFIX = 0x20000000U, SECURE = 0x40000000U,
  MSG_INFORMATION = ICON_INFORMATION, MSG_WARNING = (ICON_WARNING | BTN_OK | MODAL), MSG_ERROR = (ICON_ERROR | BTN_OK | MODAL)
}
 Flags for CClientUIInterface::ThreadSafeMessageBox. More...
 

Public Member Functions

 ADD_SIGNALS_DECL_WRAPPER (ThreadSafeMessageBox, bool, const std::string &message, const std::string &caption, unsigned int style)
 Show message box. More...
 
 ADD_SIGNALS_DECL_WRAPPER (ThreadSafeQuestion, bool, const std::string &message, const std::string &noninteractive_message, const std::string &caption, unsigned int style)
 If possible, ask the user a question. More...
 
 ADD_SIGNALS_DECL_WRAPPER (InitMessage, void, const std::string &message)
 Progress message during initialization. More...
 
 ADD_SIGNALS_DECL_WRAPPER (NotifyNumConnectionsChanged, void, int newNumConnections)
 Number of network connections changed. More...
 
 ADD_SIGNALS_DECL_WRAPPER (NotifyNetworkActiveChanged, void, bool networkActive)
 Network activity state changed. More...
 
 ADD_SIGNALS_DECL_WRAPPER (NotifyAlertChanged, void,)
 Status bar alerts changed. More...
 
 ADD_SIGNALS_DECL_WRAPPER (LoadWallet, void, std::unique_ptr< interfaces::Wallet > &wallet)
 A wallet has been loaded. More...
 
 ADD_SIGNALS_DECL_WRAPPER (ShowProgress, void, const std::string &title, int nProgress, bool resume_possible)
 Show progress e.g. More...
 
 ADD_SIGNALS_DECL_WRAPPER (NotifyBlockTip, void, bool, const CBlockIndex *)
 New block has been accepted. More...
 
 ADD_SIGNALS_DECL_WRAPPER (NotifyHeaderTip, void, bool, const CBlockIndex *)
 Best header has changed. More...
 
 ADD_SIGNALS_DECL_WRAPPER (BannedListChanged, void, void)
 Banlist did change. More...
 

Detailed Description

Signals for UI communication.

Definition at line 34 of file ui_interface.h.

Member Enumeration Documentation

◆ MessageBoxFlags

Flags for CClientUIInterface::ThreadSafeMessageBox.

Enumerator
ICON_INFORMATION 
ICON_WARNING 
ICON_ERROR 
ICON_MASK 

Mask of all available icons in CClientUIInterface::MessageBoxFlags This needs to be updated, when icons are changed there!

BTN_OK 

These values are taken from qmessagebox.h "enum StandardButton" to be directly usable.

BTN_YES 
BTN_NO 
BTN_ABORT 
BTN_RETRY 
BTN_IGNORE 
BTN_CLOSE 
BTN_CANCEL 
BTN_DISCARD 
BTN_HELP 
BTN_APPLY 
BTN_RESET 
BTN_MASK 

Mask of all available buttons in CClientUIInterface::MessageBoxFlags This needs to be updated, when buttons are changed there!

MODAL 

Force blocking, modal message box dialog (not just OS notification)

MSG_NOPREFIX 

Do not prepend error/warning prefix.

SECURE 

Do not print contents of message to debug log.

MSG_INFORMATION 

Predefined combinations for certain default usage cases.

MSG_WARNING 
MSG_ERROR 

Definition at line 38 of file ui_interface.h.

Member Function Documentation

◆ ADD_SIGNALS_DECL_WRAPPER() [1/11]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER ( ThreadSafeMessageBox  ,
bool  ,
const std::string &  message,
const std::string &  caption,
unsigned int  style 
)

Show message box.

◆ ADD_SIGNALS_DECL_WRAPPER() [2/11]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER ( ThreadSafeQuestion  ,
bool  ,
const std::string &  message,
const std::string &  noninteractive_message,
const std::string &  caption,
unsigned int  style 
)

If possible, ask the user a question.

If not, falls back to ThreadSafeMessageBox(noninteractive_message, caption, style) and returns false.

◆ ADD_SIGNALS_DECL_WRAPPER() [3/11]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER ( InitMessage  ,
void  ,
const std::string &  message 
)

Progress message during initialization.

◆ ADD_SIGNALS_DECL_WRAPPER() [4/11]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER ( NotifyNumConnectionsChanged  ,
void  ,
int  newNumConnections 
)

Number of network connections changed.

◆ ADD_SIGNALS_DECL_WRAPPER() [5/11]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER ( NotifyNetworkActiveChanged  ,
void  ,
bool  networkActive 
)

Network activity state changed.

◆ ADD_SIGNALS_DECL_WRAPPER() [6/11]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER ( NotifyAlertChanged  ,
void   
)

Status bar alerts changed.

◆ ADD_SIGNALS_DECL_WRAPPER() [7/11]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER ( LoadWallet  ,
void  ,
std::unique_ptr< interfaces::Wallet > &  wallet 
)

A wallet has been loaded.

◆ ADD_SIGNALS_DECL_WRAPPER() [8/11]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER ( ShowProgress  ,
void  ,
const std::string &  title,
int  nProgress,
bool  resume_possible 
)

Show progress e.g.

for verifychain. resume_possible indicates shutting down now will result in the current progress action resuming upon restart.

◆ ADD_SIGNALS_DECL_WRAPPER() [9/11]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER ( NotifyBlockTip  ,
void  ,
bool  ,
const CBlockIndex  
)

New block has been accepted.

◆ ADD_SIGNALS_DECL_WRAPPER() [10/11]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER ( NotifyHeaderTip  ,
void  ,
bool  ,
const CBlockIndex  
)

Best header has changed.

◆ ADD_SIGNALS_DECL_WRAPPER() [11/11]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER ( BannedListChanged  ,
void  ,
void   
)

Banlist did change.


The documentation for this class was generated from the following file: