The LineBox struct. More...

#include <KoSvgTextShape_p.h>

Public Member Functions
LineChunk	chunk ()

void	clearAndAdjust (bool isHorizontal, QPointF current, QPointF indent)

bool	isEmpty ()

	LineBox ()

	LineBox (QPointF start, QPointF end, const KoSvgText::ResolutionHandler &resHandler)

	LineBox (QVector< QLineF > lineWidths, bool ltr, QPointF indent, const KoSvgText::ResolutionHandler &resHandler)

void	setCurrentChunk (LineChunk chunk)

void	setCurrentChunkForPos (QPointF pos, bool isHorizontal)

Public Attributes
qreal	actualLineBottom = 0

qreal	actualLineTop = 0

QPointF	baselineBottom = QPointF()
	Used to identify the bottom of the line for baseline-alignment.

QPointF	baselineTop = QPointF()
	Used to identify the top of the line for baseline-alignment.

QVector< LineChunk >	chunks

int	currentChunk = -1

qreal	expectedLineTop = 0
	Because fonts can affect lineheight mid-line, and this affects wrapping, this estimates the line-height.

bool	firstLine = false

bool	justifyLine = false

bool	lastLine = false

bool	lineFinalized = false

QPointF	textIndent = QPointF()

Detailed Description

The LineBox struct.

The line box struct is to simplify keeping track of lines inside the wrapping functions. It somewhat corresponds to CSS line boxes, with the caveat that formally, a line split in two in CSS/SVG would be two line boxes, while we instead have two line chunks in a single line box. This is necessary to ensure we can calculate the same line height for boxes split by a shape.

CSS-Inline-3 defines Line Boxes here: https://www.w3.org/TR/css-inline-3/#line-box CSS-Text-3 briefly talks about them here: https://www.w3.org/TR/css-text-3/#bidi-linebox SVG-2 chapter text talks about them here: https://svgwg.org/svg2-draft/text.html#TextLayoutAutoNotes

What is important to us is that all the above specifications, when they talk about Bidi-reordering, agree that the order is dependant on the paragraph/block level direction, and is not affected by the inline content changing direction. Which is good, because that'd make things super hard.

Definition at line 298 of file KoSvgTextShape_p.h.

Constructor & Destructor Documentation

◆ LineBox() [1/3]

LineBox::LineBox ( )

inline

Definition at line 300 of file KoSvgTextShape_p.h.

300 {

301 }

◆ LineBox() [2/3]

LineBox::LineBox	(	QPointF	start,
		QPointF	end,
		const KoSvgText::ResolutionHandler &	resHandler )

inline

Definition at line 303 of file KoSvgTextShape_p.h.

                                                                                      {
        LineChunk chunk;
        chunk.length =  QLineF(resHandler.adjustCeil(start), resHandler.adjustFloor(end));
        chunks.append(chunk);
        currentChunk = 0;
    }

References KoSvgText::ResolutionHandler::adjustCeil(), KoSvgText::ResolutionHandler::adjustFloor(), chunk(), chunks, currentChunk, and LineChunk::length.

◆ LineBox() [3/3]

LineBox::LineBox	(	QVector< QLineF >	lineWidths,
		bool	ltr,
		QPointF	indent,
		const KoSvgText::ResolutionHandler &	resHandler )

inline

Definition at line 310 of file KoSvgTextShape_p.h.

                                                                                                                {
        textIndent = indent;
        if (ltr) {
            Q_FOREACH(QLineF line, lineWidths) {
                LineChunk chunk;
                chunk.length = QLineF(resHandler.adjustCeil(line.p1()), resHandler.adjustFloor(line.p2()));
                chunks.append(chunk);
                currentChunk = 0;
            }
        } else {
            Q_FOREACH(QLineF line, lineWidths) {
                LineChunk chunk;
                chunk.length = QLineF(resHandler.adjustFloor(line.p2()), resHandler.adjustCeil(line.p1()));
                chunks.insert(0, chunk);
                currentChunk = 0;
            }
        }
    }

References KoSvgText::ResolutionHandler::adjustCeil(), KoSvgText::ResolutionHandler::adjustFloor(), chunk(), chunks, currentChunk, LineChunk::length, and textIndent.

Member Function Documentation

◆ chunk()

LineChunk LineBox::chunk ( )

inline

Definition at line 345 of file KoSvgTextShape_p.h.

                      {
        return chunks.value(currentChunk);
    }

References chunks, and currentChunk.

◆ clearAndAdjust()

void LineBox::clearAndAdjust	(	bool	isHorizontal,
		QPointF	current,
		QPointF	indent )

inline

Definition at line 358 of file KoSvgTextShape_p.h.

                                                                            {
        actualLineBottom = 0;
        actualLineTop = 0;
        LineChunk chunk;
        textIndent = indent;
        QLineF length = chunks.at(currentChunk).length;
        if (isHorizontal) {
            length.setP1(QPointF(length.p1().x(), current.y()));
            length.setP2(QPointF(length.p2().x(), current.y()));
        } else {
            length.setP1(QPointF(current.x(), length.p1().y()));
            length.setP2(QPointF(current.x(), length.p2().y()));
        }
        chunks.clear();
        currentChunk = 0;
        chunk.length = length;
        chunks.append(chunk);
        firstLine = false;
    }

References actualLineBottom, actualLineTop, chunk(), chunks, currentChunk, firstLine, LineChunk::length, length(), and textIndent.

◆ isEmpty()

bool LineBox::isEmpty ( )

inline

Definition at line 401 of file KoSvgTextShape_p.h.

                   {
        if (chunks.isEmpty()) return true;
        for (int i =0; i < chunks.size(); i++) {
            if (!chunks.at(i).chunkIndices.isEmpty()) return false;
        }
        return true;
    }

References chunks.

◆ setCurrentChunk()

void LineBox::setCurrentChunk ( LineChunk chunk )

inline

Definition at line 349 of file KoSvgTextShape_p.h.

                                          {
        currentChunk = qMax(currentChunk, 0);
        if (currentChunk < chunks.size()) {
            chunks[currentChunk] = chunk;
        } else {
            chunks.append(chunk);
        }
    }

References chunk(), chunks, and currentChunk.

◆ setCurrentChunkForPos()

void LineBox::setCurrentChunkForPos	(	QPointF	pos,
		bool	isHorizontal )

inline

Definition at line 378 of file KoSvgTextShape_p.h.

                                                               {
        for (int i=0; i<chunks.size(); i++) {
            LineChunk chunk = chunks.at(i);
            if (isHorizontal) {
                qreal min = qMin(chunk.length.p1().x(), chunk.length.p2().x()) - SHAPE_PRECISION;
                qreal max = qMax(chunk.length.p1().x(), chunk.length.p2().x()) + SHAPE_PRECISION;
                if ((pos.x() < max) &&
                        (pos.x() >= min)) {
                        currentChunk = i;
                        break;
                }
            } else {
                qreal min = qMin(chunk.length.p1().y(), chunk.length.p2().y()) - SHAPE_PRECISION;
                qreal max = qMax(chunk.length.p1().y(), chunk.length.p2().y()) + SHAPE_PRECISION;
                if ((pos.y() < max) &&
                        (pos.y() >= min)) {
                    currentChunk = i;
                    break;
                }
            }
        }
    }

References chunk(), chunks, currentChunk, LineChunk::length, and SHAPE_PRECISION.

Member Data Documentation

◆ actualLineBottom

qreal LineBox::actualLineBottom = 0

Definition at line 334 of file KoSvgTextShape_p.h.

◆ actualLineTop

qreal LineBox::actualLineTop = 0

Definition at line 333 of file KoSvgTextShape_p.h.

◆ baselineBottom

QPointF LineBox::baselineBottom = QPointF()

Used to identify the bottom of the line for baseline-alignment.

Definition at line 337 of file KoSvgTextShape_p.h.

◆ baselineTop

QPointF LineBox::baselineTop = QPointF()

Used to identify the top of the line for baseline-alignment.

Definition at line 336 of file KoSvgTextShape_p.h.

◆ chunks

QVector<LineChunk> LineBox::chunks

Definition at line 329 of file KoSvgTextShape_p.h.

◆ currentChunk

int LineBox::currentChunk = -1

Definition at line 330 of file KoSvgTextShape_p.h.

◆ expectedLineTop

qreal LineBox::expectedLineTop = 0

Because fonts can affect lineheight mid-line, and this affects wrapping, this estimates the line-height.

Definition at line 332 of file KoSvgTextShape_p.h.

◆ firstLine

bool LineBox::firstLine = false

Definition at line 340 of file KoSvgTextShape_p.h.

◆ justifyLine

bool LineBox::justifyLine = false

Definition at line 343 of file KoSvgTextShape_p.h.

◆ lastLine

bool LineBox::lastLine = false

Definition at line 341 of file KoSvgTextShape_p.h.

◆ lineFinalized

bool LineBox::lineFinalized = false

Definition at line 342 of file KoSvgTextShape_p.h.

◆ textIndent

QPointF LineBox::textIndent = QPointF()

Definition at line 339 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

Constructor & Destructor Documentation

◆ LineBox() [1/3]

◆ LineBox() [2/3]

◆ LineBox() [3/3]

Member Function Documentation

◆ chunk()

◆ clearAndAdjust()

◆ isEmpty()

◆ setCurrentChunk()

◆ setCurrentChunkForPos()

Member Data Documentation

◆ actualLineBottom

◆ actualLineTop

◆ baselineBottom

◆ baselineTop

◆ chunks

◆ currentChunk

◆ expectedLineTop

◆ firstLine

◆ justifyLine

◆ lastLine

◆ lineFinalized

◆ textIndent