Qt ForkAwesome 0.2.2
Library that bundles ForkAwesome for use within Qt applications
Loading...
Searching...
No Matches
QtForkAwesome::Renderer Class Reference

Allows rendering a QtForkAwesome::Icon (or an arbitrary QChar using an arbitrary font file). More...

#include <renderer.h>

Public Member Functions

 Renderer (const QString &fontFileName=QString())
 Constructs a new renderer with the given fontFileName.
 
 Renderer (const QByteArray &fontData)
 Constructs a new renderer with the given fontData.
 
 ~Renderer ()
 Destructs the renderer.
 
 operator bool () const
 Returns whether the render could be initialized correctly.
 
void render (QChar character, QPainter *painter, const QRect &rect, const QColor &color) const
 
void render (Icon icon, QPainter *painter, const QRect &rect, const QColor &color) const
 Renders the specified icon using the specified painter.
 
QPixmap pixmap (QChar icon, const QSize &size, const QColor &color, qreal scaleFactor) const
 Renders the specified character as pixmap of the specified size.
 
QPixmap pixmap (Icon icon, const QSize &size, const QColor &color, qreal scaleFactor) const
 Renders the specified icon as pixmap of the specified size.
 
QPixmap pixmap (QChar icon, const QSize &size, const QColor &color) const
 
QPixmap pixmap (Icon icon, const QSize &size, const QColor &color) const
 Renders the specified icon as pixmap of the specified size.
 
void addThemeOverride (QChar character, const QString &iconNameInTheme)
 Uses the icon from the current icon theme obtained via QIcon::fromTheme() for character if it exists.
 
void addThemeOverride (Icon icon, const QString &iconNameInTheme)
 Uses the icon from the current icon theme obtained via QIcon::fromTheme() for icon if it exists.
 
void addOverride (QChar character, const QIcon &override)
 Uses the specified override icon for character if it is not null.
 
void addOverride (Icon icon, const QIcon &override)
 Uses the specified override icon for icon if it is not null.
 
void setAssociatedPaintDevice (QPaintDevice *paintDevice)
 Sets the associated paintDevice.
 
void clearOverrides ()
 Clears all overrides added via addThemeOverride() or addOverride().
 

Static Public Member Functions

static Renderer & global ()
 Returns the global instance (which is so far only used by the icon engine plugin).
 

Detailed Description

Allows rendering a QtForkAwesome::Icon (or an arbitrary QChar using an arbitrary font file).

Constructor & Destructor Documentation

◆ Renderer() [1/2]

QtForkAwesome::Renderer::Renderer ( const QString & fontFileName = QString())
explicit

Constructs a new renderer with the given fontFileName.

Remarks
If fontFileName is empty, the bundled font file will be used.

Definition at line 86 of file renderer.cpp.

◆ Renderer() [2/2]

QtForkAwesome::Renderer::Renderer ( const QByteArray & fontData)
explicit

Constructs a new renderer with the given fontData.

Definition at line 95 of file renderer.cpp.

◆ ~Renderer()

QtForkAwesome::Renderer::~Renderer ( )

Destructs the renderer.

Definition at line 103 of file renderer.cpp.

Member Function Documentation

◆ addOverride() [1/2]

void QtForkAwesome::Renderer::addOverride ( Icon icon,
const QIcon & override )
inline

Uses the specified override icon for icon if it is not null.

Definition at line 71 of file renderer.h.

◆ addOverride() [2/2]

void QtForkAwesome::Renderer::addOverride ( QChar character,
const QIcon & override )

Uses the specified override icon for character if it is not null.

Definition at line 223 of file renderer.cpp.

◆ addThemeOverride() [1/2]

void QtForkAwesome::Renderer::addThemeOverride ( Icon icon,
const QString & iconNameInTheme )
inline

Uses the icon from the current icon theme obtained via QIcon::fromTheme() for icon if it exists.

Definition at line 63 of file renderer.h.

◆ addThemeOverride() [2/2]

void QtForkAwesome::Renderer::addThemeOverride ( QChar character,
const QString & iconNameInTheme )

Uses the icon from the current icon theme obtained via QIcon::fromTheme() for character if it exists.

Definition at line 215 of file renderer.cpp.

◆ clearOverrides()

void QtForkAwesome::Renderer::clearOverrides ( )

Clears all overrides added via addThemeOverride() or addOverride().

Definition at line 231 of file renderer.cpp.

◆ global()

Renderer & QtForkAwesome::Renderer::global ( )
static

Returns the global instance (which is so far only used by the icon engine plugin).

Definition at line 250 of file renderer.cpp.

◆ operator bool()

QtForkAwesome::Renderer::operator bool ( ) const

Returns whether the render could be initialized correctly.

Definition at line 113 of file renderer.cpp.

◆ pixmap() [1/4]

QPixmap QtForkAwesome::Renderer::pixmap ( Icon icon,
const QSize & size,
const QColor & color ) const

Renders the specified icon as pixmap of the specified size.

Remarks
  • The pixmap will be scaled for the associated paint device or use the global device-dixel-ratio if not paint device has been associated.
  • When rendering a QPixmap for a QIcon, better use the other overloads with the actual size (and a scale factor of one).

Definition at line 207 of file renderer.cpp.

◆ pixmap() [2/4]

QPixmap QtForkAwesome::Renderer::pixmap ( Icon icon,
const QSize & size,
const QColor & color,
qreal scaleFactor ) const

Renders the specified icon as pixmap of the specified size.

Definition at line 181 of file renderer.cpp.

◆ pixmap() [3/4]

QPixmap QtForkAwesome::Renderer::pixmap ( QChar icon,
const QSize & size,
const QColor & color ) const

◆ pixmap() [4/4]

QPixmap QtForkAwesome::Renderer::pixmap ( QChar icon,
const QSize & size,
const QColor & color,
qreal scaleFactor ) const

Renders the specified character as pixmap of the specified size.

Definition at line 149 of file renderer.cpp.

◆ render() [1/2]

void QtForkAwesome::Renderer::render ( Icon icon,
QPainter * painter,
const QRect & rect,
const QColor & color ) const
inline

Renders the specified icon using the specified painter.

Definition at line 55 of file renderer.h.

◆ render() [2/2]

void QtForkAwesome::Renderer::render ( QChar character,
QPainter * painter,
const QRect & rect,
const QColor & color ) const

◆ setAssociatedPaintDevice()

void QtForkAwesome::Renderer::setAssociatedPaintDevice ( QPaintDevice * paintDevice)

Sets the associated paintDevice.

Remarks
The device-pixel-ratio of the specified device will be used when rendering pixmaps using the overloads that do not take a scale factor.

Definition at line 242 of file renderer.cpp.


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