bitcoin/src/qt at master · bitcoin/bitcoin

History

Name		Name	Last commit message	Last commit date
parent directory ..
forms		forms
locale		locale
res		res
test		test
Makefile		Makefile
README.md		README.md
addressbookpage.cpp		addressbookpage.cpp
addressbookpage.h		addressbookpage.h
addresstablemodel.cpp		addresstablemodel.cpp
addresstablemodel.h		addresstablemodel.h
askpassphrasedialog.cpp		askpassphrasedialog.cpp
askpassphrasedialog.h		askpassphrasedialog.h
bantablemodel.cpp		bantablemodel.cpp
bantablemodel.h		bantablemodel.h
bitcoin.cpp		bitcoin.cpp
bitcoin.h		bitcoin.h
bitcoin.qrc		bitcoin.qrc
bitcoin_locale.qrc		bitcoin_locale.qrc
bitcoinaddressvalidator.cpp		bitcoinaddressvalidator.cpp
bitcoinaddressvalidator.h		bitcoinaddressvalidator.h
bitcoinamountfield.cpp		bitcoinamountfield.cpp
bitcoinamountfield.h		bitcoinamountfield.h
bitcoingui.cpp		bitcoingui.cpp
bitcoingui.h		bitcoingui.h
bitcoinstrings.cpp		bitcoinstrings.cpp
bitcoinunits.cpp		bitcoinunits.cpp
bitcoinunits.h		bitcoinunits.h
clientmodel.cpp		clientmodel.cpp
clientmodel.h		clientmodel.h
coincontroldialog.cpp		coincontroldialog.cpp
coincontroldialog.h		coincontroldialog.h
coincontroltreewidget.cpp		coincontroltreewidget.cpp
coincontroltreewidget.h		coincontroltreewidget.h
createwalletdialog.cpp		createwalletdialog.cpp
createwalletdialog.h		createwalletdialog.h
csvmodelwriter.cpp		csvmodelwriter.cpp
csvmodelwriter.h		csvmodelwriter.h
editaddressdialog.cpp		editaddressdialog.cpp
editaddressdialog.h		editaddressdialog.h
guiconstants.h		guiconstants.h
guiutil.cpp		guiutil.cpp
guiutil.h		guiutil.h
initexecutor.cpp		initexecutor.cpp
initexecutor.h		initexecutor.h
intro.cpp		intro.cpp
intro.h		intro.h
macdockiconhandler.h		macdockiconhandler.h
macdockiconhandler.mm		macdockiconhandler.mm
macnotificationhandler.h		macnotificationhandler.h
macnotificationhandler.mm		macnotificationhandler.mm
macos_appnap.h		macos_appnap.h
macos_appnap.mm		macos_appnap.mm
main.cpp		main.cpp
modaloverlay.cpp		modaloverlay.cpp
modaloverlay.h		modaloverlay.h
networkstyle.cpp		networkstyle.cpp
networkstyle.h		networkstyle.h
notificator.cpp		notificator.cpp
notificator.h		notificator.h
openuridialog.cpp		openuridialog.cpp
openuridialog.h		openuridialog.h
optionsdialog.cpp		optionsdialog.cpp
optionsdialog.h		optionsdialog.h
optionsmodel.cpp		optionsmodel.cpp
optionsmodel.h		optionsmodel.h
overviewpage.cpp		overviewpage.cpp
overviewpage.h		overviewpage.h
paymentserver.cpp		paymentserver.cpp
paymentserver.h		paymentserver.h
peertablemodel.cpp		peertablemodel.cpp
peertablemodel.h		peertablemodel.h
peertablesortproxy.cpp		peertablesortproxy.cpp
peertablesortproxy.h		peertablesortproxy.h
platformstyle.cpp		platformstyle.cpp
platformstyle.h		platformstyle.h
psbtoperationsdialog.cpp		psbtoperationsdialog.cpp
psbtoperationsdialog.h		psbtoperationsdialog.h
qrimagewidget.cpp		qrimagewidget.cpp
qrimagewidget.h		qrimagewidget.h
qvalidatedlineedit.cpp		qvalidatedlineedit.cpp
qvalidatedlineedit.h		qvalidatedlineedit.h
qvaluecombobox.cpp		qvaluecombobox.cpp
qvaluecombobox.h		qvaluecombobox.h
receivecoinsdialog.cpp		receivecoinsdialog.cpp
receivecoinsdialog.h		receivecoinsdialog.h
receiverequestdialog.cpp		receiverequestdialog.cpp
receiverequestdialog.h		receiverequestdialog.h
recentrequeststablemodel.cpp		recentrequeststablemodel.cpp
recentrequeststablemodel.h		recentrequeststablemodel.h
rpcconsole.cpp		rpcconsole.cpp
rpcconsole.h		rpcconsole.h
sendcoinsdialog.cpp		sendcoinsdialog.cpp
sendcoinsdialog.h		sendcoinsdialog.h
sendcoinsentry.cpp		sendcoinsentry.cpp
sendcoinsentry.h		sendcoinsentry.h
sendcoinsrecipient.h		sendcoinsrecipient.h
signverifymessagedialog.cpp		signverifymessagedialog.cpp
signverifymessagedialog.h		signverifymessagedialog.h
splashscreen.cpp		splashscreen.cpp
splashscreen.h		splashscreen.h

README.md

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

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

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

You're all set! Start developing, building, and debugging the Bitcoin Core GUI

Files

qt

Directory actions

More options

Directory actions

More options

Latest commit

History

qt

Folders and files

parent directory