QFontIconEngine

QIconEngine subclass to handle font glyphs as icons. More...

Inherits from QIconEngine

Public Functions

	Name
	QFontIconEngine()
	QFontIconEngine(const QFontIconEngine & other) Copy contructor.
	QFontIconEngine(int icon, int font =defaultFont()) =default Construct and engine using icon and font.
	QFontIconEngine(const QString & icon, const QString & font ={}) Construct and engine using icon and font.
	~QFontIconEngine() override =default
bool	isValid() const Whether the engine is valid.
int	icon(QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) const Returns the icon code point set for the given state.
QString	iconName() const override Returns the default icon name.
QString	iconName(QIcon::Mode mode, QIcon::State state) const Returns the icon name set for the given state.
QString	text(QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) const Returns the icon code point as a text string for the given state.
int	font(QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) const Returns the font id set for the given state.
QString	fontName(QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) const Returns the font name set for the given state.
qreal	scaleFactor(QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) const Returns the scale factor set for the given state.
QColor	color(QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) const Returns the color set for the given state.
qreal	speed(QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) const Returns the rotation speed set for the given state.
QEasingCurve	curve(QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) const Returns the easing curve set for the given state.
QWidget *	widget() const Returns the widget the rotation animation displays on.
void	setIcon(int icon, QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) Set the icon code point for the given state.
void	setIcon(const QString & name, QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) Set the icon name for the given state.
void	setFont(int font, QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) Set the font id for the given state.
void	setFont(const QString & name, QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) Set the font name for the given state.
void	setScaleFactor(qreal scale, QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) Set the scale factor for the given state.
void	setColor(const QColor & color, QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) Set the color for the given state.
void	setSpeed(qreal speed, QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) Set the rotation speed for the given state.
void	setCurve(const QEasingCurve & curve, QIcon::Mode mode =QIcon::Normal, QIcon::State state =QIcon::Off) Set the easing curve point for the given state.
void	setWidget(QWidget * widget) Set the widget the rotation animation displays on.
QFontIconEngine *	clone() const override
QSize	actualSize(const QSize & size, QIcon::Mode mode, QIcon::State state) override
void	paint(QPainter * painter, const QRect & rect, QIcon::Mode mode, QIcon::State state) override
QPixmap	pixmap(const QSize & size, QIcon::Mode mode, QIcon::State state) override
void	virtual_hook(int id, void * data) override
bool	loadFont(const QString & filename, int font =defaultFont(), const QString & name ={}) =default load the font located at filename.
QIcon	icon(int icon, int font =defaultFont()) =default Convenience function that returns an icon.
QIcon	icon(const QString & icon, const QString & font ={}) Convenience function that returns an icon.
void	setDefaultFont(int font) Set the default font to use.
int	defaultFont() Returns the currently set default font.
bool	registerIconName(QString name, int code) Register a name for the given code point.
bool	registerIconName(const QMap< QString, int > & names) Register all the names / code points provided.
bool	registerFontName(QString name, int font) Register a font name for the given font id.
bool	registerFontName(const QMap< QString, int > & names) Register all the names / font ids provided.

Detailed Description

class QFontIconEngine;

QIconEngine subclass to handle font glyphs as icons.

QFontIconEngine can be used with any fonts. You presumably have embedded your favourite glyph font in a .qrc file. The first thing you need to do is loading you font using the loadFont() static function:

QFontIconEngine::loadFont(":/path/to/my_font.ttf");

Then you can use the icon() static helper function to easily create icons from the font you just loaded:

QIcon icon = QFontIconEngine::icon(0xf82b) // This is the code point of the glyph

// Alternatively, you can make an enumeration and / or register string base names
enum glyph_code {
    super_glyph = 0xf82b
};

QFontIconEngine::registerIconName("super-glyph", super_glyph);

// And then use names instead:
QIcon otherIcon = QFontIconEngine::icon("super-glyph");

QFontIconEngine supports stateful icons. That means you can set different glyphs and various other properties on a per-state basis, depending on QIcon::Mode and QIcon::State . For example:

// Assuming you have registered icon names
// create the engine and then set properties
auto engine = new QFontIconEngine();
engine->setIcon("toggle-on",  QIcon::Normal, QIcon::On);
engine->setIcon("toggle-off", QIcon::Normal, QIcon::Off);

engine->setColor(Qt::green, QIcon::Normal, QIcon::On);
engine->setColor(Qt::red,   QIcon::Normal, QIcon::Off);

// Pass it to a QIcon. Note that QIcon takes the ownership of the engine so.
// Therefore it's unsafe to reuse if afterward.
QIcon icon(engine);

The default state is { QIcon::Normal, QIcon::Off } It is the one set by default when using helper fuctions. If you create and engine from scratch, this state must be set.

If a value is not available in a given state { M, S } , it will first try to find a { QIcon::Normal, S } and if still not successful, will ultimately default to { QIcon::Normal, QIcon::Off }.

Properties also include a spinning animation. (Yep)

// Assuming you'll put it on a button
auto btn = new QPushButton();

auto engine = new QFontIconEngine();
engine->setIcon("spinner");

engine->setWidget(btn); // You need to tell the engine which widget to update
engine->setSpeed(180); // speed is in degree per second. 180 <=> 1 turn in 2s
engine->setCurve(QEasingCurve::InOutSine); // You can even set non-linear rotation.

// Pass it to a QIcon and profits
QIcon icon(engine);

You can load multiple fonts and use them seamlessly. When loading a font you can specify a arbitrary font id and name which will help you differenciate the fonts.

enum icon_set
{
    primary_font,
    secondary_font
};

QFontIconEngine::loadFont(":/path/to/my_font.ttf", primary_font, "primary");
QFontIconEngine::loadFont(":/path/to/my_font.ttf", secondary_font, "secondary");

// Set a default
QFontIconEngine::setDefaultFont(primary_font);

// Then you can pass either the font id of the font name depending on the
// overload you use:
QIcon icon = QFontIconEngine::icon("super-glyph", "secondary");

// This one will use the default font set earlier
QIcon icon2 = QFontIconEngine::icon("super-glyph");

Public Functions Documentation

function QFontIconEngine

QFontIconEngine()

See: isValid()

Construct and engine with the defaultFont() set but no icon. It is therefore invalid.

function QFontIconEngine

QFontIconEngine(
    const QFontIconEngine & other
)

Copy constructor.

function QFontIconEngine

QFontIconEngine(
    int icon,
    int font =defaultFont()
) =default

Construct and engine using icon and font.

Parameters:

icon the code point fo the icon to use
font the font id to use

icon and font will set the { QIcon::Normal, QIcon::Off } state and therefore be used by default.

function QFontIconEngine

QFontIconEngine(
    const QString & icon,
    const QString & font ={}
)

Construct and engine using icon and font.

Parameters:

icon the glyph name fo the icon to use
font the font name to use

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

function ~QFontIconEngine

~QFontIconEngine() override =default

function isValid

bool isValid() const

Whether the engine is valid.

Invalid engine results in null icon and wont draw.

An engine is considered valid if:

it has an default and valid icon (valid code point or name)
it has a default and valid font (loaded font and valid name)

function icon

int icon(
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
) const

Returns the icon code point set for the given state.

function iconName

QString iconName() const override

Returns the default icon name.

function iconName

QString iconName(
    QIcon::Mode mode,
    QIcon::State state
) const

Returns the icon name set for the given state.

function text

QString text(
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
) const

Returns the icon code point as a text string for the given state.

function font

int font(
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
) const

Returns the font id set for the given state.

function fontName

QString fontName(
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
) const

Returns the font name set for the given state.

function scaleFactor

qreal scaleFactor(
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
) const

Returns the scale factor set for the given state.

function color

QColor color(
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
) const

Returns the color set for the given state.

function speed

qreal speed(
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
) const

Returns the rotation speed set for the given state.

function curve

QEasingCurve curve(
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
) const

Returns the easing curve set for the given state.

function widget

QWidget * widget() const

Returns the widget the rotation animation displays on.

function setIcon

void setIcon(
    int icon,
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
)

Set the icon code point for the given state.

function setIcon

void setIcon(
    const QString & name,
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
)

Set the icon name for the given state.

function setFont

void setFont(
    int font,
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
)

Set the font id for the given state.

function setFont

void setFont(
    const QString & name,
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
)

Set the font name for the given state.

function setScaleFactor

void setScaleFactor(
    qreal scale,
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
)

Set the scale factor for the given state.

function setColor

void setColor(
    const QColor & color,
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
)

Set the color for the given state.

function setSpeed

void setSpeed(
    qreal speed,
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
)

Set the rotation speed for the given state.

function setCurve

void setCurve(
    const QEasingCurve & curve,
    QIcon::Mode mode =QIcon::Normal,
    QIcon::State state =QIcon::Off
)

Set the easing curve point for the given state.

function setWidget

void setWidget(
    QWidget * widget
)

Set the widget the rotation animation displays on.

function clone

QFontIconEngine * clone() const override

function actualSize

QSize actualSize(
    const QSize & size,
    QIcon::Mode mode,
    QIcon::State state
) override

function paint

void paint(
    QPainter * painter,
    const QRect & rect,
    QIcon::Mode mode,
    QIcon::State state
) override

function pixmap

QPixmap pixmap(
    const QSize & size,
    QIcon::Mode mode,
    QIcon::State state
) override

function virtual_hook

void virtual_hook(
    int id,
    void * data
) override

function loadFont

static bool loadFont(
    const QString & filename,
    int font =defaultFont(),
    const QString & name ={}
) =default

load the font located at filename.

You can pass an arbitrary font id and font name if you're using multiple fonts.

function icon

static QIcon icon(
    int icon,
    int font =defaultFont()
) =default

Convenience function that returns an icon.

function icon

static QIcon icon(
    const QString & icon,
    const QString & font ={}
)

Convenience function that returns an icon.

function setDefaultFont

static void setDefaultFont(
    int font
)

Set the default font to use.

Before calling this function, the default font is set to 0.

function defaultFont

static int defaultFont()

Returns the currently set default font.

function registerIconName

static bool registerIconName(
    QString name,
    int code
)

function registerIconName

static bool registerIconName(
    const QMap< QString, int > & names
)

function registerFontName

static bool registerFontName(
    QString name,
    int font
)

function registerFontName

static bool registerFontName(
    const QMap< QString, int > & names
)

FilesExpand file tree

reference.md

Latest commit

History

reference.md

File metadata and controls

QFontIconEngine

Public Functions

Detailed Description

Public Functions Documentation

function QFontIconEngine

function QFontIconEngine

function QFontIconEngine

function QFontIconEngine

function ~QFontIconEngine

function isValid

function icon

function iconName

function iconName

function text

function font

function fontName

function scaleFactor

function color

function speed

function curve

function widget

function setIcon

function setIcon

function setFont

function setFont

function setScaleFactor

function setColor

function setSpeed

function setCurve

function setWidget

function clone

function actualSize

function paint

function pixmap

function virtual_hook

function loadFont

function icon

function icon

function setDefaultFont

function defaultFont

function registerIconName

function registerIconName

function registerFontName

function registerFontName