BitcoinUnits Class Reference

Bitcoin unit definitions. More...

#include <bitcoinunits.h>

Inheritance diagram for BitcoinUnits:

Collaboration diagram for BitcoinUnits:

Public Types
enum	Unit {   BTC,   mBTC,   uBTC }
	Bitcoin units. More...

Public Member Functions
	BitcoinUnits (QObject *parent)

Static Public Member Functions
Static API
Unit conversion and formatting
static QList< Unit >	availableUnits ()
	Get list of units, for drop-down box. More...
static bool	valid (int unit)
	Is unit ID valid? More...
static QString	name (int unit)
	Short name. More...
static QString	description (int unit)
	Longer description. More...
static qint64	factor (int unit)
	Number of Satoshis (1e-8) per unit. More...
static qint64	maxAmount (int unit)
	Max amount per unit. More...
static int	amountDigits (int unit)
	Number of amount digits (to represent max number of coins) More...
static int	decimals (int unit)
	Number of decimals left. More...
static QString	format (int unit, qint64 amount, bool plussign=false)
	Format as string. More...
static QString	formatWithUnit (int unit, qint64 amount, bool plussign=false)
	Format as string (with unit) More...
static bool	parse (int unit, const QString &value, qint64 *val_out)
	Parse string to coin amount. More...

Private Attributes
QList< BitcoinUnits::Unit >	unitlist

AbstractListModel implementation
List model for unit drop-down selection box.
enum	RoleIndex { UnitRole = Qt::UserRole }
int	rowCount (const QModelIndex &parent) const
QVariant	data (const QModelIndex &index, int role) const

Detailed Description

Bitcoin unit definitions.

Encapsulates parsing and formatting and serves as list model for drop-down selection boxes.

Definition at line 14 of file bitcoinunits.h.

Member Enumeration Documentation

enum BitcoinUnits::RoleIndex

Enumerator
UnitRole	Unit identifier.

Definition at line 62 of file bitcoinunits.h.

enum BitcoinUnits::Unit

Bitcoin units.

Note

Source: https://en.bitcoin.it/wiki/Units . Please add only sensible ones

Enumerator
BTC
mBTC
uBTC

Definition at line 24 of file bitcoinunits.h.

Constructor & Destructor Documentation

BitcoinUnits::BitcoinUnits ( QObject *  parent )

explicit

Definition at line 9 of file bitcoinunits.cpp.

Member Function Documentation

int BitcoinUnits::amountDigits ( int  unit )

static

Number of amount digits (to represent max number of coins)

Definition at line 81 of file bitcoinunits.cpp.

References BTC, mBTC, and uBTC.

Referenced by BitcoinAmountField::unitChanged().

Here is the caller graph for this function:

QList< BitcoinUnits::Unit > BitcoinUnits::availableUnits ( )

static

Get list of units, for drop-down box.

Definition at line 15 of file bitcoinunits.cpp.

References BTC, mBTC, uBTC, and unitlist.

Referenced by SendCoinsDialog::on_sendButton_clicked().

Here is the caller graph for this function:

QVariant BitcoinUnits::data	(	const QModelIndex &	index,
		int	role
	)		const

Definition at line 178 of file bitcoinunits.cpp.

References description(), name(), unitlist, and UnitRole.

Here is the call graph for this function:

int BitcoinUnits::decimals ( int  unit )

static

Number of decimals left.

Definition at line 92 of file bitcoinunits.cpp.

References BTC, mBTC, and uBTC.

Referenced by format(), parse(), and BitcoinAmountField::unitChanged().

Here is the caller graph for this function:

QString BitcoinUnits::description ( int  unit )

static

Longer description.

Definition at line 48 of file bitcoinunits.cpp.

References BTC, mBTC, and uBTC.

Referenced by data().

Here is the caller graph for this function:

qint64 BitcoinUnits::factor ( int  unit )

static

Number of Satoshis (1e-8) per unit.

Definition at line 59 of file bitcoinunits.cpp.

References BTC, mBTC, and uBTC.

Referenced by format(), and BitcoinAmountField::unitChanged().

Here is the caller graph for this function:

QString BitcoinUnits::format ( int  unit, qint64  amount, bool  plussign = false  )

static

Format as string.

Definition at line 103 of file bitcoinunits.cpp.

References decimals(), factor(), and valid().

Referenced by RecentRequestsTableModel::data(), GUIUtil::formatBitcoinURI(), TransactionTableModel::formatTxAmount(), formatWithUnit(), OverviewPage::setBalance(), BitcoinAmountField::setValue(), and CoinControlDialog::updateView().

Here is the call graph for this function:

Here is the caller graph for this function:

QString BitcoinUnits::formatWithUnit ( int  unit, qint64  amount, bool  plussign = false  )

static

Format as string (with unit)

Definition at line 130 of file bitcoinunits.cpp.

References format(), and name().

Referenced by SendCoinsDialog::on_sendButton_clicked(), TxViewDelegate::paint(), PaymentServer::processPaymentRequest(), OverviewPage::setBalance(), SendCoinsDialog::setBalance(), TransactionDesc::toHTML(), ReceiveRequestDialog::update(), and CoinControlDialog::updateLabels().

Here is the call graph for this function:

Here is the caller graph for this function:

qint64 BitcoinUnits::maxAmount ( int  unit )

static

Max amount per unit.

Definition at line 70 of file bitcoinunits.cpp.

References BTC, mBTC, and uBTC.

Referenced by BitcoinAmountField::validate().

Here is the caller graph for this function:

QString BitcoinUnits::name ( int  unit )

static

Short name.

Definition at line 37 of file bitcoinunits.cpp.

References BTC, mBTC, and uBTC.

Referenced by data(), and formatWithUnit().

Here is the caller graph for this function:

bool BitcoinUnits::parse ( int  unit, const QString &  value, qint64 *  val_out  )

static

Parse string to coin amount.

Definition at line 135 of file bitcoinunits.cpp.

References decimals(), and valid().

Referenced by TransactionView::changedAmount(), GUIUtil::parseBitcoinURI(), BitcoinAmountField::validate(), and BitcoinAmountField::value().

Here is the call graph for this function:

Here is the caller graph for this function:

int BitcoinUnits::rowCount

(

const QModelIndex &

parent

)

const

Definition at line 172 of file bitcoinunits.cpp.

References unitlist.

bool BitcoinUnits::valid ( int  unit )

static

Is unit ID valid?

Definition at line 24 of file bitcoinunits.cpp.

References BTC, mBTC, and uBTC.

Referenced by format(), and parse().

Here is the caller graph for this function:

Member Data Documentation

QList<BitcoinUnits::Unit> BitcoinUnits::unitlist

private

Definition at line 71 of file bitcoinunits.h.

Referenced by availableUnits(), data(), and rowCount().

---

The documentation for this class was generated from the following files:

• src/qt/bitcoinunits.h
• src/qt/bitcoinunits.cpp