QFont Class Reference
[QtGui module]

The font matching algorithm works as follows:

1. The specified font family is searched for.
2. If not found, the styleHint() is used to select a replacement family.
3. Each replacement font family is searched for.
4. If none of these are found or there was no styleHint(), "helvetica" will be searched for.
5. If "helvetica" isn't found Qt will try the lastResortFamily().
6. If the lastResortFamily() isn't found Qt will try the lastResortFont() which will always return a name of some kind.

Note that the actual font matching algorithm varies from platform to platform.

In Windows a request for the "Courier" font is automatically changed to "Courier New", an improved version of Courier that allows for smooth scaling. The older "Courier" bitmap font can be selected by setting the PreferBitmap style strategy (see setStyleStrategy()).

Once a font is found, the remaining attributes are matched in order of priority:

1. fixedPitch()
2. pointSize() (see below)
3. weight()
4. style()

If you have a font which matches on family, even if none of the other attributes match, this font will be chosen in preference to a font which doesn't match on family but which does match on the other attributes. This is because font family is the dominant search criteria.

The point size is defined to match if it is within 20% of the requested point size. When several fonts match and are only distinguished by point size, the font with the closest point size to the one requested will be chosen.

The actual family, font size, weight and other font attributes used for drawing text will depend on what's available for the chosen family under the window system. A QFontInfo object can be used to determine the actual values used for drawing the text.

Examples:

 QFont f("Helvetica");

If you had both an Adobe and a Cronyx Helvetica, you might get either.

 QFont f("Helvetica [Cronyx]");

You can specify the foundry you want in the family name. The font f in the above example will be set to "Helvetica [Cronyx]".

To determine the attributes of the font actually used in the window system, use a QFontInfo object, e.g.

 QFontInfo info(f1);
 QString family = info.family();

To find out font metrics use a QFontMetrics object, e.g.

 QFontMetrics fm(f1);
 int textWidthInPixels = fm.width("How many pixels wide is this text?");
 int textHeightInPixels = fm.height();

For more general information on fonts, see the comp.fonts FAQ. Information on encodings can be found from Roman Czyborra's page.

See also QFontComboBox, QFontMetrics, QFontInfo, QFontDatabase, and Character Map Example.

Member Type Documentation

enum QFont::Capitalization

Rendering option for text this font applies to.

This enum was introduced in Qt 4.4.

enum QFont::SpacingType

This enum was introduced in Qt 4.4.

enum QFont::Stretch

Predefined stretch values that follow the CSS naming convention. The higher the value, the more stretched the text is.

See also setStretch() and stretch().

enum QFont::Style

This enum describes the different styles of glyphs that are used to display text.

See also Weight.

enum QFont::StyleHint

Style hints are used by the font matching algorithm to find an appropriate default family if a selected font family is not available.

enum QFont::StyleStrategy

The style strategy tells the font matching algorithm what type of fonts should be used to find an appropriate default family.

The following strategies are available:

Any of these may be OR-ed with one of these flags:

enum QFont::Weight

Qt uses a weighting scale from 0 to 99 similar to, but not the same as, the scales used in Windows or CSS. A weight of 0 is ultralight, whilst 99 will be an extremely black.

This enum contains the predefined font weights:

Member Function Documentation

QFont::QFont ()

Constructs a font object that uses the application's default font.

See also QApplication::setFont() and QApplication::font().

QFont::QFont ( const QString & family, int pointSize = -1, int weight = -1, bool italic = false )

Constructs a font object with the specified family, pointSize, weight and italic settings.

If pointSize is <= 0, it is set to 12.

The family name may optionally also include a foundry name, e.g. "Helvetica [Cronyx]". If the family is available from more than one foundry and the foundry isn't specified, an arbitrary foundry is chosen. If the family isn't available a family will be set using the font matching algorithm.

See also Weight, setFamily(), setPointSize(), setWeight(), setItalic(), setStyleHint(), and QApplication::font().

QFont::QFont ( const QFont & font, QPaintDevice * pd )

Constructs a font from font for use on the paint device pd.

QFont::QFont ( const QFont & font )

Constructs a font that is a copy of font.

QFont::~QFont ()

Destroys the font object and frees all allocated resources.

bool QFont::bold () const

Returns true if weight() is a value greater than QFont::Normal; otherwise returns false.

See also weight(), setBold(), and QFontInfo::bold().

Capitalization QFont::capitalization () const

Returns the current capitalization type of the font.

This function was introduced in Qt 4.4.

See also setCapitalization().

QString QFont::defaultFamily () const

Returns the family name that corresponds to the current style hint.

See also StyleHint, styleHint(), and setStyleHint().

bool QFont::exactMatch () const

Returns true if a window system font exactly matching the settings of this font is available.

See also QFontInfo.

QString QFont::family () const

Returns the requested font family name, i.e. the name set in the constructor or the last setFont() call.

See also setFamily(), substitutes(), and substitute().

bool QFont::fixedPitch () const

Returns true if fixed pitch has been set; otherwise returns false.

See also setFixedPitch() and QFontInfo::fixedPitch().

FT_Face QFont::freetypeFace () const

Returns the handle to the primary FreeType face of the font. If font merging is not disabled a QFont can contain several physical fonts.

Returns 0 if the font does not contain a FreeType face.

Note: This function is only available on platforms that provide the FreeType library; i.e., X11 and some Embedded Linux platforms.

bool QFont::fromString ( const QString & descrip )

Sets this font to match the description descrip. The description is a comma-separated list of the font attributes, as returned by toString().

See also toString().

HFONT QFont::handle () const

Returns the window system handle to the font, for low-level access. Using this function is not portable.

void QFont::insertSubstitution ( const QString & familyName, const QString & substituteName )   [static]

Inserts substituteName into the substitution table for the family familyName.

See also insertSubstitutions(), removeSubstitution(), substitutions(), substitute(), and substitutes().

void QFont::insertSubstitutions ( const QString & familyName, const QStringList & substituteNames )   [static]

Inserts the list of families substituteNames into the substitution list for familyName.

See also insertSubstitution(), removeSubstitution(), substitutions(), and substitute().

bool QFont::isCopyOf ( const QFont & f ) const

Returns true if this font and f are copies of each other, i.e. one of them was created as a copy of the other and neither has been modified since. This is much stricter than equality.

See also operator=() and operator==().

bool QFont::italic () const

Returns true if the style() of the font is not QFont::StyleNormal

See also setItalic() and style().

bool QFont::kerning () const

Returns true if kerning should be used when drawing text with this font.

See also setKerning().

QString QFont::key () const

Returns the font's key, a textual representation of a font. It is typically used as the key for a cache or dictionary of fonts.

See also QMap.

QString QFont::lastResortFamily () const

Returns the "last resort" font family name.

The current implementation tries a wide variety of common fonts, returning the first one it finds. Is is possible that no family is found in which case an empty string is returned.

See also lastResortFont().

QString QFont::lastResortFont () const

Returns a "last resort" font name for the font matching algorithm. This is used if the last resort family is not available. It will always return a name, if necessary returning something like "fixed" or "system".

The current implementation tries a wide variety of common fonts, returning the first one it finds. The implementation may change at any time, but this function will always return a string containing something.

It is theoretically possible that there really isn't a lastResortFont() in which case Qt will abort with an error message. We have not been able to identify a case where this happens. Please report it as a bug if it does, preferably with a list of the fonts you have installed.

See also lastResortFamily() and rawName().

qreal QFont::letterSpacing () const

Returns the letter spacing for the font.

This function was introduced in Qt 4.4.

See also setLetterSpacing(), letterSpacingType(), and setWordSpacing().

SpacingType QFont::letterSpacingType () const

Returns the spacing type used for letter spacing.

This function was introduced in Qt 4.4.

See also letterSpacing(), setLetterSpacing(), and setWordSpacing().

quint32 QFont::macFontID () const

bool QFont::overline () const

Returns true if overline has been set; otherwise returns false.

See also setOverline().

int QFont::pixelSize () const

Returns the pixel size of the font if it was set with setPixelSize(). Returns -1 if the size was set with setPointSize() or setPointSizeF().

See also setPixelSize(), pointSize(), QFontInfo::pointSize(), and QFontInfo::pixelSize().

int QFont::pointSize () const

Returns the point size of the font. Returns -1 if the font size was specified in pixels.

See also setPointSize() and pointSizeF().

qreal QFont::pointSizeF () const

Returns the point size of the font. Returns -1 if the font size was specified in pixels.

See also pointSize(), setPointSizeF(), pixelSize(), QFontInfo::pointSize(), and QFontInfo::pixelSize().

bool QFont::rawMode () const

Returns true if raw mode is used for font name matching; otherwise returns false.

See also setRawMode() and rawName().

QString QFont::rawName () const

Returns the name of the font within the underlying window system.

Only on X11 when Qt was built without FontConfig support the XLFD (X Logical Font Description) is returned; otherwise an empty string.

Using the return value of this function is usually not portable.

See also setRawName().

void QFont::removeSubstitution ( const QString & familyName )   [static]

Removes all the substitutions for familyName.

See also insertSubstitutions(), insertSubstitution(), substitutions(), and substitute().

QFont QFont::resolve ( const QFont & other ) const

Returns a new QFont that has attributes copied from other that have not been previously set on this font.

void QFont::setBold ( bool enable )

If enable is true sets the font's weight to QFont::Bold; otherwise sets the weight to QFont::Normal.

For finer boldness control use setWeight().

See also bold() and setWeight().

void QFont::setCapitalization ( Capitalization caps )

Sets the capitalization of the text in this font to caps.

A font's capitalization makes the text appear in the selected capitalization mode.

This function was introduced in Qt 4.4.

See also capitalization().

void QFont::setFamily ( const QString & family )

Sets the family name of the font. The name is case insensitive and may include a foundry name.

The family name may optionally also include a foundry name, e.g. "Helvetica [Cronyx]". If the family is available from more than one foundry and the foundry isn't specified, an arbitrary foundry is chosen. If the family isn't available a family will be set using the font matching algorithm.

See also family(), setStyleHint(), and QFontInfo.

void QFont::setFixedPitch ( bool enable )

If enable is true, sets fixed pitch on; otherwise sets fixed pitch off.

See also fixedPitch() and QFontInfo.

void QFont::setItalic ( bool enable )

Sets the style() of the font to QFont::StyleItalic if enable is true; otherwise the style is set to QFont::StyleNormal.

See also italic() and QFontInfo.

void QFont::setKerning ( bool enable )

Enables kerning for this font if enable is true; otherwise disables it. By default, kerning is enabled.

When kerning is enabled, glyph metrics do not add up anymore, even for Latin text. In other words, the assumption that width('a') + width('b') is equal to width("ab") is not neccesairly true.

See also kerning() and QFontMetrics.

void QFont::setLetterSpacing ( SpacingType type, qreal spacing )

Sets the letter spacing for the font to spacing and the type of spacing to type.

Letter spacing changes the default spacing between individual letters in the font. The spacing between the letters can be made smaller as well as larger.

This function was introduced in Qt 4.4.

See also letterSpacing(), letterSpacingType(), and setWordSpacing().

void QFont::setOverline ( bool enable )

If enable is true, sets overline on; otherwise sets overline off.

See also overline() and QFontInfo.

void QFont::setPixelSize ( int pixelSize )

Sets the font size to pixelSize pixels.

Using this function makes the font device dependent. Use setPointSize() or setPointSizeF() to set the size of the font in a device independent manner.

See also pixelSize().

void QFont::setPointSize ( int pointSize )

Sets the point size to pointSize. The point size must be greater than zero.

See also pointSize() and setPointSizeF().

void QFont::setPointSizeF ( qreal pointSize )

Sets the point size to pointSize. The point size must be greater than zero. The requested precision may not be achieved on all platforms.

See also pointSizeF(), setPointSize(), and setPixelSize().

void QFont::setRawMode ( bool enable )

If enable is true, turns raw mode on; otherwise turns raw mode off. This function only has an effect under X11.

If raw mode is enabled, Qt will search for an X font with a complete font name matching the family name, ignoring all other values set for the QFont. If the font name matches several fonts, Qt will use the first font returned by X. QFontInfo cannot be used to fetch information about a QFont using raw mode (it will return the values set in the QFont for all parameters, including the family name).

Warning: Do not use raw mode unless you really, really need it! In most (if not all) cases, setRawName() is a much better choice.

See also rawMode() and setRawName().

void QFont::setRawName ( const QString & name )

Sets a font by its system specific name. The function is particularly useful under X, where system font settings (for example X resources) are usually available in XLFD (X Logical Font Description) form only. You can pass an XLFD as name to this function.

A font set with setRawName() is still a full-featured QFont. It can be queried (for example with italic()) or modified (for example with setItalic()) and is therefore also suitable for rendering rich text.

If Qt's internal font database cannot resolve the raw name, the font becomes a raw font with name as its family.

Note that the present implementation does not handle wildcards in XLFDs well, and that font aliases (file fonts.alias in the font directory on X11) are not supported.

See also rawName(), setRawMode(), and setFamily().

void QFont::setStretch ( int factor )

Sets the stretch factor for the font.

The stretch factor changes the width of all characters in the font by factor percent. For example, setting factor to 150 results in all characters in the font being 1.5 times (ie. 150%) wider. The default stretch factor is 100. The minimum stretch factor is 1, and the maximum stretch factor is 4000.

The stretch factor is only applied to outline fonts. The stretch factor is ignored for bitmap fonts.

NOTE: QFont cannot stretch XLFD fonts. When loading XLFD fonts on X11, the stretch factor is matched against a predefined set of values for the SETWIDTH_NAME field of the XLFD.

See also stretch() and QFont::Stretch.

void QFont::setStrikeOut ( bool enable )

If enable is true, sets strikeout on; otherwise sets strikeout off.

See also strikeOut() and QFontInfo.

void QFont::setStyle ( Style style )

Sets the style of the font to style.

See also style(), italic(), and QFontInfo.

void QFont::setStyleHint ( StyleHint hint, StyleStrategy strategy = PreferDefault )

Sets the style hint and strategy to hint and strategy, respectively.

If these aren't set explicitly the style hint will default to AnyStyle and the style strategy to PreferDefault.

Qt does not support style hints on X11 since this information is not provided by the window system.

See also StyleHint, styleHint(), StyleStrategy, styleStrategy(), and QFontInfo.

void QFont::setStyleStrategy ( StyleStrategy s )

Sets the style strategy for the font to s.

See also styleStrategy() and QFont::StyleStrategy.

void QFont::setUnderline ( bool enable )

If enable is true, sets underline on; otherwise sets underline off.

See also underline() and QFontInfo.

void QFont::setWeight ( int weight )

Sets the weight the font to weight, which should be a value from the QFont::Weight enumeration.

See also weight() and QFontInfo.

void QFont::setWordSpacing ( qreal spacing )

Sets the word spacing for the font to spacing.

Word spacing changes the default spacing between individual words. A positive value increases the word spacing by a corresponding amount of pixels, while a negative value decreases the inter-word spacing accordingly.

Word spacing will not apply to writing systems, where indiviaul words are not separated by white space.

This function was introduced in Qt 4.4.

See also wordSpacing() and setLetterSpacing().

int QFont::stretch () const

Returns the stretch factor for the font.

See also setStretch().

bool QFont::strikeOut () const

Returns true if strikeout has been set; otherwise returns false.

See also setStrikeOut().

Style QFont::style () const

Returns the style of the font.

See also setStyle().

StyleHint QFont::styleHint () const

Returns the StyleHint.

The style hint affects the font matching algorithm. See QFont::StyleHint for the list of available hints.

See also setStyleHint(), QFont::StyleStrategy, and QFontInfo::styleHint().

StyleStrategy QFont::styleStrategy () const

Returns the StyleStrategy.

The style strategy affects the font matching algorithm. See QFont::StyleStrategy for the list of available strategies.

See also setStyleStrategy(), setStyleHint(), and QFont::StyleHint.

QString QFont::substitute ( const QString & familyName )   [static]

Returns the first family name to be used whenever familyName is specified. The lookup is case insensitive.

If there is no substitution for familyName, familyName is returned.

To obtain a list of substitutions use substitutes().

See also setFamily(), insertSubstitutions(), insertSubstitution(), and removeSubstitution().

QStringList QFont::substitutes ( const QString & familyName )   [static]

Returns a list of family names to be used whenever familyName is specified. The lookup is case insensitive.

If there is no substitution for familyName, an empty list is returned.

See also substitute(), insertSubstitutions(), insertSubstitution(), and removeSubstitution().

QStringList QFont::substitutions ()   [static]

Returns a sorted list of substituted family names.

See also insertSubstitution(), removeSubstitution(), and substitute().

QString QFont::toString () const

Returns a description of the font. The description is a comma-separated list of the attributes, perfectly suited for use in QSettings.

See also fromString().

bool QFont::underline () const

Returns true if underline has been set; otherwise returns false.

See also setUnderline().

int QFont::weight () const

Returns the weight of the font which is one of the enumerated values from QFont::Weight.

See also setWeight(), Weight, and QFontInfo.

qreal QFont::wordSpacing () const

Returns the word spacing for the font.

This function was introduced in Qt 4.4.

See also setWordSpacing() and setLetterSpacing().

QFont::operator QVariant () const

Returns the font as a QVariant

bool QFont::operator!= ( const QFont & f ) const

Returns true if this font is different from f; otherwise returns false.

Two QFonts are considered to be different if their font attributes are different. If rawMode() is enabled for both fonts, only the family fields are compared.

See also operator==().

bool QFont::operator< ( const QFont & f ) const

Provides an arbitrary comparison of this font and font f. All that is guaranteed is that the operator returns false if both fonts are equal and that (f1 < f2) == !(f2 < f1) if the fonts are not equal.

This function is useful in some circumstances, for example if you want to use QFont objects as keys in a QMap.

See also operator==(), operator!=(), and isCopyOf().

QFont & QFont::operator= ( const QFont & font )

Assigns font to this font and returns a reference to it.

bool QFont::operator== ( const QFont & f ) const

Returns true if this font is equal to f; otherwise returns false.

Two QFonts are considered equal if their font attributes are equal. If rawMode() is enabled for both fonts, only the family fields are compared.

See also operator!=() and isCopyOf().

Related Non-Members

QDataStream & operator<< ( QDataStream & s, const QFont & font )

This is an overloaded member function, provided for convenience.

Writes the font font to the data stream s. (toString() writes to a text stream.)

See also Format of the QDataStream operators.

QDataStream & operator>> ( QDataStream & s, QFont & font )

This is an overloaded member function, provided for convenience.

Reads the font font from the data stream s. (fromString() reads from a text stream.)

See also Format of the QDataStream operators.