FTGL: FTLayout Class Reference

FTGL 2.4.0

Public Member Functions | Protected Member Functions | Friends
FTLayout Class Referenceabstract

FTLayout is the interface for layout managers that render text. More...

`#include <FTLayout.h>`

Inheritance diagram for FTLayout:
[legend]

## Public Member Functions
virtual | ~FTLayout ()
| Destructor. More...
virtual FTBBox | BBox (const char *string, const int len=-1, FTPoint position=FTPoint())=0
| Get the bounding box for a formatted string. More...
virtual FTBBox | BBox (const wchar_t *string, const int len=-1, FTPoint position=FTPoint())=0
| Get the bounding box for a formatted string. More...
virtual void | Render (const char *string, const int len=-1, FTPoint position=FTPoint(), int renderMode=FTGL::RENDER_ALL)=0
| Render a string of characters. More...
virtual void | Render (const wchar_t *string, const int len=-1, FTPoint position=FTPoint(), int renderMode=FTGL::RENDER_ALL)=0
| Render a string of characters. More...
virtual FT_Error | Error () const
| Queries the Layout for errors. More...

## Protected Member Functions
| FTLayout ()

## Friends
class | FTSimpleLayout

## Detailed Description

FTLayout is the interface for layout managers that render text.

Specific layout manager classes are derived from this class. This class is abstract and deriving classes must implement the protected `Render` methods to render formatted text and `BBox` methods to determine the bounding box of output text.

See also
  FTFont
  FTBBox

Definition at line 52 of file FTLayout.h.

## Constructor & Destructor Documentation

## ◆ FTLayout()

FTLayout::FTLayout | ( |  | ) |
| protected

## ◆ ~FTLayout()

virtual FTLayout::~FTLayout | ( |  | ) |
| virtual

Destructor.

## Member Function Documentation

## ◆ BBox() [1/2]

virtual FTBBox FTLayout::BBox | ( | const char * | string,
|  | const int | len = `-1`,
|  | FTPoint | position = `FTPoint()`
| ) |  |
| pure virtual

Get the bounding box for a formatted string.

Parameters

  string | A char string.
  len | The length of the string. If < 0 then all characters will be checked until a null character is encountered (optional).
  position | The pen position of the first character (optional).

Returns
  The corresponding bounding box.

Implemented in FTSimpleLayout.

## ◆ BBox() [2/2]

virtual FTBBox FTLayout::BBox | ( | const wchar_t * | string,
|  | const int | len = `-1`,
|  | FTPoint | position = `FTPoint()`
| ) |  |
| pure virtual

Get the bounding box for a formatted string.

Parameters

  string | A wchar_t string.
  len | The length of the string. If < 0 then all characters will be checked until a null character is encountered (optional).
  position | The pen position of the first character (optional).

Returns
  The corresponding bounding box.

Implemented in FTSimpleLayout.

## ◆ Error()

virtual FT_Error FTLayout::Error | ( |  | ) | const
| virtual

Queries the Layout for errors.

Returns
  The current error code.

## ◆ Render() [1/2]

virtual void FTLayout::Render | ( | const char * | string,
|  | const int | len = `-1`,
|  | FTPoint | position = `FTPoint()`,
|  | int | renderMode = `FTGL::RENDER_ALL`
| ) |  |
| pure virtual

Render a string of characters.

Parameters

  string | 'C' style string to be output.
  len | The length of the string. If < 0 then all characters will be displayed until a null character is encountered (optional).
  position | The pen position of the first character (optional).
  renderMode | Render mode to display (optional)

Implemented in FTSimpleLayout.

## ◆ Render() [2/2]

virtual void FTLayout::Render | ( | const wchar_t * | string,
|  | const int | len = `-1`,
|  | FTPoint | position = `FTPoint()`,
|  | int | renderMode = `FTGL::RENDER_ALL`
| ) |  |
| pure virtual

Render a string of characters.

Parameters

  string | wchar_t string to be output.
  len | The length of the string. If < 0 then all characters will be displayed until a null character is encountered (optional).
  position | The pen position of the first character (optional).
  renderMode | Render mode to display (optional)

Implemented in FTSimpleLayout.

## Friends And Related Function Documentation

## ◆ FTSimpleLayout

friend class FTSimpleLayout
| friend

Definition at line 67 of file FTLayout.h.

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

- FTLayout.h