BitcoinUnits Class Reference

#include <bitcoinunits.h>

Inheritance diagram for BitcoinUnits:

Public Types
enum	Unit { BTC, mBTC, uBTC, SAT }
enum	SeparatorStyle { separatorNever, separatorStandard, separatorAlways }

Public Member Functions
	BitcoinUnits (QObject *parent)

Static Public Member Functions
static QString	removeSpaces (QString text)
static CAmount	maxMoney ()
	Return maximum number of base units (Satoshis) More...
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	longName (int unit)
	Long name. More...
static QString	shortName (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 int	decimals (int unit)
	Number of decimals left. More...
static QString	format (int unit, const CAmount &amount, bool plussign=false, SeparatorStyle separators=separatorStandard)
	Format as string. More...
static QString	formatWithUnit (int unit, const CAmount &amount, bool plussign=false, SeparatorStyle separators=separatorStandard)
	Format as string (with unit) More...
static QString	formatHtmlWithUnit (int unit, const CAmount &amount, bool plussign=false, SeparatorStyle separators=separatorStandard)
	Format as HTML string (with unit) More...
static bool	parse (int unit, const QString &value, CAmount *val_out)
	Parse string to coin amount. More...
static QString	getAmountColumnTitle (int unit)
	Gets title for amount column including current display unit if optionsModel reference available */. 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.

Member Enumeration Documentation

RoleIndex

enum BitcoinUnits::RoleIndex

Enumerator
UnitRole	Unit identifier

SeparatorStyle

enum BitcoinUnits::SeparatorStyle

Enumerator
separatorNever
separatorStandard
separatorAlways

Unit

enum BitcoinUnits::Unit

Bitcoin units.

Note

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

Enumerator
BTC
mBTC
uBTC
SAT

Constructor & Destructor Documentation

BitcoinUnits()

BitcoinUnits::BitcoinUnits ( QObject *  parent )

explicit

Member Function Documentation

availableUnits()

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

static

Get list of units, for drop-down box.

data()

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

decimals()

int BitcoinUnits::decimals ( int  unit )

static

Number of decimals left.

description()

QString BitcoinUnits::description ( int  unit )

static

Longer description.

factor()

qint64 BitcoinUnits::factor ( int  unit )

static

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

format()

QString BitcoinUnits::format ( int  unit, const CAmount &  amount, bool  plussign = false, SeparatorStyle  separators = separatorStandard  )

static

Format as string.

formatHtmlWithUnit()

QString BitcoinUnits::formatHtmlWithUnit ( int  unit, const CAmount &  amount, bool  plussign = false, SeparatorStyle  separators = separatorStandard  )

static

Format as HTML string (with unit)

formatWithUnit()

QString BitcoinUnits::formatWithUnit ( int  unit, const CAmount &  amount, bool  plussign = false, SeparatorStyle  separators = separatorStandard  )

static

Format as string (with unit)

getAmountColumnTitle()

QString BitcoinUnits::getAmountColumnTitle ( int  unit )

static

Gets title for amount column including current display unit if optionsModel reference available */.

longName()

QString BitcoinUnits::longName ( int  unit )

static

Long name.

maxMoney()

CAmount BitcoinUnits::maxMoney ( )

static

Return maximum number of base units (Satoshis)

parse()

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

static

Parse string to coin amount.

removeSpaces()

static QString BitcoinUnits::removeSpaces ( QString  text )

inlinestatic

rowCount()

int BitcoinUnits::rowCount

(

const QModelIndex &

parent

)

const

shortName()

QString BitcoinUnits::shortName ( int  unit )

static

Short name.

valid()

bool BitcoinUnits::valid ( int  unit )

static

Is unit ID valid?

Member Data Documentation

unitlist

QList<BitcoinUnits::Unit> BitcoinUnits::unitlist

private

---

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

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