ui_interface.h

Go to the documentation of this file.

// Copyright (c) 2010 Satoshi Nakamoto
// Copyright (c) 2012-2016 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#ifndef BITCOIN_NODE_UI_INTERFACE_H
#define BITCOIN_NODE_UI_INTERFACE_H

#include <functional>
#include <memory>
#include <string>

class CBlockIndex;
enum class SynchronizationState;
struct bilingual_str;

namespace boost {
namespace signals2 {
    class connection;
}
} // namespace boost

class CClientUIInterface {
public:
    enum MessageBoxFlags {
        ICON_INFORMATION = 0,
        ICON_WARNING = (1U << 0),
        ICON_ERROR = (1U << 1),
        ICON_MASK = (ICON_INFORMATION | ICON_WARNING | ICON_ERROR),

        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

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

        MODAL = 0x10000000U,

        SECURE = 0x40000000U,

        MSG_INFORMATION = ICON_INFORMATION,
        MSG_WARNING = (ICON_WARNING | BTN_OK | MODAL),
        MSG_ERROR = (ICON_ERROR | BTN_OK | MODAL)
    };

#define ADD_SIGNALS_DECL_WRAPPER(signal_name, rtype, args...)                  \
    rtype signal_name(args);                                                   \
    using signal_name##Sig = rtype(args);                                      \
    boost::signals2::connection signal_name##_connect(                         \
        std::function<signal_name##Sig> fn);

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

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

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

    ADD_SIGNALS_DECL_WRAPPER(NotifyNumConnectionsChanged, void,
                             int newNumConnections);

    ADD_SIGNALS_DECL_WRAPPER(NotifyNetworkActiveChanged, void,
                             bool networkActive);

    ADD_SIGNALS_DECL_WRAPPER(NotifyAlertChanged, void, );

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

    ADD_SIGNALS_DECL_WRAPPER(NotifyBlockTip, void, SynchronizationState,
                             const CBlockIndex *);

    ADD_SIGNALS_DECL_WRAPPER(NotifyHeaderTip, void, SynchronizationState,
                             const CBlockIndex *);

    ADD_SIGNALS_DECL_WRAPPER(BannedListChanged, void, void);
};

void InitWarning(const bilingual_str &str);

bool InitError(const bilingual_str &str);
constexpr auto AbortError = InitError;

extern CClientUIInterface uiInterface;

#endif // BITCOIN_NODE_UI_INTERFACE_H