#include <KoSvgTextShape_p.h>

Public Member Functions
void	calculateAndApplyTabsize (QPointF currentPos, bool isHorizontal, const KoSvgText::ResolutionHandler &resHandler)

QTransform	finalTransform () const

QRectF	layoutBox () const
	layoutBox

QRectF	lineHeightBox () const
	lineHeightBox

void	scaleCharacterResult (qreal xScale, qreal yScale)
	scaleCharacterResult convenience function to scale the whole character result.

QPointF	totalBaselineOffset () const

void	translateOrigin (QPointF newOrigin)
	translateOrigin For dominant baseline, we want to move the glyph origin. This encompassed the glyph, the ascent and descent, and the metrics.

Public Attributes
bool	addressable = true

QPointF	advance

KoSvgText::TextAnchor	anchor = KoSvgText::AnchorStart

bool	anchored_chunk = false
	whether this is the start of a new chunk.

QPointF	baselineOffset = QPointF()

BreakType	breakType = BreakType::NoBreak

QPointF	cssPosition = QPointF()
	the position in accordance with the CSS specs, as opossed to the SVG spec.

CursorInfo	cursorInfo

KoSvgText::Direction	direction = KoSvgText::DirectionLeftToRight

QPointF	dominantBaselineOffset = QPointF()

qreal	extraFontScaling = 1.0
	Freetype doesn't allow us to scale below 1pt, so we need to do an extra transformation in these cases.

QPointF	finalPosition
	the final position, taking into account both CSS and SVG positioning considerations.

qreal	fontHalfLeading
	Leading for both sides, can be either negative or positive.

QFont::Style	fontStyle = QFont::StyleNormal

int	fontWeight = 400

Glyph::Variant	glyph

bool	hidden = false

QRectF	inkBoundingBox
	The bounds of the drawn glyph. Different from the bounds the charresult takes up in the layout,.

bool	isHanging = false

bool	isHorizontal = true
	Whether the current glyph lays out horizontal or vertical. Currently same as paragraph, but in future may change.

bool	justifyAfter = false
	Justification Opportunity follows this character.

bool	justifyBefore = false
	Justification Opportunity precedes this character.

LineEdgeBehaviour	lineEnd = LineEdgeBehaviour::NoChange

LineEdgeBehaviour	lineStart = LineEdgeBehaviour::NoChange

KoSvgText::FontMetrics	metrics
	Fontmetrics for current font, in Freetype scanline coordinates.

bool	middle = false

bool	overflowWrap = false

int	plaintTextIndex = -1

qreal	rotate = 0.0

qreal	scaledAscent {}
	Ascender, in pt.

qreal	scaledDescent {}
	Descender, in pt.

qreal	scaledHalfLeading {}
	Leading for both sides, can be either negative or positive, in pt.

std::optional< qreal >	tabSize
	If present, this is a tab and it should align to multiples of this tabSize value.

bool	textLengthApplied = false

int	visualIndex = -1

Detailed Description

Definition at line 90 of file KoSvgTextShape_p.h.

Member Function Documentation

◆ calculateAndApplyTabsize()

void CharacterResult::calculateAndApplyTabsize	(	QPointF	currentPos,
		bool	isHorizontal,
		const KoSvgText::ResolutionHandler &	resHandler )

inline

Definition at line 133 of file KoSvgTextShape_p.h.

                                                                                                                       {
        if (!tabSize) return;
        if (*tabSize == qInf() || qIsNaN(*tabSize)) return;
 
        if (*tabSize > 0) {
            qreal remainder = *tabSize - (isHorizontal? fmod(currentPos.x(), *tabSize): fmod(currentPos.y(), *tabSize));
            advance = resHandler.adjust(isHorizontal? QPointF(remainder, advance.y()): QPointF(advance.x(), remainder));
        }
    }

References KoSvgText::ResolutionHandler::adjust(), advance, isHorizontal, and tabSize.

◆ finalTransform()

QTransform CharacterResult::finalTransform ( ) const

inline

Definition at line 266 of file KoSvgTextShape_p.h.

                                      {
        QTransform tf =
            QTransform::fromTranslate(finalPosition.x(), finalPosition.y());
        tf.rotateRadians(rotate);
        return tf;
    }

References finalPosition, and rotate.

◆ layoutBox()

QRectF CharacterResult::layoutBox ( ) const

inline

layoutBox

Returns: a dynamically calculated layoutBox, this is different from the Ink bounding box.

Definition at line 147 of file KoSvgTextShape_p.h.

                             {
        return isHorizontal? QRectF(0, advance.y()+scaledAscent, advance.x(), scaledDescent-scaledAscent)
                         : QRectF(advance.x()+scaledDescent, 0, scaledAscent-scaledDescent, advance.y());
    }

References advance, isHorizontal, scaledAscent, and scaledDescent.

◆ lineHeightBox()

QRectF CharacterResult::lineHeightBox ( ) const

inline

lineHeightBox

Returns: The box representing the line height of this char.

Definition at line 155 of file KoSvgTextShape_p.h.

                                  {
        QRectF lBox = layoutBox();
        return isHorizontal? lBox.adjusted(0, -scaledHalfLeading, 0, scaledHalfLeading)
                         : lBox.adjusted(-scaledHalfLeading, 0, scaledHalfLeading, 0);
    }

References isHorizontal, layoutBox(), and scaledHalfLeading.

◆ scaleCharacterResult()

void CharacterResult::scaleCharacterResult	(	qreal	xScale,
		qreal	yScale )

inline

scaleCharacterResult convenience function to scale the whole character result.

Parameters

xScale	– the factor by which the width should be scaled.
yScale	– the factor by which the height should be scaled.

Definition at line 197 of file KoSvgTextShape_p.h.

                                                          {
        QTransform scale = QTransform::fromScale(xScale, yScale);
        if (scale.isIdentity()) return;
        const bool scaleToZero = !(xScale > 0 && yScale > 0);
 
        if (Glyph::Outline *outlineGlyph = std::get_if<Glyph::Outline>(&glyph)) {
            if (!outlineGlyph->path.isEmpty()) {
                if (scaleToZero) {
                    outlineGlyph->path = QPainterPath();
                } else {
                    outlineGlyph->path = scale.map(outlineGlyph->path);
                }
            }
        } else if (Glyph::Bitmap *bitmapGlyph = std::get_if<Glyph::Bitmap>(&glyph)) {
            if (scaleToZero) {
                bitmapGlyph->drawRects.clear();
                bitmapGlyph->images.clear();
            } else {
                for (int i = 0; i< bitmapGlyph->drawRects.size(); i++) {
                    bitmapGlyph->drawRects[i] = scale.mapRect(bitmapGlyph->drawRects[i]);
                }
            }
        } else if  (Glyph::ColorLayers *colorGlyph = std::get_if<Glyph::ColorLayers>(&glyph)) {
            for (int i = 0; i< colorGlyph->paths.size(); i++) {
                if (scaleToZero) {
                    colorGlyph->paths[i] = QPainterPath();
                } else {
                    colorGlyph->paths[i] = scale.map(colorGlyph->paths[i]);
                }
            }
        }
        advance = scale.map(advance);
        cursorInfo.caret = scale.map(cursorInfo.caret);
        for (int i = 0; i < cursorInfo.offsets.size(); i++) {
            cursorInfo.offsets[i] = scale.map(cursorInfo.offsets.at(i));
        }
        inkBoundingBox = scale.mapRect(inkBoundingBox);
 
        if (isHorizontal) {
            scaledDescent *= yScale;
            scaledAscent *= yScale;
            scaledHalfLeading *= yScale;
            metrics.scaleBaselines(yScale);
            if (tabSize) {
                tabSize = scale.map(QPointF(*tabSize, *tabSize)).x();
            }
        } else {
            scaledDescent *= xScale;
            scaledAscent *= xScale;
            scaledHalfLeading *= xScale;
            metrics.scaleBaselines(xScale);
            if (tabSize) {
                tabSize = scale.map(QPointF(*tabSize, *tabSize)).y();
            }
        }
    }

References advance, CursorInfo::caret, cursorInfo, glyph, inkBoundingBox, isHorizontal, metrics, CursorInfo::offsets, KoSvgText::FontMetrics::scaleBaselines(), scaledAscent, scaledDescent, scaledHalfLeading, and tabSize.

◆ totalBaselineOffset()

QPointF CharacterResult::totalBaselineOffset ( ) const

inline

Definition at line 254 of file KoSvgTextShape_p.h.

                                        {
        return baselineOffset+dominantBaselineOffset;
    }

References baselineOffset, and dominantBaselineOffset.

◆ translateOrigin()

void CharacterResult::translateOrigin ( QPointF newOrigin )

inline

translateOrigin For dominant baseline, we want to move the glyph origin. This encompassed the glyph, the ascent and descent, and the metrics.

Definition at line 166 of file KoSvgTextShape_p.h.

                                            {
        if (newOrigin == QPointF()) return;
        if (Glyph::Outline *outlineGlyph = std::get_if<Glyph::Outline>(&glyph)) {
            outlineGlyph->path.translate(-newOrigin);
        } else if (Glyph::Bitmap *bitmapGlyph = std::get_if<Glyph::Bitmap>(&glyph)) {
            for (int i = 0; i< bitmapGlyph->drawRects.size(); i++) {
                bitmapGlyph->drawRects[i].translate(-newOrigin);
            }
        } else if  (Glyph::ColorLayers *colorGlyph = std::get_if<Glyph::ColorLayers>(&glyph)) {
            for (int i = 0; i< colorGlyph->paths.size(); i++) {
                colorGlyph->paths[i].translate(-newOrigin);
            }
        }
        cursorInfo.caret.translate(-newOrigin);
        inkBoundingBox.translate(-newOrigin);
 
        if (isHorizontal) {
            scaledDescent -= newOrigin.y();
            scaledAscent -= newOrigin.y();
        } else {
            scaledDescent -= newOrigin.x();
            scaledAscent -= newOrigin.x();
        }
    }

References CursorInfo::caret, cursorInfo, glyph, inkBoundingBox, isHorizontal, scaledAscent, and scaledDescent.

Member Data Documentation

◆ addressable

bool CharacterResult::addressable = true

whether the character is not discarded for various reasons, this is necessary for determining to which index a given x/y transform is applied, and in this code we also use it to determine if a character is considered for line-breaking.

Definition at line 97 of file KoSvgTextShape_p.h.

◆ advance

QPointF CharacterResult::advance

Definition at line 114 of file KoSvgTextShape_p.h.

◆ anchor

KoSvgText::TextAnchor CharacterResult::anchor = KoSvgText::AnchorStart

Definition at line 263 of file KoSvgTextShape_p.h.

◆ anchored_chunk

bool CharacterResult::anchored_chunk = false

whether this is the start of a new chunk.

Definition at line 102 of file KoSvgTextShape_p.h.

◆ baselineOffset

QPointF CharacterResult::baselineOffset = QPointF()

The computed baseline offset, will be applied when calculating the line-offset during line breaking.

Definition at line 112 of file KoSvgTextShape_p.h.

◆ breakType

BreakType CharacterResult::breakType = BreakType::NoBreak

Definition at line 115 of file KoSvgTextShape_p.h.

◆ cssPosition

QPointF CharacterResult::cssPosition = QPointF()

the position in accordance with the CSS specs, as opossed to the SVG spec.

Definition at line 110 of file KoSvgTextShape_p.h.

◆ cursorInfo

CursorInfo CharacterResult::cursorInfo

Definition at line 261 of file KoSvgTextShape_p.h.

◆ direction

KoSvgText::Direction CharacterResult::direction = KoSvgText::DirectionLeftToRight

Definition at line 264 of file KoSvgTextShape_p.h.

◆ dominantBaselineOffset

QPointF CharacterResult::dominantBaselineOffset = QPointF()

Definition at line 111 of file KoSvgTextShape_p.h.

◆ extraFontScaling

qreal CharacterResult::extraFontScaling = 1.0

Freetype doesn't allow us to scale below 1pt, so we need to do an extra transformation in these cases.

Definition at line 124 of file KoSvgTextShape_p.h.

◆ finalPosition

QPointF CharacterResult::finalPosition

the final position, taking into account both CSS and SVG positioning considerations.

Definition at line 91 of file KoSvgTextShape_p.h.

◆ fontHalfLeading

qreal CharacterResult::fontHalfLeading

Leading for both sides, can be either negative or positive.

Definition at line 125 of file KoSvgTextShape_p.h.

◆ fontStyle

QFont::Style CharacterResult::fontStyle = QFont::StyleNormal

Definition at line 258 of file KoSvgTextShape_p.h.

◆ fontWeight

int CharacterResult::fontWeight = 400

Definition at line 259 of file KoSvgTextShape_p.h.

◆ glyph

Glyph::Variant CharacterResult::glyph

Definition at line 104 of file KoSvgTextShape_p.h.

◆ hidden

bool CharacterResult::hidden = false

Definition at line 93 of file KoSvgTextShape_p.h.

◆ inkBoundingBox

QRectF CharacterResult::inkBoundingBox

The bounds of the drawn glyph. Different from the bounds the charresult takes up in the layout,.

See also: layoutBox();

Definition at line 106 of file KoSvgTextShape_p.h.

◆ isHanging

bool CharacterResult::isHanging = false

Definition at line 120 of file KoSvgTextShape_p.h.

◆ isHorizontal

bool CharacterResult::isHorizontal = true

Whether the current glyph lays out horizontal or vertical. Currently same as paragraph, but in future may change.

Definition at line 107 of file KoSvgTextShape_p.h.

◆ justifyAfter

bool CharacterResult::justifyAfter = false

Justification Opportunity follows this character.

Definition at line 119 of file KoSvgTextShape_p.h.

◆ justifyBefore

bool CharacterResult::justifyBefore = false

Justification Opportunity precedes this character.

Definition at line 118 of file KoSvgTextShape_p.h.

◆ lineEnd

LineEdgeBehaviour CharacterResult::lineEnd = LineEdgeBehaviour::NoChange

Definition at line 116 of file KoSvgTextShape_p.h.

◆ lineStart

LineEdgeBehaviour CharacterResult::lineStart = LineEdgeBehaviour::NoChange

Definition at line 117 of file KoSvgTextShape_p.h.

◆ metrics

KoSvgText::FontMetrics CharacterResult::metrics

Fontmetrics for current font, in Freetype scanline coordinates.

Definition at line 126 of file KoSvgTextShape_p.h.

◆ middle

bool CharacterResult::middle = false

whether the character is the second of last of a typographic character.

Definition at line 100 of file KoSvgTextShape_p.h.

◆ overflowWrap

bool CharacterResult::overflowWrap = false

Definition at line 122 of file KoSvgTextShape_p.h.

◆ plaintTextIndex

int CharacterResult::plaintTextIndex = -1

Definition at line 109 of file KoSvgTextShape_p.h.

◆ rotate

qreal CharacterResult::rotate = 0.0

Definition at line 92 of file KoSvgTextShape_p.h.

◆ scaledAscent

qreal CharacterResult::scaledAscent {}

Ascender, in pt.

Definition at line 128 of file KoSvgTextShape_p.h.

128{};

◆ scaledDescent

qreal CharacterResult::scaledDescent {}

Descender, in pt.

Definition at line 129 of file KoSvgTextShape_p.h.

129{};

◆ scaledHalfLeading

qreal CharacterResult::scaledHalfLeading {}

Leading for both sides, can be either negative or positive, in pt.

Definition at line 127 of file KoSvgTextShape_p.h.

127{};

◆ tabSize

std::optional<qreal> CharacterResult::tabSize

If present, this is a tab and it should align to multiples of this tabSize value.

Definition at line 131 of file KoSvgTextShape_p.h.

◆ textLengthApplied

bool CharacterResult::textLengthApplied = false

Definition at line 121 of file KoSvgTextShape_p.h.

◆ visualIndex

int CharacterResult::visualIndex = -1

Definition at line 108 of file KoSvgTextShape_p.h.

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

libs/flake/text/KoSvgTextShape_p.h

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ calculateAndApplyTabsize()

◆ finalTransform()

◆ layoutBox()

◆ lineHeightBox()

◆ scaleCharacterResult()

◆ totalBaselineOffset()

◆ translateOrigin()

Member Data Documentation

◆ addressable

◆ advance

◆ anchor

◆ anchored_chunk

◆ baselineOffset

◆ breakType

◆ cssPosition

◆ cursorInfo

◆ direction

◆ dominantBaselineOffset

◆ extraFontScaling

◆ finalPosition

◆ fontHalfLeading

◆ fontStyle

◆ fontWeight

◆ glyph

◆ hidden

◆ inkBoundingBox

◆ isHanging

◆ isHorizontal

◆ justifyAfter

◆ justifyBefore

◆ lineEnd

◆ lineStart

◆ metrics

◆ middle

◆ overflowWrap

◆ plaintTextIndex

◆ rotate

◆ scaledAscent

◆ scaledDescent

◆ scaledHalfLeading

◆ tabSize

◆ textLengthApplied

◆ visualIndex