CClientUIInterface Class Reference

Signals for UI communication. More...

#include <ui_interface.h>

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 Member Functions
	ADD_SIGNALS_DECL_WRAPPER (ThreadSafeMessageBox, bool, const bilingual_str &message, const std::string &caption, unsigned int style)
	Show message box.
	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 (InitMessage, void, const std::string &message)
	Progress message during initialization.
	ADD_SIGNALS_DECL_WRAPPER (NotifyNumConnectionsChanged, void, int newNumConnections)
	Number of network connections changed.
	ADD_SIGNALS_DECL_WRAPPER (NotifyNetworkActiveChanged, void, bool networkActive)
	Network activity state changed.
	ADD_SIGNALS_DECL_WRAPPER (NotifyAlertChanged, void,)
	Status bar alerts 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 (NotifyHeaderTip, void, SynchronizationState, int64_t height, int64_t timestamp, bool presync)
	Best header has changed.
	ADD_SIGNALS_DECL_WRAPPER (BannedListChanged, void, void)
	Banlist did change.

Detailed Description

Signals for UI communication.

Definition at line 24 of file ui_interface.h.

Member Enumeration Documentation

MessageBoxFlags

enum CClientUIInterface::MessageBoxFlags : uint32_t

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

Member Function Documentation

ADD_SIGNALS_DECL_WRAPPER() [1/10]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER	(	BannedListChanged	,
		void	,
		void
	)

Banlist did change.

ADD_SIGNALS_DECL_WRAPPER() [2/10]

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

Progress message during initialization.

ADD_SIGNALS_DECL_WRAPPER() [3/10]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER	(	NotifyAlertChanged	,
		void
	)

Status bar alerts changed.

ADD_SIGNALS_DECL_WRAPPER() [4/10]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER	(	NotifyBlockTip	,
		void	,
		SynchronizationState	,
		const CBlockIndex *
	)

New block has been accepted.

ADD_SIGNALS_DECL_WRAPPER() [5/10]

CClientUIInterface::ADD_SIGNALS_DECL_WRAPPER	(	NotifyHeaderTip	,
		void	,
		SynchronizationState	,
		int64_t	height,
		int64_t	timestamp,
		bool	presync
	)

Best header has changed.

ADD_SIGNALS_DECL_WRAPPER() [6/10]

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

Network activity state changed.

ADD_SIGNALS_DECL_WRAPPER() [7/10]

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

Number of network connections changed.

ADD_SIGNALS_DECL_WRAPPER() [8/10]

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/10]

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

Show message box.

ADD_SIGNALS_DECL_WRAPPER() [10/10]

CClientUIInterface::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.

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

---

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

• src/node/ui_interface.h