Bitcoin Core 31.99.0
P2P Digital Currency
Public Types | Public Attributes | List of all members
CClientUIInterface Class Reference

Signals for UI communication. More...

#include <interface_ui.h>

Collaboration diagram for CClientUIInterface:
[legend]

Public Types

enum  MessageBoxFlags : uint32_t {
  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 , 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 Attributes

btcsignals::signal< void(const bilingual_str &message, unsigned int style)> ThreadSafeMessageBox
 Show message box. More...
 
btcsignals::signal< bool(const bilingual_str &message, const std::string &noninteractive_message, unsigned int style), btcsignals::any_ofThreadSafeQuestion
 If possible, ask the user a question. More...
 
btcsignals::signal< void(const std::string &message)> InitMessage
 Progress message during initialization. More...
 
btcsignals::signal< void()> InitWallet
 Wallet loader created. More...
 
btcsignals::signal< void(int newNumConnections)> NotifyNumConnectionsChanged
 Number of network connections changed. More...
 
btcsignals::signal< void(bool networkActive)> NotifyNetworkActiveChanged
 Network activity state changed. More...
 
btcsignals::signal< void()> NotifyAlertChanged
 Status bar alerts changed. More...
 
btcsignals::signal< void(const std::string &title, int nProgress, bool resume_possible)> ShowProgress
 Show progress e.g. More...
 
btcsignals::signal< void(SynchronizationState, const CBlockIndex &block, double verification_progress)> NotifyBlockTip
 New block has been accepted. More...
 
btcsignals::signal< void(SynchronizationState, int64_t height, int64_t timestamp, bool presync)> NotifyHeaderTip
 Best header has changed. More...
 
btcsignals::signal< void(void)> BannedListChanged
 Banlist did change. More...
 

Detailed Description

Signals for UI communication.

Definition at line 21 of file interface_ui.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)

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 25 of file interface_ui.h.

Member Data Documentation

◆ BannedListChanged

btcsignals::signal<void(void)> CClientUIInterface::BannedListChanged

Banlist did change.

Definition at line 103 of file interface_ui.h.

◆ InitMessage

btcsignals::signal<void(const std::string& message)> CClientUIInterface::InitMessage

Progress message during initialization.

Definition at line 74 of file interface_ui.h.

◆ InitWallet

btcsignals::signal<void()> CClientUIInterface::InitWallet

Wallet loader created.

Definition at line 77 of file interface_ui.h.

◆ NotifyAlertChanged

btcsignals::signal<void()> CClientUIInterface::NotifyAlertChanged

Status bar alerts changed.

Definition at line 88 of file interface_ui.h.

◆ NotifyBlockTip

btcsignals::signal<void(SynchronizationState, const CBlockIndex& block, double verification_progress)> CClientUIInterface::NotifyBlockTip

New block has been accepted.

Definition at line 97 of file interface_ui.h.

◆ NotifyHeaderTip

btcsignals::signal<void(SynchronizationState, int64_t height, int64_t timestamp, bool presync)> CClientUIInterface::NotifyHeaderTip

Best header has changed.

Definition at line 100 of file interface_ui.h.

◆ NotifyNetworkActiveChanged

btcsignals::signal<void(bool networkActive)> CClientUIInterface::NotifyNetworkActiveChanged

Network activity state changed.

Definition at line 83 of file interface_ui.h.

◆ NotifyNumConnectionsChanged

btcsignals::signal<void(int newNumConnections)> CClientUIInterface::NotifyNumConnectionsChanged

Number of network connections changed.

Definition at line 80 of file interface_ui.h.

◆ ShowProgress

btcsignals::signal<void(const std::string& title, int nProgress, bool resume_possible)> CClientUIInterface::ShowProgress

Show progress e.g.

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

Definition at line 94 of file interface_ui.h.

◆ ThreadSafeMessageBox

btcsignals::signal<void(const bilingual_str& message, unsigned int style)> CClientUIInterface::ThreadSafeMessageBox

Show message box.

Definition at line 68 of file interface_ui.h.

◆ ThreadSafeQuestion

btcsignals::signal<bool(const bilingual_str& message, const std::string& noninteractive_message, unsigned int style), btcsignals::any_of> CClientUIInterface::ThreadSafeQuestion

If possible, ask the user a question.

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

Definition at line 71 of file interface_ui.h.


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