tlp::TulipIconicFont Class Reference

#include <TulipIconicFont.h>

Static Public Member Functions
static unsigned int	getIconCodePoint (const std::string &iconName)
static std::string	getIconFamily (const std::string &iconName)
static std::string	getIconUtf8String (const std::string &iconName)
static std::string	getTTFLocation (const std::string &iconName)
static std::string	getWOFF2Location (const std::string &iconName)
static std::string	getWOFFLocation (const std::string &iconName)
static bool	isIconSupported (const std::string &iconName)

Detailed Description

Helper class to ease the use of iconic fonts bundled with Tulip.

Definition at line 30 of file TulipIconicFont.h.

Member Function Documentation

getIconCodePoint()

static unsigned int tlp::TulipIconicFont::getIconCodePoint ( const std::string &  iconName )

static

Returns the Unicode code point associated to an icon name

Parameters

iconName

the name of the icon to get the codepoint

getIconFamily()

static std::string tlp::TulipIconicFont::getIconFamily ( const std::string &  iconName )

static

Returns the font family name associated to an icon name

Parameters

iconName

the icon name

getIconUtf8String()

static std::string tlp::TulipIconicFont::getIconUtf8String ( const std::string &  iconName )

static

Returns an UTF-8 encoded string of a Font Awesome icon

Parameters

iconName

the icon name

Returns

getTTFLocation()

static std::string tlp::TulipIconicFont::getTTFLocation ( const std::string &  iconName )

static

Returns the location of the TrueType font file bundled with Tulip defining the icon with the given name

Parameters

iconName

the name of the icon

getWOFF2Location()

static std::string tlp::TulipIconicFont::getWOFF2Location ( const std::string &  iconName )

static

Returns the location of the .woff2 font file bundled with Tulip defining the icon with the given name

Parameters

iconName

the name of the icon

getWOFFLocation()

static std::string tlp::TulipIconicFont::getWOFFLocation ( const std::string &  iconName )

static

Returns the location of the .woff font file bundled with Tulip defining the icon with the given name

Parameters

iconName

the name of the icon

isIconSupported()

static bool tlp::TulipIconicFont::isIconSupported ( const std::string &  iconName )

static

Checks if the provided icon name is supported

Parameters

iconName

the name of the icon to check support