mirror of
https://github.com/bitcoin/bitcoin.git
synced 2026-02-15 09:58:51 +00:00
eb2ffbb7c1
d044e0ec7d37bbcdf10bbdb903b9119741c7297d refactor: Remove override for final overriders (Hennadii Stepanov) 1551cea2d52cac403ff506a7cc955d8de8fd6f3e refactor: Use override for non-final overriders (Hennadii Stepanov) Pull request description: Two commits are split out from #16710 to make reviewing [easier](https://github.com/bitcoin/bitcoin/pull/16710#issuecomment-625760894). From [C++ FAQ](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines.html#c128-virtual-functions-should-specify-exactly-one-of-virtual-override-or-final): > C.128: Virtual functions should specify exactly one of virtual, override, or final > **Reason** Readability. Detection of mistakes. Writing explicit `virtual`, `override`, or `final` is self-documenting and enables the compiler to catch mismatch of types and/or names between base and derived classes. However, writing more than one of these three is both redundant and a potential source of errors. ACKs for top commit: practicalswift: ACK d044e0ec7d37bbcdf10bbdb903b9119741c7297d: consistent use of `override` prevents bugs + patch looks correct + Travis happy MarcoFalke: ACK d044e0ec7d37bbcdf10bbdb903b9119741c7297d, based on my understanding that adding `override` or `final` to a function must always be correct, unless it doesn't compile!? vasild: ACK d044e0ec7 Tree-SHA512: 245fd9b99b8b5cbf8694061f892cb3435f3378c97ebed9f9401ce86d21890211f2234bcc39c9f0f79a4d2806cb31bf8ce41a0f9c2acef4f3a2ac5beca6b077cf
This directory contains the BitcoinQT graphical user interface (GUI). It uses the cross-platform framework Qt.
The current precise version for Qt 5 is specified in qt.mk.
Compile and run
See build instructions (macOS, Windows, Unix, etc).
To run:
./src/qt/bitcoin-qt
Files and directories
forms
Contains Designer UI files. They are created with Qt Creator, but can be edited using any text editor.
locale
Contains translations. They are periodically updated. The process is described here.
res
Resources such as the icon.
test
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)
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 generatedbitcoinunits.(h/cpp): BTC / mBTC / etc handlingcallback.hguiconstants.h: UI colors, app name, etcguiutil.h: several helper functionsmacdockiconhandler.(h/mm): macOS dock icon handlermacnotificationhandler.(h/mm): display notifications in macOS
Contribute
See CONTRIBUTING.md for general guidelines. Specifically for Qt:
- don't change
local/bitcoin_en.ts; this happens automatically
Using Qt Creator as IDE
You can use Qt Creator as an IDE. This is especially useful if you want to change the UI layout.
Download and install the community edition of Qt Creator. Uncheck everything except Qt Creator during the installation process.
Instructions for macOS:
- Make sure you installed everything through Homebrew mentioned in the macOS build instructions
- Use
./configurewith the--enable-debugflag - In Qt Creator do "New Project" -> Import Project -> Import Existing Project
- Enter "bitcoin-qt" as project name, enter src/qt as location
- Leave the file selection as it is
- Confirm the "summary page"
- In the "Projects" tab select "Manage Kits..."
- Select the default "Desktop" kit and select "Clang (x86 64bit in /usr/bin)" as compiler
- Select LLDB as debugger (you might need to set the path to your installation)
- Start debugging with Qt Creator (you might need to the executable to "bitcoin-qt" under "Run", which is where you can also add command line arguments)