Pokered Save Editor 2
Pokemon Red & Blue save file editor - Qt 6 C++/QML
Loading...
Searching...
No Matches
FontDBEntry Struct Reference

One in-game font character: its code, output text, and classification flags. More...

#include <fontdbentry.h>

Inheritance diagram for FontDBEntry:
Collaboration diagram for FontDBEntry:

Public Member Functions

int getInd () const
 < Font code.
const QString getName () const
bool getShorthand () const
bool getPicture () const
int getLength () const
const QString getAlias () const
const QString getTip () const
bool getControl () const
bool getMultiChar () const
bool getVariable () const
bool getSingleChar () const
bool getNormal () const
void qmlProtect (const QQmlEngine *const engine) const
 Pin to C++ ownership.

Protected Member Functions

 FontDBEntry ()
 Empty entry (built by FontsDB).
 FontDBEntry (const QJsonValue &data)
 Build from a JSON value.
void qmlRegister () const
 Register with QML.

Protected Attributes

int ind = 0
QString name = ""
bool shorthand = false
bool picture = false
int length = 0
QString alias = ""
QString tip = ""
bool control = false
bool multiChar = false
bool variable = false
bool singleChar = false
bool normal = false

Friends

class FontsDB
class FontSearch

Detailed Description

One in-game font character: its code, output text, and classification flags.

QObject-getter style DB entry. Beyond the code/name it carries a set of boolean classification flags (control/picture/variable/single-/multi-char/normal) that the on-screen keyboard and FontSearch use to filter and categorise glyphs. The field comments below define each flag. FontSearch is a friend so it can read the filter fields.

See also
FontsDB, FontSearch, the name editors / keyboard.

Definition at line 43 of file fontdbentry.h.

Constructor & Destructor Documentation

◆ FontDBEntry() [1/2]

FontDBEntry::FontDBEntry ( )
protected

Empty entry (built by FontsDB).

Definition at line 26 of file fontdbentry.cpp.

References qmlRegister().

◆ FontDBEntry() [2/2]

FontDBEntry::FontDBEntry ( const QJsonValue & data)
protected

Build from a JSON value.

Definition at line 94 of file fontdbentry.cpp.

References alias, control, ind, length, multiChar, name, normal, picture, qmlRegister(), shorthand, singleChar, tip, and variable.

Member Function Documentation

◆ getAlias()

const QString FontDBEntry::getAlias ( ) const
See also
alias property.

Definition at line 65 of file fontdbentry.cpp.

References alias.

◆ getControl()

bool FontDBEntry::getControl ( ) const
See also
control property.

Definition at line 55 of file fontdbentry.cpp.

References control.

◆ getInd()

int FontDBEntry::getInd ( ) const

< Font code.

Output text. Output is shorthand for longer text. Uses the tilemap, not the font. Output length (or max length). Alternate display name. Glyph details/tooltip. Control character. Outputs more than one char. Outputs a variable. Outputs a single char. In-game accessible normal char.

See also
ind property.

Definition at line 90 of file fontdbentry.cpp.

References ind.

◆ getLength()

int FontDBEntry::getLength ( ) const
See also
length property.

Definition at line 70 of file fontdbentry.cpp.

References length.

◆ getMultiChar()

bool FontDBEntry::getMultiChar ( ) const
See also
multiChar property.

Definition at line 50 of file fontdbentry.cpp.

References multiChar.

◆ getName()

const QString FontDBEntry::getName ( ) const
See also
name property.

Definition at line 85 of file fontdbentry.cpp.

References name.

◆ getNormal()

bool FontDBEntry::getNormal ( ) const
See also
normal property.

Definition at line 30 of file fontdbentry.cpp.

References normal.

◆ getPicture()

bool FontDBEntry::getPicture ( ) const
See also
picture property.

Definition at line 75 of file fontdbentry.cpp.

References picture.

◆ getShorthand()

bool FontDBEntry::getShorthand ( ) const
See also
shorthand property.

Definition at line 80 of file fontdbentry.cpp.

References shorthand.

◆ getSingleChar()

bool FontDBEntry::getSingleChar ( ) const
See also
singleChar property.

Definition at line 40 of file fontdbentry.cpp.

References singleChar.

◆ getTip()

const QString FontDBEntry::getTip ( ) const
See also
tip property.

Definition at line 60 of file fontdbentry.cpp.

References tip.

◆ getVariable()

bool FontDBEntry::getVariable ( ) const
See also
variable property.

Definition at line 45 of file fontdbentry.cpp.

References variable.

◆ qmlProtect()

void FontDBEntry::qmlProtect ( const QQmlEngine *const engine) const

Pin to C++ ownership.

Definition at line 35 of file fontdbentry.cpp.

References Utility::qmlProtectUtil().

◆ qmlRegister()

void FontDBEntry::qmlRegister ( ) const
protected

Register with QML.

Definition at line 128 of file fontdbentry.cpp.

Referenced by FontDBEntry(), and FontDBEntry().

◆ FontsDB

friend class FontsDB
friend

Definition at line 96 of file fontdbentry.h.

References FontsDB.

Referenced by FontsDB.

◆ FontSearch

friend class FontSearch
friend

Definition at line 97 of file fontdbentry.h.

References FontSearch.

Referenced by FontSearch.

Member Data Documentation

◆ alias

QString FontDBEntry::alias = ""
protected

Definition at line 88 of file fontdbentry.h.

Referenced by FontDBEntry(), and getAlias().

◆ control

bool FontDBEntry::control = false
protected

Definition at line 90 of file fontdbentry.h.

Referenced by FontDBEntry(), and getControl().

◆ ind

int FontDBEntry::ind = 0
protected

Definition at line 83 of file fontdbentry.h.

Referenced by FontsDB::convertToCode(), FontDBEntry(), and getInd().

◆ length

int FontDBEntry::length = 0
protected

Definition at line 87 of file fontdbentry.h.

Referenced by FontDBEntry(), and getLength().

◆ multiChar

bool FontDBEntry::multiChar = false
protected

Definition at line 91 of file fontdbentry.h.

Referenced by FontDBEntry(), and getMultiChar().

◆ name

QString FontDBEntry::name = ""
protected

Definition at line 84 of file fontdbentry.h.

Referenced by FontsDB::convertToCode(), FontDBEntry(), and getName().

◆ normal

bool FontDBEntry::normal = false
protected

Definition at line 94 of file fontdbentry.h.

Referenced by FontDBEntry(), and getNormal().

◆ picture

bool FontDBEntry::picture = false
protected

Definition at line 86 of file fontdbentry.h.

Referenced by FontDBEntry(), and getPicture().

◆ shorthand

bool FontDBEntry::shorthand = false
protected

Definition at line 85 of file fontdbentry.h.

Referenced by FontDBEntry(), and getShorthand().

◆ singleChar

bool FontDBEntry::singleChar = false
protected

Definition at line 93 of file fontdbentry.h.

Referenced by FontDBEntry(), and getSingleChar().

◆ tip

QString FontDBEntry::tip = ""
protected

Definition at line 89 of file fontdbentry.h.

Referenced by FontDBEntry(), and getTip().

◆ variable

bool FontDBEntry::variable = false
protected

Definition at line 92 of file fontdbentry.h.

Referenced by FontDBEntry(), and getVariable().

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