Archicad 28 C++ API
Loading...
Searching...
No Matches
Font

Functions for accessing platform independent font wrappers. More...

Classes

struct  API_Font_Head
 Contains common information related to API_FontType. More...
 
struct  API_FontType
 Contains common information related to a font. More...
 

Functions

GSErrCode ACAPI_Font_GetFont (API_FontType &font)
 Returns a font either by index or name.
 
GSErrCode ACAPI_Font_SearchFont (API_FontType &font)
 Search for a font by name.
 
Int32 ACAPI_Font_GetFontNum ()
 Get the number of fonts. You could use it to iterate over the fonts.
 

Detailed Description

Functions for accessing platform independent font wrappers.

Function Documentation

◆ ACAPI_Font_GetFont()

GSErrCode ACAPI_Font_GetFont ( API_FontType font)

Returns a font either by index or name.

Since
Archicad 27
Parameters
font[out] Reference of an API_FontType.
Returns
  • NoError - The function has completed with success.
  • APIERR_BADINDEX - font with the given index does not exist.
  • APIERR_BADNAME - font with the given name does not exist.

◆ ACAPI_Font_GetFontNum()

Int32 ACAPI_Font_GetFontNum ( )

Get the number of fonts. You could use it to iterate over the fonts.

Since
Archicad 27
Returns
  • the number of fonts

◆ ACAPI_Font_SearchFont()

GSErrCode ACAPI_Font_SearchFont ( API_FontType font)

Search for a font by name.

Since
Archicad 27
Parameters
font[in] The reference of the API_FontType on which the search is based.
Returns
  • NoError - The function has completed with success.
  • APIERR_BADNAME - font with the given name does not exist.