hdps::IconFont Class Reference

#include <IconFont.h>

Inheritance diagram for hdps::IconFont:

Public Member Functions
	IconFont (const QString &name, const std::uint32_t &majorVersion, const std::uint32_t &minorVersion)
QString	getName () const
QString	getFullName () const
std::uint32_t	getMajorVersion () const
std::uint32_t	getMinorVersion () const
QString	getVersionString () const
QFont	getFont (const int &pointSize=-1) const
QIcon	getIcon (const QString &name, const QColor &foregroundColor=QColor(0, 0, 0, 255), const QColor &backgroundColor=Qt::transparent) const
virtual void	initialize ()
virtual QString	getIconCharacter (const QString &iconName) const =0

Static Public Member Functions
static QString	getSearchVersionString (const std::int32_t &majorVersion=-1, const std::int32_t &minorVersion=-1)

Protected Attributes
QString	_name
std::uint32_t	_majorVersion
std::uint32_t	_minorVersion
QString	_fontResourceName
QString	_fontFamily
QMap< QString, QString >	_characters

Detailed Description

Icon font utility class

Helper class for extracting an icon (character) from an icon font

Author

Thomas Kroes

Constructor & Destructor Documentation

IconFont()

hdps::IconFont::IconFont	(	const QString &	name,
		const std::uint32_t &	majorVersion,
		const std::uint32_t &	minorVersion
	)

Constructor

Parameters

name	Name of the icon font
majorVersion	Major version number
minorVersion	Minor version number

Member Function Documentation

getFont()

QFont hdps::IconFont::getFont

(

const int &

pointSize = -1

)

const

Get font

Parameters

pointSize

Font point size

Returns

Qt font

getFullName()

QString hdps::IconFont::getFullName

(

)

const

Get icon font full name (includes major and minor version)

getIcon()

QIcon hdps::IconFont::getIcon	(	const QString &	name,
		const QColor &	foregroundColor = QColor(0, 0, 0, 255),
		const QColor &	backgroundColor = Qt::transparent
	)		const

Get icon by name and color

Parameters

name	Name of the icon
foregroundColor	Foreground color of the icon
backgroundColor	Background color of the icon

getIconCharacter()

virtual QString hdps::IconFont::getIconCharacter ( const QString &  iconName ) const

pure virtual

Converts human readable icon name to icon character (unicode)

Parameters

iconName	Name of the icon
return	Icon character (unicode)

Implemented in hdps::FontAwesome.

getMajorVersion()

std::uint32_t hdps::IconFont::getMajorVersion

(

)

const

Get icon font major version

getMinorVersion()

std::uint32_t hdps::IconFont::getMinorVersion

(

)

const

Get icon font minor version

getName()

QString hdps::IconFont::getName

(

)

const

Get icon font name

getSearchVersionString()

QString hdps::IconFont::getSearchVersionString ( const std::int32_t &  majorVersion = -1, const std::int32_t &  minorVersion = -1  )

static

Get icon font search version string

Parameters

majorVersion	Major version number
minorVersion	Minor version number

getVersionString()

QString hdps::IconFont::getVersionString

(

)

const

Get icon font version string

initialize()

void hdps::IconFont::initialize ( )

virtual

Initializes the icon font A typical implementation builds a mapping from icon name to string-based hexadecimal icon unicode character

Reimplemented in hdps::FontAwesome.

Member Data Documentation

_characters

QMap<QString, QString> hdps::IconFont::_characters

protected

Loaded font family

_fontFamily

QString hdps::IconFont::_fontFamily

protected

Resource name of the icon font

_fontResourceName

QString hdps::IconFont::_fontResourceName

protected

Minor version of the icon font

_majorVersion

std::uint32_t hdps::IconFont::_majorVersion

protected

Name of the icon font

_minorVersion

std::uint32_t hdps::IconFont::_minorVersion

protected

Major version of the icon font

_name

QString hdps::IconFont::_name

protected

---

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

• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/util/IconFont.h
• D:/Work/ManiVault/DevBundle/allmain/source/core/HDPS/src/util/IconFont.cpp