0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-02-03 09:56:38 -05:00
bitcoin-bitcoin-core/src/qt
W. J. van der Laan 36aee0f353
Merge bitcoin-core/gui#381: refactor: Make BitcoinCore class reusable
8169fc4e73 qt, refactor: Fix code styling of moved InitExecutor class (Hennadii Stepanov)
c82165a557 qt, refactor: Move InitExecutor class into its own module (Hennadii Stepanov)
dbcf56b6c6 scripted-diff: Rename BitcoinCore class to InitExecutor (Hennadii Stepanov)
19a1d00831 qt: Add BitcoinCore::m_thread member (Hennadii Stepanov)

Pull request description:

  This PR makes the `BitcoinCore` class reusable, i.e., it can be used by the widget-based GUI or by the [QML-based](https://github.com/bitcoin-core/gui-qml/tree/main/src/qml) one, and it makes the divergence between these two repos minimal.

  The small benefit to the current branch is more structured code.

  Actually, this PR is ported from https://github.com/bitcoin-core/gui-qml/pull/10.
  The example of the re-using of the `BitcoinCore` class is https://github.com/bitcoin-core/gui-qml/pull/11.

ACKs for top commit:
  laanwj:
    ACK 8169fc4e73
  ryanofsky:
    Code review ACK 8169fc4e73. Only change is switching from `m_executor` from pointer to optional type (thanks for update!)

Tree-SHA512: a0552c32d26d9acf42921eb12bcdf68f02d52f7183c688c43257b1a58679f64e45f193ee2d316850c7f0f516561e17abe989fe545bfa05e158ad3f4c66d19bca
2021-07-22 10:02:10 +02:00
..
android Add src/qt/android/.gitignore 2021-05-26 23:29:19 +03:00
forms Merge bitcoin-core/gui#4: UI external signer support (e.g. hardware wallet) 2021-06-09 18:59:59 +12:00
locale Translations update 2021-07-01 17:16:14 +03:00
res gui: Add Roboto Mono font 2021-02-21 21:01:02 +02:00
test qt, refactor: Move InitExecutor class into its own module 2021-07-14 21:54:32 +03:00
addressbookpage.cpp GUI: Add keyboard shortcuts for other context menus 2021-06-12 19:39:38 +00:00
addressbookpage.h qt, refactor: Make AddressBookPage::deleteAction a local variable 2021-04-14 18:47:30 +03:00
addresstablemodel.cpp qt, refactor: Use enum type as switch argument in AddressTableModel 2021-02-22 09:34:17 +02:00
addresstablemodel.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
askpassphrasedialog.cpp Merge bitcoin-core/gui#85: Remove unused "What's This" button in dialogs on Windows OS 2021-01-28 10:16:55 +01:00
askpassphrasedialog.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
bantablemodel.cpp qt, refactor: Use enum type as switch argument in BanTableModel 2021-02-22 09:34:27 +02:00
bantablemodel.h refactor: Use override for non-final overriders 2020-05-08 10:36:58 +03:00
bitcoin.cpp qt, refactor: Move InitExecutor class into its own module 2021-07-14 21:54:32 +03:00
bitcoin.h qt, refactor: Move InitExecutor class into its own module 2021-07-14 21:54:32 +03:00
bitcoin.qrc gui: Add Roboto Mono font 2021-02-21 21:01:02 +02:00
bitcoin_locale.qrc qt: Pre-splitoff translations update 2020-10-27 19:40:44 +01:00
bitcoinaddressvalidator.cpp
bitcoinaddressvalidator.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
bitcoinamountfield.cpp qt: Use template function qOverload in signal-slot connections 2021-04-30 00:00:44 +03:00
bitcoinamountfield.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
bitcoingui.cpp GUI: Always call parent changeEvent handler 2021-06-22 19:24:44 +00:00
bitcoingui.h Merge bitcoin-core/gui#309: Add access to the Peers tab from the network icon 2021-05-31 19:37:44 +03:00
bitcoinstrings.cpp Translations update 2021-07-01 17:16:14 +03:00
bitcoinunits.cpp scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
bitcoinunits.h scripted-diff: Make SeparatorStyle a scoped enum 2020-06-18 15:30:15 +03:00
clientmodel.cpp scripted-diff: Replace GetDataDir() calls with gArgs.GetDataDirNet() calls 2021-05-24 10:29:58 +02:00
clientmodel.h qt: Use PeerTableSortProxy for sorting peer table 2021-03-07 16:57:17 +02:00
coincontroldialog.cpp GUI: Always call parent changeEvent handler 2021-06-22 19:24:44 +00:00
coincontroldialog.h qt: Make CoinControlDialog aware of runtime palette change 2021-05-01 15:07:11 +03:00
coincontroltreewidget.cpp
coincontroltreewidget.h refactor: Use override for non-final overriders 2020-05-08 10:36:58 +03:00
createwalletdialog.cpp gui: misc external signer fixes and translation hints 2021-06-16 10:48:58 +02:00
createwalletdialog.h gui: misc external signer fixes and translation hints 2021-06-16 10:48:58 +02:00
csvmodelwriter.cpp
csvmodelwriter.h scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
editaddressdialog.cpp Merge bitcoin-core/gui#85: Remove unused "What's This" button in dialogs on Windows OS 2021-01-28 10:16:55 +01:00
editaddressdialog.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
guiconstants.h qt: update QT to support signet network 2020-09-18 09:37:57 +09:00
guiutil.cpp GUI: Always call parent changeEvent handler 2021-06-22 19:24:44 +00:00
guiutil.h Merge bitcoin-core/gui#275: Support runtime appearance adjustment on macOS 2021-05-28 18:07:44 +03:00
initexecutor.cpp qt, refactor: Fix code styling of moved InitExecutor class 2021-07-14 21:54:32 +03:00
initexecutor.h qt, refactor: Fix code styling of moved InitExecutor class 2021-07-14 21:54:32 +03:00
intro.cpp qt: Replace disambiguation strings with translator comments 2021-05-16 01:06:22 +03:00
intro.h scripted-diff: Replace GetDataDir() calls with gArgs.GetDataDirNet() calls 2021-05-24 10:29:58 +02:00
macdockiconhandler.h
macdockiconhandler.mm
macnotificationhandler.h
macnotificationhandler.mm scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
macos_appnap.h
macos_appnap.mm
main.cpp scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
Makefile Qt: add Android packaging support 2021-03-21 22:33:27 +01:00
modaloverlay.cpp scripted-diff: Replace three dots with ellipsis in the UI strings 2021-05-02 22:17:16 +03:00
modaloverlay.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
networkstyle.cpp refactor: iterate arrays via C++11 range-based for loops if idx is not needed 2021-01-31 17:07:46 +01:00
networkstyle.h scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
notificator.cpp doc: Use https URLs where possible 2021-01-04 12:23:16 +08:00
notificator.h
openuridialog.cpp scripted-diff: Remove unused "What's This" button in dialogs on Windows 2020-09-07 19:09:33 +03:00
openuridialog.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
optionsdialog.cpp gui: misc external signer fixes and translation hints 2021-06-16 10:48:58 +02:00
optionsdialog.h p2p, refactor: pass and use uint16_t CService::port as uint16_t 2021-03-16 19:52:31 +01:00
optionsmodel.cpp gui: add external signer path to options dialog 2021-05-27 14:01:53 +02:00
optionsmodel.h gui: add external signer path to options dialog 2021-05-27 14:01:53 +02:00
overviewpage.cpp Merge bitcoin-core/gui#365: Draw "eye" sign at the beginning of watch-only addresses 2021-07-05 23:48:21 +03:00
overviewpage.h qt: Drop redundant OverviewPage::handleOutOfSyncWarningClicks slot 2021-06-06 01:04:15 +03:00
paymentserver.cpp scripted-diff: Replace GetDataDir(true) calls with gArgs.GetDataDirNet() calls 2021-05-24 10:29:58 +02:00
paymentserver.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
peertablemodel.cpp qt: Emit dataChanged signal to dynamically re-sort Peers table 2021-06-28 17:38:01 +03:00
peertablemodel.h qt: Emit dataChanged signal to dynamically re-sort Peers table 2021-06-28 17:38:01 +03:00
peertablesortproxy.cpp qt: Add peertablesortproxy module 2021-03-07 16:57:11 +02:00
peertablesortproxy.h qt: Add peertablesortproxy module 2021-03-07 16:57:11 +02:00
platformstyle.cpp qt: Make PlatformStyle aware of runtime palette change 2021-05-01 15:07:02 +03:00
platformstyle.h qt: Make PlatformStyle aware of runtime palette change 2021-05-01 15:07:02 +03:00
psbtoperationsdialog.cpp Rearrange fillPSBT arguments 2021-06-10 10:58:45 -04:00
psbtoperationsdialog.h [gui] PSBT Operations Dialog (sign & broadcast) 2020-06-19 02:20:04 -07:00
qrimagewidget.cpp GUI: Restore keyboard shortcuts for context menu entries 2021-06-12 19:39:36 +00:00
qrimagewidget.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
qvalidatedlineedit.cpp
qvalidatedlineedit.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
qvaluecombobox.cpp qt: Use template function qOverload in signal-slot connections 2021-04-30 00:00:44 +03:00
qvaluecombobox.h scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
README.md Improve gui/src/qt README.md 2021-01-28 14:03:21 -05:00
receivecoinsdialog.cpp GUI: Add keyboard shortcuts for other context menus 2021-06-12 19:39:38 +00:00
receivecoinsdialog.h qt: Disable requests context menu actions when appropriate 2021-02-23 11:38:22 -05:00
receiverequestdialog.cpp gui: misc external signer fixes and translation hints 2021-06-16 10:48:58 +02:00
receiverequestdialog.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
recentrequeststablemodel.cpp Merge bitcoin/bitcoin#21353: interfaces: Stop exposing wallet destdata to gui 2021-06-03 15:57:30 +02:00
recentrequeststablemodel.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
rpcconsole.cpp Merge bitcoin/bitcoin#21430: build: Add -Werror=implicit-fallthrough compile flag 2021-07-18 11:06:10 +08:00
rpcconsole.h qt: Save/restore column sizes of the tables in the Peers tab 2021-06-05 13:36:53 +03:00
sendcoinsdialog.cpp gui: misc external signer fixes and translation hints 2021-06-16 10:48:58 +02:00
sendcoinsdialog.h refactor, qt: Simplify SendCoinsDialog::updateCoinControlState 2021-04-18 21:12:57 +01:00
sendcoinsentry.cpp GUI: Always call parent changeEvent handler 2021-06-22 19:24:44 +00:00
sendcoinsentry.h qt: Make SendCoinsEntry aware of runtime palette change 2021-05-01 15:07:09 +03:00
sendcoinsrecipient.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
signverifymessagedialog.cpp GUI: Always call parent changeEvent handler 2021-06-22 19:24:44 +00:00
signverifymessagedialog.h qt: Make SignVerifyMessageDialog aware of runtime palette change 2021-05-01 15:07:09 +03:00
splashscreen.cpp Add include for std::bind. 2021-01-13 02:05:00 +01:00
splashscreen.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
trafficgraphwidget.cpp Fix wrong(1024) divisor for 1000-based prefixes 2021-03-19 19:35:42 +01:00
trafficgraphwidget.h refactor: Use override for non-final overriders 2020-05-08 10:36:58 +03:00
transactiondesc.cpp qt, build: Optimize string concatenation 2021-05-15 19:10:38 +03:00
transactiondesc.h
transactiondescdialog.cpp Merge bitcoin-core/gui#85: Remove unused "What's This" button in dialogs on Windows OS 2021-01-28 10:16:55 +01:00
transactiondescdialog.h scripted-diff: Bump copyright headers 2020-04-16 13:33:09 -04:00
transactionfilterproxy.cpp
transactionfilterproxy.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
transactionoverviewwidget.h qt: Add TransactionOverviewWidget class 2021-01-05 22:10:10 +02:00
transactionrecord.cpp Replace boost::variant with std::variant 2021-01-05 10:10:50 +01:00
transactionrecord.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
transactiontablemodel.cpp Merge bitcoin-core/gui#313: qt: Optimize string concatenation by default 2021-05-26 15:01:18 +02:00
transactiontablemodel.h scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
transactionview.cpp GUI: Always call parent changeEvent handler 2021-06-22 19:24:44 +00:00
transactionview.h qt: Make TransactionView aware of runtime palette change 2021-05-01 15:07:12 +03:00
utilitydialog.cpp scripted-diff: Replace three dots with ellipsis in the UI strings 2021-05-02 22:17:16 +03:00
utilitydialog.h gui: Remove unused interfaces::Node references 2020-08-26 05:52:31 -04:00
walletcontroller.cpp refactor: reduce #ifdef ENABLE_EXTERNAL_SIGNER usage 2021-06-16 10:48:58 +02:00
walletcontroller.h gui: Add closeAllWallets to WalletController 2020-06-01 00:54:00 +01:00
walletframe.cpp qt: Connect WalletView signal to BitcoinGUI slot directly 2021-06-06 01:04:15 +03:00
walletframe.h qt: Connect WalletView signal to BitcoinGUI slot directly 2021-06-06 01:04:15 +03:00
walletmodel.cpp Rearrange fillPSBT arguments 2021-06-10 10:58:45 -04:00
walletmodel.h Merge bitcoin-core/gui#4: UI external signer support (e.g. hardware wallet) 2021-06-09 18:59:59 +12:00
walletmodeltransaction.cpp gui: send using external signer 2021-05-27 14:37:59 +02:00
walletmodeltransaction.h gui: send using external signer 2021-05-27 14:37:59 +02:00
walletview.cpp qt: Drop redundant WalletView::requestedSyncWarningInfo slot 2021-06-06 01:04:14 +03:00
walletview.h qt: Drop redundant WalletView::requestedSyncWarningInfo slot 2021-06-06 01:04:14 +03:00
winshutdownmonitor.cpp scripted-diff: Bump copyright of files changed in 2019 2019-12-30 10:42:20 +13:00
winshutdownmonitor.h

This directory contains the source code for the Bitcoin Core graphical user interface (GUI). It uses the Qt cross-platform framework.

The current precise version for Qt 5 is specified in qt.mk.

Compile and run

See build instructions: Unix, macOS, Windows, FreeBSD, NetBSD, OpenBSD

When following your systems build instructions, make sure to install the Qt dependencies.

To run:

./src/qt/bitcoin-qt

Files and Directories

forms/

  • A directory that contains Designer UI files. These files specify the characteristics of form elements in XML. Qt UI files can be edited with Qt Creator or using any text editor.

locale/

  • Contains translations. They are periodically updated and an effort is made to support as many languages as possible. The process of contributing translations is described in doc/translation_process.md.

res/

  • Contains graphical resources used to enhance the UI experience.

test/

  • Functional tests used to ensure proper functionality of the GUI. Significant changes to the GUI code normally require new or updated tests.

bitcoingui.(h/cpp)

  • Represents the main window of the Bitcoin UI.

*model.(h/cpp)

  • The model. When it has a corresponding controller, it generally inherits from QAbstractTableModel. Models that are used by controllers as helpers inherit from other Qt classes like QValidator.
  • ClientModel is used by the main application bitcoingui and several models like peertablemodel.

*page.(h/cpp)

  • A controller. :NAMEpage.cpp generally includes :NAMEmodel.h and forms/:NAME.page.ui with a similar :NAME.

*dialog.(h/cpp)

  • Various dialogs, e.g. to open a URL. Inherit from QDialog.

paymentserver.(h/cpp)

  • (Deprecated) Used to process BIP21 payment URI requests. Also handles URI-based application switching (e.g. when following a bitcoin:... link from a browser).

walletview.(h/cpp)

  • Represents the view to a single wallet.

Other .h/cpp files

  • UI elements like BitcoinAmountField, which inherit from QWidget.
  • bitcoinstrings.cpp: automatically generated
  • bitcoinunits.(h/cpp): BTC / mBTC / etc. handling
  • callback.h
  • guiconstants.h: UI colors, app name, etc.
  • guiutil.h: several helper functions
  • macdockiconhandler.(h/mm): macOS dock icon handler
  • macnotificationhandler.(h/mm): display notifications in macOS

Contribute

See CONTRIBUTING.md for general guidelines.

Note: Do not change local/bitcoin_en.ts. It is updated automatically.

Using Qt Creator as an IDE

Qt Creator is a powerful tool which packages a UI designer tool (Qt Designer) and a C++ IDE into one application. This is especially useful if you want to change the UI layout.

Download Qt Creator

On Unix and macOS, Qt Creator can be installed through your package manager. Alternatively, you can download a binary from the Qt Website.

Note: If installing from a binary grabbed from the Qt Website: During the installation process, uncheck everything except for Qt Creator.

macOS
brew install qt-creator
Ubuntu & Debian
sudo apt-get install qtcreator

Setup Qt Creator

  1. Make sure you've installed all dependencies specified in your systems build instructions
  2. Follow the compile instructions for your system, run ./configure with the --enable-debug flag
  3. Start Qt Creator. At the start page, do: New -> Import Project -> Import Existing Project
  4. Enter bitcoin-qt as the Project Name and enter the absolute path to src/qt as Location
  5. Check over the file selection, you may need to select the forms directory (necessary if you intend to edit *.ui files)
  6. Confirm the Summary page
  7. In the Projects tab, select Manage Kits...

macOS

  • Under Kits: select the default "Desktop" kit
  • Under Compilers: select "Clang (x86 64bit in /usr/bin)"
  • Under Debuggers: select "LLDB" as debugger (you might need to set the path to your LLDB installation)

Ubuntu & Debian

Note: Some of these options may already be set

  • Under Kits: select the default "Desktop" kit
  • Under Compilers: select "GCC (x86 64bit in /usr/bin)"
  • Under Debuggers: select "GDB" as debugger
  1. While in the Projects tab, ensure that you have the bitcoin-qt executable specified under Run
  • If the executable is not specified: click "Choose...", navigate to src/qt, and select bitcoin-qt
  1. You're all set! Start developing, building, and debugging the Bitcoin Core GUI