c8edc2c [docs] initial QT documentation, move Qt Creator instructions (Sjors Provoost)
Pull request description:
I'll update this as I figure out how everything is tied together, but I think it's a useful enough start.
Tree-SHA512: d96e5c9ba8ccc3a1b92a0894a8a8449317100eebb14e5d390b51793534458f50eac296cf2945fccf81b85aff23fa32d91d6015a0a76ada4f7091a400d7508ae5
Contains Designer UI files. They are created with [Qt Creator](#use-qt-Creator-as IDE), 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 and BIP70 (see https://github.com/bitcoin/bitcoin/pull/11622) 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/cpp)
macdockiconhandler.(h/cpp): display notifications in OSX
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 OSX:
Make sure you installed everything through Homebrew mentioned in the OSX build instructions
Use ./configure with the --enable-debug flag
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)
db50935489