Qt ForkAwesome 0.1.0
Library that bundles ForkAwesome for use within Qt applications
Public Member Functions | Static Public Member Functions | List of all members
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. More...
 
 Renderer (const QByteArray &fontData)
 Constructs a new renderer with the given fontData. More...
 
 ~Renderer ()
 Destructs the renderer. More...
 
 operator bool () const
 Returns whether the render could be initialized correctly. More...
 
void render (QChar character, QPainter *painter, const QRect &rect, const QColor &color) const
 Renders the specified icon using the specified painter. More...
 
void render (Icon icon, QPainter *painter, const QRect &rect, const QColor &color) const
 Renders the specified icon using the specified painter. More...
 
QPixmap pixmap (QChar icon, const QSize &size, const QColor &color) const
 Renders the specified character as pixmap of the specified size. More...
 
QPixmap pixmap (Icon icon, const QSize &size, const QColor &color) const
 Renders the specified icon as pixmap of the specified size. More...
 
void addThemeOverride (QChar character, const QString &iconNameInTheme)
 Uses the icon from the current icon theme obtained via QIcon::fromTheme() for character if it exists. More...
 
void addThemeOverride (Icon icon, const QString &iconNameInTheme)
 Uses the icon from the current icon theme obtained via QIcon::fromTheme() for icon if it exists. More...
 
void addOverride (QChar character, const QIcon &override)
 Uses the specified override icon for character if it is not null. More...
 
void addOverride (Icon icon, const QIcon &override)
 Uses the specified override icon for icon if it is not null. More...
 
void clearOverrides ()
 Clears all overrides added via addThemeOverride() or addOverride(). More...
 

Static Public Member Functions

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

Detailed Description

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

Definition at line 21 of file renderer.h.

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 81 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 90 of file renderer.cpp.

◆ ~Renderer()

QtForkAwesome::Renderer::~Renderer ( )

Destructs the renderer.

Definition at line 98 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 67 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 187 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 59 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 179 of file renderer.cpp.

◆ clearOverrides()

void QtForkAwesome::Renderer::clearOverrides ( )

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

Definition at line 195 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 203 of file renderer.cpp.

◆ operator bool()

QtForkAwesome::Renderer::operator bool ( ) const

Returns whether the render could be initialized correctly.

Definition at line 108 of file renderer.cpp.

◆ pixmap() [1/2]

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

Renders the specified icon as pixmap of the specified size.

Definition at line 171 of file renderer.cpp.

◆ pixmap() [2/2]

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

Renders the specified character as pixmap of the specified size.

Definition at line 144 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 51 of file renderer.h.

◆ render() [2/2]

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

Renders the specified icon using the specified painter.

Definition at line 128 of file renderer.cpp.


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