be301a5777
0e534d4dca Fix incorrect Doxygen comments (practicalswift)
Pull request description:
Fix broken Doxygen comments.
This commit was taken from #13914 which now only covers `-Wdocumentation`.
Tree-SHA512: dddbca16bb792b8193e5f417151b5eace9acc942a321f1bc095b906e98889e3bd93509fe112ab6a24ee1f6a3a918db905bda7acefd53774fe3e6ebe669fb51ac
312 lines
10 KiB
C++
312 lines
10 KiB
C++
// Copyright (c) 2011-2018 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_QT_BITCOINGUI_H
|
|
#define BITCOIN_QT_BITCOINGUI_H
|
|
|
|
#if defined(HAVE_CONFIG_H)
|
|
#include <config/bitcoin-config.h>
|
|
#endif
|
|
|
|
#include <qt/optionsdialog.h>
|
|
|
|
#include <amount.h>
|
|
|
|
#include <QLabel>
|
|
#include <QMainWindow>
|
|
#include <QMap>
|
|
#include <QMenu>
|
|
#include <QPoint>
|
|
#include <QSystemTrayIcon>
|
|
|
|
#include <memory>
|
|
|
|
class ClientModel;
|
|
class NetworkStyle;
|
|
class Notificator;
|
|
class OptionsModel;
|
|
class PlatformStyle;
|
|
class RPCConsole;
|
|
class SendCoinsRecipient;
|
|
class UnitDisplayStatusBarControl;
|
|
class WalletFrame;
|
|
class WalletModel;
|
|
class HelpMessageDialog;
|
|
class ModalOverlay;
|
|
|
|
namespace interfaces {
|
|
class Handler;
|
|
class Node;
|
|
}
|
|
|
|
QT_BEGIN_NAMESPACE
|
|
class QAction;
|
|
class QComboBox;
|
|
class QProgressBar;
|
|
class QProgressDialog;
|
|
QT_END_NAMESPACE
|
|
|
|
namespace GUIUtil {
|
|
class ClickableLabel;
|
|
class ClickableProgressBar;
|
|
}
|
|
|
|
/**
|
|
Bitcoin GUI main class. This class represents the main window of the Bitcoin UI. It communicates with both the client and
|
|
wallet models to give the user an up-to-date view of the current core state.
|
|
*/
|
|
class BitcoinGUI : public QMainWindow
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
static const std::string DEFAULT_UIPLATFORM;
|
|
|
|
explicit BitcoinGUI(interfaces::Node& node, const PlatformStyle *platformStyle, const NetworkStyle *networkStyle, QWidget *parent = 0);
|
|
~BitcoinGUI();
|
|
|
|
/** Set the client model.
|
|
The client model represents the part of the core that communicates with the P2P network, and is wallet-agnostic.
|
|
*/
|
|
void setClientModel(ClientModel *clientModel);
|
|
|
|
#ifdef ENABLE_WALLET
|
|
/** Set the wallet model.
|
|
The wallet model represents a bitcoin wallet, and offers access to the list of transactions, address book and sending
|
|
functionality.
|
|
*/
|
|
bool addWallet(WalletModel *walletModel);
|
|
bool removeWallet(WalletModel* walletModel);
|
|
void removeAllWallets();
|
|
#endif // ENABLE_WALLET
|
|
bool enableWallet = false;
|
|
|
|
protected:
|
|
void changeEvent(QEvent *e);
|
|
void closeEvent(QCloseEvent *event);
|
|
void showEvent(QShowEvent *event);
|
|
void dragEnterEvent(QDragEnterEvent *event);
|
|
void dropEvent(QDropEvent *event);
|
|
bool eventFilter(QObject *object, QEvent *event);
|
|
|
|
private:
|
|
interfaces::Node& m_node;
|
|
std::unique_ptr<interfaces::Handler> m_handler_message_box;
|
|
std::unique_ptr<interfaces::Handler> m_handler_question;
|
|
ClientModel* clientModel = nullptr;
|
|
WalletFrame* walletFrame = nullptr;
|
|
|
|
UnitDisplayStatusBarControl* unitDisplayControl = nullptr;
|
|
QLabel* labelWalletEncryptionIcon = nullptr;
|
|
QLabel* labelWalletHDStatusIcon = nullptr;
|
|
GUIUtil::ClickableLabel* labelProxyIcon = nullptr;
|
|
GUIUtil::ClickableLabel* connectionsControl = nullptr;
|
|
GUIUtil::ClickableLabel* labelBlocksIcon = nullptr;
|
|
QLabel* progressBarLabel = nullptr;
|
|
GUIUtil::ClickableProgressBar* progressBar = nullptr;
|
|
QProgressDialog* progressDialog = nullptr;
|
|
|
|
QMenuBar* appMenuBar = nullptr;
|
|
QToolBar* appToolBar = nullptr;
|
|
QAction* overviewAction = nullptr;
|
|
QAction* historyAction = nullptr;
|
|
QAction* quitAction = nullptr;
|
|
QAction* sendCoinsAction = nullptr;
|
|
QAction* sendCoinsMenuAction = nullptr;
|
|
QAction* usedSendingAddressesAction = nullptr;
|
|
QAction* usedReceivingAddressesAction = nullptr;
|
|
QAction* signMessageAction = nullptr;
|
|
QAction* verifyMessageAction = nullptr;
|
|
QAction* aboutAction = nullptr;
|
|
QAction* receiveCoinsAction = nullptr;
|
|
QAction* receiveCoinsMenuAction = nullptr;
|
|
QAction* optionsAction = nullptr;
|
|
QAction* toggleHideAction = nullptr;
|
|
QAction* encryptWalletAction = nullptr;
|
|
QAction* backupWalletAction = nullptr;
|
|
QAction* changePassphraseAction = nullptr;
|
|
QAction* aboutQtAction = nullptr;
|
|
QAction* openRPCConsoleAction = nullptr;
|
|
QAction* openAction = nullptr;
|
|
QAction* showHelpMessageAction = nullptr;
|
|
QAction* m_wallet_selector_label_action = nullptr;
|
|
QAction* m_wallet_selector_action = nullptr;
|
|
|
|
QLabel *m_wallet_selector_label = nullptr;
|
|
QComboBox* m_wallet_selector = nullptr;
|
|
|
|
QSystemTrayIcon* trayIcon = nullptr;
|
|
QMenu* trayIconMenu = nullptr;
|
|
Notificator* notificator = nullptr;
|
|
RPCConsole* rpcConsole = nullptr;
|
|
HelpMessageDialog* helpMessageDialog = nullptr;
|
|
ModalOverlay* modalOverlay = nullptr;
|
|
|
|
/** Keep track of previous number of blocks, to detect progress */
|
|
int prevBlocks = 0;
|
|
int spinnerFrame = 0;
|
|
|
|
const PlatformStyle *platformStyle;
|
|
|
|
/** Create the main UI actions. */
|
|
void createActions();
|
|
/** Create the menu bar and sub-menus. */
|
|
void createMenuBar();
|
|
/** Create the toolbars */
|
|
void createToolBars();
|
|
/** Create system tray icon and notification */
|
|
void createTrayIcon(const NetworkStyle *networkStyle);
|
|
/** Create system tray menu (or setup the dock menu) */
|
|
void createTrayIconMenu();
|
|
|
|
/** Enable or disable all wallet-related actions */
|
|
void setWalletActionsEnabled(bool enabled);
|
|
|
|
/** Connect core signals to GUI client */
|
|
void subscribeToCoreSignals();
|
|
/** Disconnect core signals from GUI client */
|
|
void unsubscribeFromCoreSignals();
|
|
|
|
/** Update UI with latest network info from model. */
|
|
void updateNetworkState();
|
|
|
|
void updateHeadersSyncProgressLabel();
|
|
|
|
/** Open the OptionsDialog on the specified tab index */
|
|
void openOptionsDialogWithTab(OptionsDialog::Tab tab);
|
|
|
|
Q_SIGNALS:
|
|
/** Signal raised when a URI was entered or dragged to the GUI */
|
|
void receivedURI(const QString &uri);
|
|
|
|
public Q_SLOTS:
|
|
/** Set number of connections shown in the UI */
|
|
void setNumConnections(int count);
|
|
/** Set network state shown in the UI */
|
|
void setNetworkActive(bool networkActive);
|
|
/** Set number of blocks and last block date shown in the UI */
|
|
void setNumBlocks(int count, const QDateTime& blockDate, double nVerificationProgress, bool headers);
|
|
|
|
/** Notify the user of an event from the core network or transaction handling code.
|
|
@param[in] title the message box / notification title
|
|
@param[in] message the displayed text
|
|
@param[in] style modality and style definitions (icon and used buttons - buttons only for message boxes)
|
|
@see CClientUIInterface::MessageBoxFlags
|
|
@param[in] ret pointer to a bool that will be modified to whether Ok was clicked (modal only)
|
|
*/
|
|
void message(const QString &title, const QString &message, unsigned int style, bool *ret = nullptr);
|
|
|
|
#ifdef ENABLE_WALLET
|
|
bool setCurrentWallet(const QString& name);
|
|
bool setCurrentWalletBySelectorIndex(int index);
|
|
/** Set the UI status indicators based on the currently selected wallet.
|
|
*/
|
|
void updateWalletStatus();
|
|
|
|
private:
|
|
/** Set the encryption status as shown in the UI.
|
|
@param[in] status current encryption status
|
|
@see WalletModel::EncryptionStatus
|
|
*/
|
|
void setEncryptionStatus(int status);
|
|
|
|
/** Set the hd-enabled status as shown in the UI.
|
|
@param[in] hdEnabled current hd enabled status
|
|
@see WalletModel::EncryptionStatus
|
|
*/
|
|
void setHDStatus(int hdEnabled);
|
|
|
|
public Q_SLOTS:
|
|
bool handlePaymentRequest(const SendCoinsRecipient& recipient);
|
|
|
|
/** Show incoming transaction notification for new transactions. */
|
|
void incomingTransaction(const QString& date, int unit, const CAmount& amount, const QString& type, const QString& address, const QString& label, const QString& walletName);
|
|
#endif // ENABLE_WALLET
|
|
|
|
private:
|
|
/** Set the proxy-enabled icon as shown in the UI. */
|
|
void updateProxyIcon();
|
|
|
|
public Q_SLOTS:
|
|
#ifdef ENABLE_WALLET
|
|
/** Switch to overview (home) page */
|
|
void gotoOverviewPage();
|
|
/** Switch to history (transactions) page */
|
|
void gotoHistoryPage();
|
|
/** Switch to receive coins page */
|
|
void gotoReceiveCoinsPage();
|
|
/** Switch to send coins page */
|
|
void gotoSendCoinsPage(QString addr = "");
|
|
|
|
/** Show Sign/Verify Message dialog and switch to sign message tab */
|
|
void gotoSignMessageTab(QString addr = "");
|
|
/** Show Sign/Verify Message dialog and switch to verify message tab */
|
|
void gotoVerifyMessageTab(QString addr = "");
|
|
|
|
/** Show open dialog */
|
|
void openClicked();
|
|
#endif // ENABLE_WALLET
|
|
/** Show configuration dialog */
|
|
void optionsClicked();
|
|
/** Show about dialog */
|
|
void aboutClicked();
|
|
/** Show debug window */
|
|
void showDebugWindow();
|
|
/** Show debug window and set focus to the console */
|
|
void showDebugWindowActivateConsole();
|
|
/** Show help message dialog */
|
|
void showHelpMessageClicked();
|
|
#ifndef Q_OS_MAC
|
|
/** Handle tray icon clicked */
|
|
void trayIconActivated(QSystemTrayIcon::ActivationReason reason);
|
|
#endif
|
|
|
|
/** Show window if hidden, unminimize when minimized, rise when obscured or show if hidden and fToggleHidden is true */
|
|
void showNormalIfMinimized() { showNormalIfMinimized(false); }
|
|
void showNormalIfMinimized(bool fToggleHidden);
|
|
/** Simply calls showNormalIfMinimized(true) for use in SLOT() macro */
|
|
void toggleHidden();
|
|
|
|
/** called by a timer to check if ShutdownRequested() has been set **/
|
|
void detectShutdown();
|
|
|
|
/** Show progress dialog e.g. for verifychain */
|
|
void showProgress(const QString &title, int nProgress);
|
|
|
|
/** When hideTrayIcon setting is changed in OptionsModel hide or show the icon accordingly. */
|
|
void setTrayIconVisible(bool);
|
|
|
|
void showModalOverlay();
|
|
};
|
|
|
|
class UnitDisplayStatusBarControl : public QLabel
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
explicit UnitDisplayStatusBarControl(const PlatformStyle *platformStyle);
|
|
/** Lets the control know about the Options Model (and its signals) */
|
|
void setOptionsModel(OptionsModel *optionsModel);
|
|
|
|
protected:
|
|
/** So that it responds to left-button clicks */
|
|
void mousePressEvent(QMouseEvent *event);
|
|
|
|
private:
|
|
OptionsModel *optionsModel;
|
|
QMenu* menu;
|
|
|
|
/** Shows context menu with Display Unit options by the mouse coordinates */
|
|
void onDisplayUnitsClicked(const QPoint& point);
|
|
/** Creates context menu, its actions, and wires up all the relevant signals for mouse events. */
|
|
void createContextMenu();
|
|
|
|
private Q_SLOTS:
|
|
/** When Display Units are changed on OptionsModel it will refresh the display text of the control on the status bar */
|
|
void updateDisplayUnit(int newUnits);
|
|
/** Tells underlying optionsModel to update its current display unit. */
|
|
void onMenuSelection(QAction* action);
|
|
};
|
|
|
|
#endif // BITCOIN_QT_BITCOINGUI_H
|