Skip to content

Configurator

Cbrnex edited this page Sep 24, 2022 · 1 revision

configurator

configurator.initializer

  • get_all_modules

    Returns module names.

    • Arguments
      • module_path str
    • Returns
      • typing.List[str]

configurator.sfd

  • generate_sfd

    Generates the SFD file.

    • Arguments
      • font font
      • opts Optional
      • path str
    • Returns
      • typing.NoReturn

configurator.fonts.file

  • check_path

    Checks for the existence of a path.

    • Arguments
      • path str
    • Returns
      • typing.NoReturn
  • close_font

    Closes the font object in fontforge.

    • Arguments
      • font font
    • Returns
      • typing.NoReturn
  • exists_path

    When a path exists, returns true.

    • Arguments
      • path str
    • Returns
      • <class 'bool'>
  • generate_font

    Generates the TTF file from the font object and closes it in fontforge.

    • Arguments
      • font font
    • Returns
      • typing.NoReturn
  • merge_font

    Opens the font object in fontforge from a path and merges it into the font object.

    • Arguments
      • font font
      • path str
    • Returns
      • typing.NoReturn
  • open_font

    Opens the font object from a path in fontforge.

    • Arguments
      • path str
    • Returns
      • <class 'fontforge.font'>
  • save_font

    Saves the font object as the SFD file and closes it in fontforge.

    • Arguments
      • font font
      • path str
    • Returns
      • typing.NoReturn

configurator.fonts.name

  • get_copyright

    Returns copyright text from the copyright object.

    • Arguments
      • copyright Copyright
    • Returns
      • <class 'str'>
  • get_copyrights

    Returns copyright text from many copyright objects.

    • Arguments
      • copyrights List
    • Returns
      • <class 'str'>
  • set_name

    Sets options about name from the name object, along with copyright.

    • Arguments
      • font font
      • name Name
    • Returns
      • typing.NoReturn

configurator.fonts.option

  • set_option

    Sets the options for font.
    • Name (Family name, Font name, Full font name, Fond name) with copyright

    • Size (Ascent, Descent, Linegap)

    • Underline options (Position, Height)

    • Italic angle

    • Encoding

    • Arguments

      • font font
      • option FontOption
    • Returns

      • typing.NoReturn

configurator.fonts.os2

  • create_fstype

    Returns a fstype from arguments.

    • Arguments
      • embedding FsType
      • no_subsetting bool
      • bitmap_embedding_only bool
    • Returns
      • <class 'int'>
  • set_os2_metrics_table

    Sets option about OS/2 Metrics Table.

    • Arguments
      • font font
      • table OS2MetricsTable
    • Returns
      • typing.NoReturn

configurator.fonts.size

  • dataclass

  • set_size

    Sets the option about the size. (Ascent, Descent, Linegap)

    • Arguments
      • font font
      • size Size
    • Returns
      • typing.NoReturn

configurator.fonts.table

  • delete_all_lookups

    Deletes the all lookups, including the subtables.

    • Arguments
      • font font
    • Returns
      • typing.NoReturn
  • delete_lookups

    Deletes the lookups.

    • Arguments
      • font font
      • lookups List
    • Returns
      • typing.NoReturn
  • delete_subtables

    Deletes the subtables.

    • Arguments
      • font font
      • subtables List
    • Returns
      • typing.NoReturn
  • get_lookups

    Returns the lookups. (GSUB/GPOS)

    • Arguments
      • font font
      • _type LookupType
    • Returns
      • typing.Optional[typing.List[str]]
  • get_subtables

    Returns the subtables.

    • Arguments
      • font font
      • lookups List
    • Returns
      • typing.Optional[typing.List[str]]

configurator.glyphs.name

  • change_glyph_name

    Changes a name for a glyph.

    • Arguments
      • glyph glyph
      • name str
    • Returns
      • typing.NoReturn
  • change_glyphs_name

    Changes a name for glyphs.

    • Arguments
      • font font
      • names List
    • Returns
      • typing.NoReturn

configurator.glyphs.option

configurator.glyphs.ranges

  • correct_point

    Returns the correct glyph point with a boolean value.

    • Arguments
      • glyph glyph
    • Returns
      • <class 'bool'>
  • correct_range

    Checks the beginning to end of range.

    • Arguments
      • start int
      • end int
    • Returns
      • typing.NoReturn
  • get_unused_ranges

    Returns unused ranges.

    • Arguments
      • ranges List
    • Returns
      • typing.Optional[typing.List[typing.Tuple[int, int]]]
  • sort_ranges

    Returns sorted ranges.

    • Arguments
      • ranges List
    • Returns
      • typing.List[typing.Tuple[int, int]]

configurator.glyphs.select

  • select_invalid_glyphs

    Selects invalid glyphs in Unicode.

    • Arguments
      • font font
    • Returns
      • typing.NoReturn
  • select_ranges

    Selects glyphs in ranges.

    • Arguments
      • font font
      • ranges List
      • unicode bool
    • Returns
      • typing.NoReturn

configurator.glyphs.trans

  • transform

    Transforms glyphs from the transform option.

    • Arguments
      • font font
      • option TransformOption
    • Returns
      • typing.NoReturn