JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
Typeface Class Referenceabstract

A typeface represents a size-independent font. More...

Inherits ReferenceCountedObject.

Inherited by CustomTypeface.

Public Types

typedef
ReferenceCountedObjectPtr
< Typeface
Ptr
 A handy typedef for a pointer to a typeface.
 

Public Member Functions

const StringgetName () const noexcept
 Returns the font family of the typeface.
 
const StringgetStyle () const noexcept
 Returns the font style of the typeface.
 
virtual ~Typeface ()
 Destructor.
 
virtual bool isSuitableForFont (const Font &) const
 Returns true if this typeface can be used to render the specified font.
 
virtual float getAscent () const =0
 Returns the ascent of the font, as a proportion of its height.
 
virtual float getDescent () const =0
 Returns the descent of the font, as a proportion of its height.
 
virtual float getHeightToPointsFactor () const =0
 Returns the value by which you should multiply a juce font-height value to convert it to the equivalent point-size.
 
virtual float getStringWidth (const String &text)=0
 Measures the width of a line of text.
 
virtual void getGlyphPositions (const String &text, Array< int > &glyphs, Array< float > &xOffsets)=0
 Converts a line of text into its glyph numbers and their positions.
 
virtual bool getOutlineForGlyph (int glyphNumber, Path &path)=0
 Returns the outline for a glyph.
 
virtual EdgeTablegetEdgeTableForGlyph (int glyphNumber, const AffineTransform &transform, float fontHeight)
 Returns a new EdgeTable that contains the path for the givem glyph, with the specified transform applied.
 
virtual bool isHinted () const
 Returns true if the typeface uses hinting.
 
void applyVerticalHintingTransform (float fontHeight, Path &path)
 Makes an attempt at performing a good overall distortion that will scale a font of the given size to align vertically with the pixel grid.
 
- Public Member Functions inherited from ReferenceCountedObject
void incReferenceCount () noexcept
 Increments the object's reference count.
 
void decReferenceCount () noexcept
 Decreases the object's reference count.
 
bool decReferenceCountWithoutDeleting () noexcept
 Decreases the object's reference count.
 
int getReferenceCount () const noexcept
 Returns the object's current reference count.
 

Static Public Member Functions

static Ptr createSystemTypefaceFor (const Font &font)
 Creates a new system typeface.
 
static Ptr createSystemTypefaceFor (const void *fontFileData, size_t fontFileDataSize)
 Attempts to create a font from some raw font file data (e.g.
 
static void setTypefaceCacheSize (int numFontsToCache)
 Changes the number of fonts that are cached in memory.
 
static void clearTypefaceCache ()
 Clears any fonts that are currently cached in memory.
 
static void scanFolderForFonts (const File &folder)
 On some platforms, this allows a specific path to be scanned.
 

Protected Member Functions

 Typeface (const String &name, const String &style) noexcept
 
- Protected Member Functions inherited from ReferenceCountedObject
 ReferenceCountedObject ()
 Creates the reference-counted object (with an initial ref count of zero).
 
virtual ~ReferenceCountedObject ()
 Destructor.
 
void resetReferenceCount () noexcept
 Resets the reference count to zero without deleting the object.
 

Static Protected Member Functions

static Ptr getFallbackTypeface ()
 

Protected Attributes

String name
 
String style
 

Detailed Description

A typeface represents a size-independent font.

This base class is abstract, but calling createSystemTypefaceFor() will return a platform-specific subclass that can be used.

The CustomTypeface subclass allow you to build your own typeface, and to load and save it in the Juce typeface format.

Normally you should never need to deal directly with Typeface objects - the Font class does everything you typically need for rendering text.

See Also
CustomTypeface, Font

Member Typedef Documentation

A handy typedef for a pointer to a typeface.

Constructor & Destructor Documentation

virtual Typeface::~Typeface ( )
virtual

Destructor.

Typeface::Typeface ( const String name,
const String style 
)
protectednoexcept

Member Function Documentation

const String& Typeface::getName ( ) const
noexcept

Returns the font family of the typeface.

See Also
Font::getTypefaceName
const String& Typeface::getStyle ( ) const
noexcept

Returns the font style of the typeface.

See Also
Font::getTypefaceStyle
static Ptr Typeface::createSystemTypefaceFor ( const Font font)
static

Creates a new system typeface.

static Ptr Typeface::createSystemTypefaceFor ( const void *  fontFileData,
size_t  fontFileDataSize 
)
static

Attempts to create a font from some raw font file data (e.g.

a TTF or OTF file image). The system will take its own internal copy of the data, so you can free the block once this method has returned.

virtual bool Typeface::isSuitableForFont ( const Font ) const
virtual

Returns true if this typeface can be used to render the specified font.

When called, the font will already have been checked to make sure that its name and style flags match the typeface.

virtual float Typeface::getAscent ( ) const
pure virtual

Returns the ascent of the font, as a proportion of its height.

The height is considered to always be normalised as 1.0, so this will be a value less that 1.0, indicating the proportion of the font that lies above its baseline.

Implemented in CustomTypeface.

virtual float Typeface::getDescent ( ) const
pure virtual

Returns the descent of the font, as a proportion of its height.

The height is considered to always be normalised as 1.0, so this will be a value less that 1.0, indicating the proportion of the font that lies below its baseline.

Implemented in CustomTypeface.

virtual float Typeface::getHeightToPointsFactor ( ) const
pure virtual

Returns the value by which you should multiply a juce font-height value to convert it to the equivalent point-size.

Implemented in CustomTypeface.

virtual float Typeface::getStringWidth ( const String text)
pure virtual

Measures the width of a line of text.

The distance returned is based on the font having an normalised height of 1.0. You should never need to call this directly! Use Font::getStringWidth() instead!

Implemented in CustomTypeface.

virtual void Typeface::getGlyphPositions ( const String text,
Array< int > &  glyphs,
Array< float > &  xOffsets 
)
pure virtual

Converts a line of text into its glyph numbers and their positions.

The distances returned are based on the font having an normalised height of 1.0. You should never need to call this directly! Use Font::getGlyphPositions() instead!

Implemented in CustomTypeface.

virtual bool Typeface::getOutlineForGlyph ( int  glyphNumber,
Path path 
)
pure virtual

Returns the outline for a glyph.

The path returned will be normalised to a font height of 1.0.

Implemented in CustomTypeface.

virtual EdgeTable* Typeface::getEdgeTableForGlyph ( int  glyphNumber,
const AffineTransform transform,
float  fontHeight 
)
virtual

Returns a new EdgeTable that contains the path for the givem glyph, with the specified transform applied.

Reimplemented in CustomTypeface.

virtual bool Typeface::isHinted ( ) const
virtual

Returns true if the typeface uses hinting.

static void Typeface::setTypefaceCacheSize ( int  numFontsToCache)
static

Changes the number of fonts that are cached in memory.

static void Typeface::clearTypefaceCache ( )
static

Clears any fonts that are currently cached in memory.

static void Typeface::scanFolderForFonts ( const File folder)
static

On some platforms, this allows a specific path to be scanned.

Currently only available when using FreeType.

void Typeface::applyVerticalHintingTransform ( float  fontHeight,
Path path 
)

Makes an attempt at performing a good overall distortion that will scale a font of the given size to align vertically with the pixel grid.

The path should be an unscaled (i.e. normalised to height of 1.0) path for a glyph.

static Ptr Typeface::getFallbackTypeface ( )
staticprotected

Member Data Documentation

String Typeface::name
protected
String Typeface::style
protected

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