#include <QString>
#include <QAbstractListModel>
-// Bitcoin unit definitions
+#include <stdint.h>
+/** Bitcoin unit definitions. Encapsulates parsing and formatting
+ and serves as list model for drop-down selection boxes.
+*/
class BitcoinUnits: public QAbstractListModel
{
public:
explicit BitcoinUnits(QObject *parent);
+ /** Bitcoin units.
+ @note Source: https://en.bitcoin.it/wiki/Units . Please add only sensible ones
+ */
enum Unit
{
- // Source: https://en.bitcoin.it/wiki/Units
- // Please add only sensible ones
BTC,
mBTC,
uBTC
};
- /// Static API
- // Get list of units, for dropdown box
+ //! @name Static API
+ //! Unit conversion and formatting
+ ///@{
+
+ //! Get list of units, for drop-down box
static QList<Unit> availableUnits();
- // Is unit ID valid?
+ //! Is unit ID valid?
static bool valid(int unit);
- // Short name
+ //! Short name
static QString name(int unit);
- // Longer description
+ //! Longer description
static QString description(int unit);
- // Number of satoshis / unit
+ //! Number of Satoshis (1e-8) per unit
static qint64 factor(int unit);
- // Number of amount digits (to represent max number of coins)
+ //! Number of amount digits (to represent max number of coins)
static int amountDigits(int unit);
- // Number of decimals left
+ //! Number of decimals left
static int decimals(int unit);
- // Format as string
- static QString format(int unit, qint64 amount, bool plussign=false);
- // Format as string (with unit)
- static QString formatWithUnit(int unit, qint64 amount, bool plussign=false);
- // Parse string to coin amount
+ //! Format as string
+ static QString format(int unit, qint64 amount, bool plussign=false, uint8_t nNumberOfZeros=2);
+ //! Format as string (with unit)
+ static QString formatWithUnit(int unit, qint64 amount, bool plussign=false, uint8_t nNumberOfZeros=2);
+ //! Parse string to coin amount
static bool parse(int unit, const QString &value, qint64 *val_out);
+ //! Gets title for amount column including current display unit if optionsModel reference available */
+ static QString getAmountColumnTitle(int unit);
+ ///@}
- /// AbstractListModel implementation
- enum {
- // Unit identifier
+ //! @name AbstractListModel implementation
+ //! List model for unit drop-down selection box.
+ ///@{
+ enum RoleIndex {
+ /** Unit identifier */
UnitRole = Qt::UserRole
- } RoleIndex;
+ };
int rowCount(const QModelIndex &parent) const;
QVariant data(const QModelIndex &index, int role) const;
+ ///@}
private:
QList<BitcoinUnits::Unit> unitlist;
};