Dash Core Source Documentation (0.16.0.1)

Find detailed information regarding the Dash Core source code.

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, 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

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

Detailed Description

Signals for UI communication.

Definition at line 28 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)

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 32 of file ui_interface.h.

Member Data Documentation

◆ BannedListChanged

boost::signals2::signal<void (void)> CClientUIInterface::BannedListChanged

◆ InitMessage

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

◆ LoadWallet

boost::signals2::signal<void (CWallet* wallet)> CClientUIInterface::LoadWallet

◆ NotifyAdditionalDataSyncProgressChanged

boost::signals2::signal<void (double nSyncProgress)> CClientUIInterface::NotifyAdditionalDataSyncProgressChanged

◆ NotifyAlertChanged

boost::signals2::signal<void ()> CClientUIInterface::NotifyAlertChanged

Status bar alerts changed.

Definition at line 93 of file ui_interface.h.

Referenced by AlertNotify(), ClientModel::subscribeToCoreSignals(), and ClientModel::unsubscribeFromCoreSignals().

◆ NotifyBlockTip

boost::signals2::signal<void (bool, const CBlockIndex *)> CClientUIInterface::NotifyBlockTip

◆ NotifyHeaderTip

boost::signals2::signal<void (bool, const CBlockIndex *)> CClientUIInterface::NotifyHeaderTip

Best header has changed.

Definition at line 108 of file ui_interface.h.

Referenced by NotifyHeaderTip(), ClientModel::subscribeToCoreSignals(), and ClientModel::unsubscribeFromCoreSignals().

◆ NotifyMasternodeListChanged

boost::signals2::signal<void (const CDeterministicMNList&)> CClientUIInterface::NotifyMasternodeListChanged

◆ NotifyNetworkActiveChanged

boost::signals2::signal<void (bool networkActive)> CClientUIInterface::NotifyNetworkActiveChanged

Network activity state changed.

Definition at line 88 of file ui_interface.h.

Referenced by CConnman::SetNetworkActive(), ClientModel::subscribeToCoreSignals(), and ClientModel::unsubscribeFromCoreSignals().

◆ NotifyNumConnectionsChanged

boost::signals2::signal<void (int newNumConnections)> CClientUIInterface::NotifyNumConnectionsChanged

Number of network connections changed.

Definition at line 85 of file ui_interface.h.

Referenced by CConnman::NotifyNumConnectionsChanged(), ClientModel::subscribeToCoreSignals(), and ClientModel::unsubscribeFromCoreSignals().

◆ ShowProgress

boost::signals2::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 102 of file ui_interface.h.

Referenced by CVerifyDB::CVerifyDB(), CChainState::ReplayBlocks(), SplashScreen::subscribeToCoreSignals(), ClientModel::subscribeToCoreSignals(), SplashScreen::unsubscribeFromCoreSignals(), ClientModel::unsubscribeFromCoreSignals(), CCoinsViewDB::Upgrade(), CVerifyDB::VerifyDB(), and CVerifyDB::~CVerifyDB().

◆ ThreadSafeMessageBox

boost::signals2::signal<bool (const std::string& message, const std::string& caption, unsigned int style), boost::signals2::last_value<bool> > CClientUIInterface::ThreadSafeMessageBox

◆ ThreadSafeQuestion

boost::signals2::signal<bool (const std::string& message, const std::string& noninteractive_message, const std::string& caption, unsigned int style), boost::signals2::last_value<bool> > CClientUIInterface::ThreadSafeQuestion

If possible, ask the user a question.

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

Definition at line 79 of file ui_interface.h.

Referenced by AppInitMain(), noui_connect(), BitcoinGUI::subscribeToCoreSignals(), and BitcoinGUI::unsubscribeFromCoreSignals().


The documentation for this class was generated from the following file:
Released under the MIT license