diff options
author | Wladimir J. van der Laan <laanwj@gmail.com> | 2011-11-13 13:19:52 +0100 |
---|---|---|
committer | Wladimir J. van der Laan <laanwj@gmail.com> | 2011-11-13 14:12:44 +0100 |
commit | af836ad58808a1f6437a8b9a76b670c07c9a1212 (patch) | |
tree | dbc63d61b6404cbdb1f1bd45b58efe794621ab4a /src/qt/bitcoinamountfield.h | |
parent | 66112ed6e69d304eb9be5721f8d9b76375930c52 (diff) |
Improve documentation for UI classes
Diffstat (limited to 'src/qt/bitcoinamountfield.h')
-rw-r--r-- | src/qt/bitcoinamountfield.h | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/src/qt/bitcoinamountfield.h b/src/qt/bitcoinamountfield.h index 8457a418c2..ead8bdb84b 100644 --- a/src/qt/bitcoinamountfield.h +++ b/src/qt/bitcoinamountfield.h @@ -8,8 +8,8 @@ class QDoubleSpinBox; class QValueComboBox; QT_END_NAMESPACE -// Coin amount entry widget with separate parts for whole -// coins and decimals. +/** Widget for entering bitcoin amounts. + */ class BitcoinAmountField: public QWidget { Q_OBJECT @@ -20,25 +20,27 @@ public: qint64 value(bool *valid=0) const; void setValue(qint64 value); - // Mark current valid as invalid in UI + /** Mark current value as invalid in UI. */ void setValid(bool valid); + /** Perform input validation, mark field as invalid if entered value is not valid. */ bool validate(); - // Change current unit + /** Change unit used to display amount. */ void setDisplayUnit(int unit); - // Make field empty and ready for new input + /** Make field empty and ready for new input. */ void clear(); - // Qt messes up the tab chain by default in some cases (issue http://bugreports.qt.nokia.com/browse/QTBUG-10907) - // Hence we have to set it up manually + /** Qt messes up the tab chain by default in some cases (issue http://bugreports.qt.nokia.com/browse/QTBUG-10907), + in these cases we have to set it up manually. + */ QWidget *setupTabChain(QWidget *prev); signals: void textChanged(); protected: - // Intercept focus-in event and ',' keypresses + /** Intercept focus-in event and ',' keypresses */ bool eventFilter(QObject *object, QEvent *event); private: |