113 lines
4.1 KiB
C++
113 lines
4.1 KiB
C++
// Copyright (c) 2010 Satoshi Nakamoto
|
|
// Copyright (c) 2012 The Bitcoin developers
|
|
// Distributed under the MIT/X11 software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#ifndef BITCOIN_UI_INTERFACE_H
|
|
#define BITCOIN_UI_INTERFACE_H
|
|
|
|
#include <stdint.h>
|
|
#include <string>
|
|
|
|
#include <boost/signals2/last_value.hpp>
|
|
#include <boost/signals2/signal.hpp>
|
|
|
|
class CBasicKeyStore;
|
|
class CWallet;
|
|
class uint256;
|
|
|
|
/** General change type (added, updated, removed). */
|
|
enum ChangeType
|
|
{
|
|
CT_NEW,
|
|
CT_UPDATED,
|
|
CT_DELETED
|
|
};
|
|
|
|
/** Signals for UI communication. */
|
|
class CClientUIInterface
|
|
{
|
|
public:
|
|
/** Flags for CClientUIInterface::ThreadSafeMessageBox */
|
|
enum MessageBoxFlags
|
|
{
|
|
ICON_INFORMATION = 0,
|
|
ICON_WARNING = (1U << 0),
|
|
ICON_ERROR = (1U << 1),
|
|
/**
|
|
* Mask of all available icons in CClientUIInterface::MessageBoxFlags
|
|
* This needs to be updated, when icons are changed there!
|
|
*/
|
|
ICON_MASK = (ICON_INFORMATION | ICON_WARNING | ICON_ERROR),
|
|
|
|
/** These values are taken from qmessagebox.h "enum StandardButton" to be directly usable */
|
|
BTN_OK = 0x00000400U, // QMessageBox::Ok
|
|
BTN_YES = 0x00004000U, // QMessageBox::Yes
|
|
BTN_NO = 0x00010000U, // QMessageBox::No
|
|
BTN_ABORT = 0x00040000U, // QMessageBox::Abort
|
|
BTN_RETRY = 0x00080000U, // QMessageBox::Retry
|
|
BTN_IGNORE = 0x00100000U, // QMessageBox::Ignore
|
|
BTN_CLOSE = 0x00200000U, // QMessageBox::Close
|
|
BTN_CANCEL = 0x00400000U, // QMessageBox::Cancel
|
|
BTN_DISCARD = 0x00800000U, // QMessageBox::Discard
|
|
BTN_HELP = 0x01000000U, // QMessageBox::Help
|
|
BTN_APPLY = 0x02000000U, // QMessageBox::Apply
|
|
BTN_RESET = 0x04000000U, // QMessageBox::Reset
|
|
/**
|
|
* Mask of all available buttons in CClientUIInterface::MessageBoxFlags
|
|
* This needs to be updated, when buttons are changed there!
|
|
*/
|
|
BTN_MASK = (BTN_OK | BTN_YES | BTN_NO | BTN_ABORT | BTN_RETRY | BTN_IGNORE |
|
|
BTN_CLOSE | BTN_CANCEL | BTN_DISCARD | BTN_HELP | BTN_APPLY | BTN_RESET),
|
|
|
|
/** Force blocking, modal message box dialog (not just OS notification) */
|
|
MODAL = 0x10000000U,
|
|
|
|
/** Predefined combinations for certain default usage cases */
|
|
MSG_INFORMATION = ICON_INFORMATION,
|
|
MSG_WARNING = (ICON_WARNING | BTN_OK | MODAL),
|
|
MSG_ERROR = (ICON_ERROR | BTN_OK | MODAL)
|
|
};
|
|
|
|
/** Show message box. */
|
|
boost::signals2::signal<bool (const std::string& message, const std::string& caption, unsigned int style), boost::signals2::last_value<bool> > ThreadSafeMessageBox;
|
|
|
|
/** Progress message during initialization. */
|
|
boost::signals2::signal<void (const std::string &message)> InitMessage;
|
|
|
|
/** Translate a message to the native language of the user. */
|
|
boost::signals2::signal<std::string (const char* psz)> Translate;
|
|
|
|
/** Number of network connections changed. */
|
|
boost::signals2::signal<void (int newNumConnections)> NotifyNumConnectionsChanged;
|
|
|
|
/**
|
|
* New, updated or cancelled alert.
|
|
* @note called with lock cs_mapAlerts held.
|
|
*/
|
|
boost::signals2::signal<void (const uint256 &hash, ChangeType status)> NotifyAlertChanged;
|
|
|
|
/** A wallet has been loaded. */
|
|
boost::signals2::signal<void (CWallet* wallet)> LoadWallet;
|
|
|
|
/** Show progress e.g. for verifychain */
|
|
boost::signals2::signal<void (const std::string &title, int nProgress)> ShowProgress;
|
|
|
|
/** New block has been accepted */
|
|
boost::signals2::signal<void (const uint256& hash)> NotifyBlockTip;
|
|
};
|
|
|
|
extern CClientUIInterface uiInterface;
|
|
|
|
/**
|
|
* Translation function: Call Translate signal on UI interface, which returns a boost::optional result.
|
|
* If no translation slot is registered, nothing is returned, and simply return the input.
|
|
*/
|
|
inline std::string _(const char* psz)
|
|
{
|
|
boost::optional<std::string> rv = uiInterface.Translate(psz);
|
|
return rv ? (*rv) : psz;
|
|
}
|
|
|
|
#endif // BITCOIN_UI_INTERFACE_H
|