CartoType C++ API 8.8-7-gb35e4dc71
for Windows, Linux, Qt and other platforms supporting C++ development
Public Member Functions | List of all members
CartoTypeCore::AbbreviationDictionary Class Reference

#include <cartotype_string.h>

Public Member Functions

void Add (const MString &aLongForm, const MString &aShortForm, AbbreviationType aType)
 
bool IsEmpty () const
 
const AbbreviationAbbreviate (const MString &aWord) const
 

Detailed Description

A class providing abbreviations for words.

Member Function Documentation

◆ Abbreviate()

const Abbreviation * CartoTypeCore::AbbreviationDictionary::Abbreviate ( const MString aWord) const

Returns the abbreviation of aWord, or null if no abbreviation is found.

◆ Add()

void CartoTypeCore::AbbreviationDictionary::Add ( const MString aLongForm,
const MString aShortForm,
AbbreviationType  aType 
)

Adds an abbreviation. The abbreviation is added for uppercase, lowercase and titlecase forms. Abbreviations are also added from short forms to nothing.

If a short form is not all lowercase it is added as is and not converted to titlecase or uppercase. Both the lomg form and the short form must not be longer than UINT16_MAX.

◆ IsEmpty()

bool CartoTypeCore::AbbreviationDictionary::IsEmpty ( ) const
inline

Returns true if the dictionary is empty.


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