KGuiAddons 5.109.0
Typedefs | Enumerations | Functions
KFontUtils Namespace Reference

Provides utility functions for font data. More...

Typedefs

typedef QFlags< AdaptFontSizeOptionAdaptFontSizeOptions
 Stores a combination of #AdaptFontSizeOption values.
 

Enumerations

enum  AdaptFontSizeOption { NoFlags = 0x01 , DoNotAllowWordWrap = 0x02 }
 Modifiers for the adaptFontSize function. More...
 

Functions

qreal adaptFontSize (QPainter &painter, const QString &text, const QSizeF &availableSize, qreal maxFontSize=28.0, qreal minFontSize=1.0, AdaptFontSizeOptions flags=NoFlags)
 Convenience function for adaptFontSize that accepts a QSizeF instead two qreals.
 
qreal adaptFontSize (QPainter &painter, const QString &text, qreal width, qreal height, qreal maxFontSize=28.0, qreal minFontSize=1.0, AdaptFontSizeOptions flags=NoFlags)
 Helper function that calculates the biggest font size (in points) used drawing a centered text using word wrapping.
 

Detailed Description

Provides utility functions for font data.

Typedef Documentation

◆ AdaptFontSizeOptions

Stores a combination of #AdaptFontSizeOption values.

Enumeration Type Documentation

◆ AdaptFontSizeOption

Modifiers for the adaptFontSize function.

See also
AdaptFontSizeOptions
Enumerator
NoFlags 

No modifier.

DoNotAllowWordWrap 

Do not use word wrapping.

Function Documentation

◆ adaptFontSize() [1/2]

qreal KFontUtils::adaptFontSize ( QPainter &  painter,
const QString &  text,
const QSizeF &  availableSize,
qreal  maxFontSize = 28.0,
qreal  minFontSize = 1.0,
AdaptFontSizeOptions  flags = NoFlags 
)

Convenience function for adaptFontSize that accepts a QSizeF instead two qreals.

Since
4.7

◆ adaptFontSize() [2/2]

qreal KFontUtils::adaptFontSize ( QPainter &  painter,
const QString &  text,
qreal  width,
qreal  height,
qreal  maxFontSize = 28.0,
qreal  minFontSize = 1.0,
AdaptFontSizeOptions  flags = NoFlags 
)

Helper function that calculates the biggest font size (in points) used drawing a centered text using word wrapping.

Parameters
painterThe painter where the text will be painted. The font set in the painter is used for the calculation. Note the painter font size is modified by this call
textThe text you want to draw
widthThe available width for drawing
heightThe available height for drawing
maxFontSizeThe maximum font size (in points) to consider
minFontSizeThe minimum font size (in points) to consider
flagsThe modifiers for how the text is painted
Returns
The calculated biggest font size (in points) that draws the text in the given dimensions. Can return smaller than minFontSize, that means the text doesn't fit in the given rectangle. Can return -1 on error
Since
4.7