PRCY unit definitions. More...

#include <bitcoinunits.h>

Inheritance diagram for BitcoinUnits:

Collaboration diagram for BitcoinUnits:

Public Types
enum	Unit { PRCY, mPRCY, uPRCY }
	PRCY units. More...

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	id (int unit)
	Identifier, e.g. for image names. 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 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	simpleFormat (int unit, const CAmount &amount, bool plussign=false, SeparatorStyle separators=separatorStandard)

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)

static QString	floorWithUnit (int unit, const CAmount &amount, bool plussign=false, SeparatorStyle separators=separatorStandard)
	Format as string (with unit) but floor value up to "digits" settings. More...

static QString	floorHtmlWithUnit (int unit, const CAmount &amount, bool plussign=false, SeparatorStyle separators=separatorStandard)

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

PRCY unit definitions.

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

Definition at line 50 of file bitcoinunits.h.

Member Enumeration Documentation

◆ RoleIndex

enum BitcoinUnits::RoleIndex

Enumerator
UnitRole	Unit identifier.

Definition at line 108 of file bitcoinunits.h.

◆ SeparatorStyle

enum BitcoinUnits::SeparatorStyle

Enumerator
separatorNever
separatorStandard
separatorAlways

Definition at line 66 of file bitcoinunits.h.

◆ Unit

enum BitcoinUnits::Unit

PRCY units.

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

Enumerator
PRCY
mPRCY
uPRCY

Definition at line 60 of file bitcoinunits.h.

Constructor & Destructor Documentation

◆ BitcoinUnits()

BitcoinUnits::BitcoinUnits ( QObject * parent )

explicit

Definition at line 16 of file bitcoinunits.cpp.

Member Function Documentation

◆ availableUnits()

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

static

Get list of units, for drop-down box.

Definition at line 21 of file bitcoinunits.cpp.

Here is the caller graph for this function:

◆ data()

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

Definition at line 269 of file bitcoinunits.cpp.

Here is the call graph for this function:

◆ decimals()

int BitcoinUnits::decimals ( int unit )

static

Number of decimals left.

Definition at line 126 of file bitcoinunits.cpp.

Here is the caller graph for this function:

◆ description()

QString BitcoinUnits::description ( int unit )

static

Longer description.

Definition at line 84 of file bitcoinunits.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ factor()

qint64 BitcoinUnits::factor ( int unit )

static

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

Definition at line 112 of file bitcoinunits.cpp.

Here is the caller graph for this function:

◆ floorHtmlWithUnit()

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

static

Definition at line 213 of file bitcoinunits.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ floorWithUnit()

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

static

Format as string (with unit) but floor value up to "digits" settings.

Definition at line 202 of file bitcoinunits.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ format()

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

static

Format as string.

Definition at line 140 of file bitcoinunits.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ formatHtmlWithUnit()

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

static

Definition at line 195 of file bitcoinunits.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ formatWithUnit()

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

static

Format as string (with unit)

Todo:

: Review all remaining calls to BitcoinUnits::formatWithUnit to

: determine whether the output is used in a plain text context

: or an HTML context (and replace with

: BtcoinUnits::formatHtmlWithUnit in the latter case).

: either context.

Hopefully

Todo:: : there aren't instances where the result could be used in

Definition at line 190 of file bitcoinunits.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAmountColumnTitle()

QString BitcoinUnits::getAmountColumnTitle ( int unit )

static

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

Definition at line 254 of file bitcoinunits.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ id()

QString BitcoinUnits::id ( int unit )

static

Identifier, e.g. for image names.

Definition at line 42 of file bitcoinunits.cpp.

Here is the caller graph for this function:

◆ maxMoney()

CAmount BitcoinUnits::maxMoney ( )

static

Return maximum number of base units (Satoshis)

Definition at line 287 of file bitcoinunits.cpp.

Here is the caller graph for this function:

◆ name()

QString BitcoinUnits::name ( int unit )

static

Short name.

Definition at line 56 of file bitcoinunits.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse()

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

static

Parse string to coin amount.

Definition at line 220 of file bitcoinunits.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeSpaces()

static QString BitcoinUnits::removeSpaces ( QString text )

inlinestatic

Definition at line 116 of file bitcoinunits.h.

Here is the caller graph for this function:

◆ rowCount()

int BitcoinUnits::rowCount ( const QModelIndex & parent ) const

Definition at line 263 of file bitcoinunits.cpp.

◆ simpleFormat()

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

static

◆ valid()

bool BitcoinUnits::valid ( int unit )

static

Is unit ID valid?

Definition at line 30 of file bitcoinunits.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ unitlist

QList<BitcoinUnits::Unit> BitcoinUnits::unitlist

private

Definition at line 130 of file bitcoinunits.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

AbstractListModel implementation

Detailed Description

Member Enumeration Documentation

◆ RoleIndex

◆ SeparatorStyle

◆ Unit

Constructor & Destructor Documentation

◆ BitcoinUnits()

Member Function Documentation

◆ availableUnits()

◆ data()

◆ decimals()

◆ description()

◆ factor()

◆ floorHtmlWithUnit()

◆ floorWithUnit()

◆ format()

◆ formatHtmlWithUnit()

◆ formatWithUnit()

◆ getAmountColumnTitle()

◆ id()

◆ maxMoney()

◆ name()

◆ parse()

◆ removeSpaces()

◆ rowCount()

◆ simpleFormat()

◆ valid()

Member Data Documentation

◆ unitlist