#include <KoSvgTextShape.h>

Inheritance diagram for KoSvgTextShape:

Classes
struct	TextCursorChangeListener
	ShapeChangeListener so we can inform any text cursors that the cursor needs updating. More...

Public Types
enum class	DebugElement { CharBbox = 1 << 0 , LineBox = 1 << 1 }

enum	TextType { PrePositionedText = 0 , PreformattedText , InlineWrap , TextInShape }

Public Types inherited from KoShape
enum	ChangeType { PositionChanged , RotationChanged , ScaleChanged , ShearChanged , SizeChanged , GenericMatrixChange , KeepAspectRatioChange , ParentChanged , Deleted , StrokeChanged , BackgroundChanged , ShadowChanged , BorderChanged , ParameterChanged , ContentChanged , TextRunAroundChanged , ChildChanged , ConnectionPointChanged , ClipPathChanged , ClipMaskChanged , TransparencyChanged }
	Used by shapeChanged() to select which change was made. More...

enum	ChildZOrderPolicy { ChildZDefault , ChildZParentChild = ChildZDefault , ChildZPassThrough }
	Used by compareShapeZIndex() to order shapes. More...

enum	PaintOrder { Fill , Stroke , Markers }

enum	RunThroughLevel { Background , Foreground }

enum	TextRunAroundContour { ContourBox , ContourFull , ContourOutside }
	The behavior text should do when intersecting this shape. More...

enum	TextRunAroundSide { BiggestRunAroundSide , LeftRunAroundSide , RightRunAroundSide , EnoughRunAroundSide , BothRunAroundSide , NoRunAround , RunThrough }
	The behavior text should do when intersecting this shape. More...

Public Member Functions
void	applyTextLength (KisForest< KoSvgTextContentElement >::child_iterator currentTextElement, QVector< CharacterResult > &result, int &currentIndex, int &resolvedDescendentNodes, bool isHorizontal, const KoSvgTextProperties resolvedProps, const KoSvgText::ResolutionHandler &resHandler)

void	applyWhiteSpace (KisForest< KoSvgTextContentElement > &tree, const bool convertToPreWrapped=false)
	applyWhiteSpace CSS Whitespace processes whitespaces so that duplicate white spaces and unnecessary hard breaks get removed from the text. Within the text layout we avoid removing the white spaces. However, when converting between text types it can be useful to remove these spaces. This function actually applies the white space rule to the active text.

void	applyWhiteSpaceImpl (std::reverse_iterator< KisForest< KoSvgTextContentElement >::child_iterator > current, QVector< bool > &collapsed, QString &allText, const bool convertToPreWrapped)

QSharedPointer< KoShapeBackground >	background () const override

QRectF	boundingRect () const override
	Get the bounding box of the shape.

void	cleanUp ()
	Cleans up the internal text data. Used by undo commands.

void	clearAssociatedOutlines ()

KoShape *	cloneShape () const override
	creates a deep copy of the shape or shape's subtree

KoShape *	collectPaths (const KoShape *rootShape, QVector< CharacterResult > &result, int &currentIndex)

void	computeTextDecorations (KisForest< KoSvgTextContentElement >::child_iterator currentTextElement, const QVector< CharacterResult > &result, const QMap< int, int > &logicalToVisual, const KoSvgText::ResolutionHandler resHandler, KoPathShape *textPath, qreal textPathoffset, bool side, int &currentIndex, bool isHorizontal, bool ltr, bool wrapping, const KoSvgTextProperties resolvedProps)

void	convertCharTransformsToPreformatted (bool makeInlineSize=false)
	convertCharTransformsToPreformatted Converts the text to a preformatted SVG 2.0 text. This changes the textType();

std::unique_ptr< KoSvgTextShape >	copyRange (int index, int length) const
	copyRange Copy the rich text for the given range.

QPainterPath	cursorForPos (int pos, QLineF &caret, QColor &color, double bidiFlagSize=1.0)
	cursorForPos returns the QPainterPath associated with this cursorPosition.

void	debugParsing ()
	Outputs debug with the current textData tree.

void	enterNodeSubtree ()
	Set the current node to its first child, entering the subtree.

KoSvgTextNodeIndex	findNodeIndexForPropertyId (KoSvgTextProperties::PropertyId propertyId)
	findNodeIndexForPropertyId

QPair< int, int >	findRangeForNodeIndex (const KoSvgTextNodeIndex &node) const
	findRangeForNodeIndex Find the start and end cursor position for a given nodeIndex.

bool	fontMatchingDisabled () const
	fontMatchingDisabled

QMap< KoSvgText::TextDecoration, QPainterPath >	generateDecorationPaths (const int &start, const int &end, const KoSvgText::ResolutionHandler resHandler, const QVector< CharacterResult > &result, const bool isHorizontal, const KoSvgText::TextDecorations &decor, const KoSvgText::TextDecorationStyle style=KoSvgText::TextDecorationStyle::Solid, const bool textDecorationSkipInset=false, const KoPathShape *currentTextPath=nullptr, const qreal currentTextPathOffset=0.0, const bool textPathSide=false, const KoSvgText::TextDecorationUnderlinePosition underlinePosH=KoSvgText::TextDecorationUnderlinePosition::UnderlineAuto, const KoSvgText::TextDecorationUnderlinePosition underlinePosV=KoSvgText::TextDecorationUnderlinePosition::UnderlineAuto)

KoSvgTextShapeMementoSP	getMemento ()
	Get a memento holding the current textdata and layout info.

int	indexForPos (int pos) const
	indexForPos get the string index for a given cursor position.

QPointF	initialTextPosition () const
	initialTextPosition Returns the initial text position as per SVG algorithm. The eventual result of this can include transforms or repositioning due to text shapes.

bool	insertRichText (int pos, const KoSvgTextShape *richText)
	insertRichText Insert rich text at the given cursor pos. This will first split contents at the given pos before inserting the new rich text.

bool	insertText (int pos, QString text)
	insertText Insert a text somewhere in the KoTextShape.

	KoSvgTextShape ()

	KoSvgTextShape (const KoSvgTextShape &rhs)

void	leaveNodeSubtree ()
	Set the current node to its parent, leaving the subtree.

int	lineEnd (int pos)
	lineEnd return the 'line end' for this pos. This uses anchored chunks, so each absolute x, y posititioning will be considered a line-start.

int	lineStart (int pos)
	lineStart return the 'line start' for this pos. This uses anchored chunks, so each absolute x, y posititioning will be considered a line-start.

void	mergePropertiesIntoRange (const int startPos, const int endPos, const KoSvgTextProperties properties, const QSet< KoSvgTextProperties::PropertyId > removeProperties=QSet< KoSvgTextProperties::PropertyId >())
	mergePropertiesIntoRange Merge given properties into the given range. This will first split the nodes at the two range ends, and then merge in the properties into each leaf node. Won't do anything when startPos == endPos

int	nextIndex (int pos)
	nextIndex Return the first cursor position with a higher string index.

int	nextLine (int pos)
	nextLine get a position on the next line for this position.

void	notifyCursorPosChanged (int pos, int anchor)
	Notify that the cursor position has changed.

void	notifyMarkupChanged ()
	Notify that the markup has changed.

QPainterPath	outline () const override

QRectF	outlineRect () const override

void	paint (QPainter &painter) const override
	Paint the shape fill The class extending this one is responsible for painting itself. `painter` is expected to be preconfigured to work in "document" pixels.

void	paintDebug (QPainter &painter, const QVector< CharacterResult > &result, int &currentIndex)

void	paintDebug (QPainter &painter, DebugElements elements) const

QVector< PaintOrder >	paintOrder () const override
	paintOrder

void	paintPaths (QPainter &painter, const QPainterPath &outlineRect, const KoShape *rootShape, const QVector< CharacterResult > &result, const KoSvgText::TextRendering rendering, QPainterPath &chunk, int &currentIndex)

void	paintStroke (QPainter &painter) const override
	paintStroke paints the shape's stroked outline

void	paintTextDecoration (QPainter &painter, const QPainterPath &outlineRect, const KoShape *rootShape, const KoSvgText::TextDecoration type, const KoSvgText::TextRendering rendering)

QString	plainText ()
	plainText plain text of all text inside this text shape, without the bidi controls or any transforms.

int	posDown (int pos, bool visual=false)
	return position below.

int	posForIndex (int index, bool firstIndex=false, bool skipSynthetic=false) const
	posForIndex Get the cursor position for a given index in a string.

int	posForPoint (QPointF point, int start=-1, int end=-1, bool *overlaps=nullptr)
	posForPoint Finds the closest cursor position for the given point in shape coordinates.

int	posForPointLineSensitive (QPointF point)
	posForPointLineSensitive When clicking on an empty space in a wrapped text, it is preferable to have the caret be at the end of the line visually associated with that empty space than the positions above or below that might be closer.

int	posLeft (int pos, bool visual=false)

int	posRight (int pos, bool visual=false)

int	posUp (int pos, bool visual=false)
	return position above.

int	previousIndex (int pos)
	previousIndex Return the first pos which has a lower string index.

int	previousLine (int pos)
	previousLine get a position on the previous line for this position.

	Private ()=default

	Private (const Private &rhs)

KoSvgTextProperties	propertiesForPos (const int pos, bool inherited=false) const
	Return the properties at a given position.

QList< KoSvgTextProperties >	propertiesForRange (const int startPos, const int endPos, bool inherited=false) const
	propertiesForRange get the properties for a range.

	Q_DECLARE_FLAGS (DebugElements, DebugElement)

void	relayout ()

void	relayout () const

bool	relayoutIsBlocked () const
	relayoutIsBlocked

bool	removeText (int &index, int &length)
	removeText Where insert text explicitly uses a cursorposition, remove text uses a string index. It will modify these values so that...

bool	saveHtml (HtmlSavingContext &context)

bool	saveSvg (SvgSavingContext &context) override
	Saves SVG data.

QPainterPath	selectionBoxes (int pos, int anchor)
	selectionBoxes returns all selection boxes for a given range. Range will be normalized internally.

void	setBackground (QSharedPointer< KoShapeBackground > background) override

void	setCharacterTransformsFromLayout ()
	setCharacterTransformsFromLayout Converts the text to a prepositioned SVG 1.1 text. This changes the textType();

void	setFontMatchingDisabled (const bool disable)
	setDisableFontMatching

void	setMemento (const KoSvgTextShapeMementoSP memento)
	Set the text data and layout info, reset listening cursors to 0.

void	setMemento (const KoSvgTextShapeMementoSP memento, int pos, int anchor)
	Set the text data, layout info and also adjust any listening cursors.

void	setPaintOrder (PaintOrder first, PaintOrder second) override
	setPaintOrder set the paint order. As there's only three entries in any given paintorder, you only need to have the first and second entry to set it.

void	setPropertiesAtPos (int pos, KoSvgTextProperties properties)
	setPropertiesAtPos will set the properties at pos.

void	setRelayoutBlocked (const bool disable)

void	setResolution (qreal xRes, qreal yRes) override

void	setShapesInside (QList< KoShape * > shapesInside)
	setShapesInside

void	setShapesSubtract (QList< KoShape * > shapesSubtract)
	setShapesSubtract

void	setStroke (KoShapeStrokeModelSP stroke) override

void	setTransformsFromLayout (KisForest< KoSvgTextContentElement > &tree, const QVector< CharacterResult > layout)

void	setTransformsFromLayoutImpl (KisForest< KoSvgTextContentElement >::child_iterator current, const KoSvgTextProperties parentProps, const QVector< CharacterResult > layout, int &globalIndex, bool isHorizontal)

QList< KoShape * >	shapesInside () const
	shapesInside

QList< KoShape * >	shapesSubtract () const
	shapesSubtract

QMap< QString, QString >	shapeTypeSpecificStyles (SvgSavingContext &context) const

KoShapeStrokeModelSP	stroke () const override

KoShape *	textOutline () const
	textOutline This turns the text object into non-text KoShape(s) to the best of its abilities.

KoSvgTextProperties	textProperties () const

TextType	textType () const
	textType This enum gives an indication of what kind of text this shape is. The different text types are a bit blurry as SVG allows a mixutre to provide fallback information. When such fallback is in place, this will only return the primary text type, that is, TextInShape before InlineWrap and InlineWrap before PrePositioned/Preformatted. This primarily exists to give UI feedback.

QPainterPath	underlines (int pos, int anchor, KoSvgText::TextDecorations decor, KoSvgText::TextDecorationStyle style, qreal minimum, bool thick)

int	wordEnd (int pos)
	wordEnd return the pos of the first wordbreak.

int	wordLeft (int pos, bool visual=false)
	wordLeft return the cursorpos for the word left or the extreme of the line.

int	wordRight (int pos, bool visual=false)
	wordRight return the cursorpos for the word right or the extreme of the line.

int	wordStart (int pos)
	wordStart return the first pos before a wordbreak in the start direction.

KoSvgText::WritingMode	writingMode () const
	writingMode There's a number of places we need to check the writing mode to provide proper controls.

	~KoSvgTextShape () override

	~Private ()

Public Member Functions inherited from KoShape
QRectF	absoluteOutlineRect () const

QPointF	absolutePosition (KoFlake::AnchorPosition anchor=KoFlake::Center) const

QTransform	absoluteTransformation () const

bool	addDependee (KoShape *shape)

QString	additionalAttribute (const QString &name) const

void	addShapeChangeListener (ShapeChangeListener *listener)

KoShapeAnchor *	anchor () const

void	applyAbsoluteTransformation (const QTransform &matrix)

void	applyTransformation (const QTransform &matrix)

virtual ChildZOrderPolicy	childZOrderPolicy ()

KoClipMask *	clipMask () const
	Returns the currently set clip mask or 0 if there is no clip mask set.

KoClipPath *	clipPath () const
	Returns the currently set clip path or 0 if there is no clip path set.

KoShape *	cloneShapeAndBakeAbsoluteTransform () const
	creates a deep copy of the shape/shapes tree and bakes the absolute transform of `this` into the resulting shape.

void	copySettings (const KoShape *shape)

QList< KoShape * >	dependees () const
	Returns list of shapes depending on this shape.

QPointF	documentToShape (const QPointF &point) const
	Transforms point from document coordinates to shape coordinates.

QRectF	documentToShape (const QRectF &rect) const
	Transform rect from document coordinates to shape coordinates.

KoFilterEffectStack *	filterEffectStack () const

bool	hasAdditionalAttribute (const QString &name) const

bool	hasCommonParent (const KoShape *shape) const

bool	hasDependee (KoShape *shape) const
	Returns if the given shape is dependent on this shape.

virtual bool	hasTransparency () const

virtual bool	hitTest (const QPointF &position) const
	Check if the shape is hit on position.

QString	hyperLink () const

bool	inheritBackground () const
	inheritBackground shows if the shape inherits background from its parent

bool	inheritPaintOrder () const
	inheritPaintOrder

bool	inheritsTransformFromAny (const QList< KoShape * > ancestorsInQuestion) const
	inheritsTransformFromAny checks if the shape inherits transformation from any of the shapes listed in `ancestorsInQuestion`. The inheritance is checked in recursive way.

bool	inheritStroke () const
	inheritStroke shows if the shape inherits the stroke from its parent

bool	isContentProtected () const

bool	isGeometryProtected () const

bool	isPrintable () const

bool	isSelectable () const

virtual bool	isShapeEditable (bool recursive=true) const
	checks recursively if the shape or one of its parents is not visible or locked

bool	isVisible (bool recursive=true) const

bool	keepAspectRatio () const

	KoShape ()
	Constructor.

qreal	minimumHeight () const

QString	name () const

void	notifyChanged ()

virtual void	paintMarkers (QPainter &painter) const
	paintStroke paints the shape's markers

KoShapeContainer *	parent () const

QPointF	position () const
	Get the position of the shape in pt.

void	removeAdditionalAttribute (const QString &name)

void	removeAdditionalStyleAttribute (const char *name)

void	removeDependee (KoShape *shape)

void	removeShapeChangeListener (ShapeChangeListener *listener)

void	rotate (qreal angle)
	Rotate the shape (relative)

qreal	rotation () const

int	runThrough () const

void	scale (qreal sx, qreal sy)
	Scale the shape using the zero-point which is the top-left corner.

void	setAbsolutePosition (const QPointF &newPosition, KoFlake::AnchorPosition anchor=KoFlake::Center)

void	setAdditionalAttribute (const QString &name, const QString &value)

void	setAdditionalStyleAttribute (const char *name, const QString &value)

void	setAnchor (KoShapeAnchor *anchor)

void	setClipMask (KoClipMask *clipMask)
	Sets a new clip mask, removing the old one. The mask is owned by the shape.

void	setClipPath (KoClipPath *clipPath)
	Sets a new clip path, removing the old one.

void	setContentProtected (bool protect)

void	setFilterEffectStack (KoFilterEffectStack *filterEffectStack)
	Sets the new filter effect stack, removing the old one.

void	setGeometryProtected (bool on)

void	setHyperLink (const QString &hyperLink)

void	setInheritBackground (bool value)
	setInheritBackground marks a shape as inheriting the background from the parent shape. NOTE: The currently selected background is destroyed.

void	setInheritPaintOrder (bool value)
	setInheritPaintOrder set inherit paint order.

void	setInheritStroke (bool value)
	setInheritStroke marks a shape as inheriting the stroke from the parent shape. NOTE: The currently selected stroke is destroyed.

void	setKeepAspectRatio (bool keepAspect)

void	setMinimumHeight (qreal height)

void	setName (const QString &name)

void	setParent (KoShapeContainer *parent)

virtual void	setPosition (const QPointF &position)
	Set the position of the shape in pt.

void	setPrintable (bool on)

virtual void	setRunThrough (short int runThrough)

void	setSelectable (bool selectable)

void	setShadow (KoShapeShadow *shadow)
	Sets the new shadow, removing the old one.

void	setShapeId (const QString &id)

virtual void	setSize (const QSizeF &size)
	Resize the shape.

void	setTextRunAroundContour (TextRunAroundContour contour)

void	setTextRunAroundDistanceBottom (qreal distance)

void	setTextRunAroundDistanceLeft (qreal distance)

void	setTextRunAroundDistanceRight (qreal distance)

void	setTextRunAroundDistanceTop (qreal distance)

void	setTextRunAroundSide (TextRunAroundSide side, RunThroughLevel runThrough=Background)

void	setTextRunAroundThreshold (qreal threshold)

void	setToolDelegates (const QSet< KoShape * > &delegates)

void	setTransformation (const QTransform &matrix)

void	setTransparency (qreal transparency)

void	setUserData (KoShapeUserData *userData)

void	setVisible (bool on)

void	setZIndex (qint16 zIndex)

KoShapeShadow *	shadow () const
	Returns the currently set shadow or 0 if there is no shadow set.

virtual QPainterPath	shadowOutline () const

QString	shapeId () const

QPointF	shapeToDocument (const QPointF &point) const
	Transforms point from shape coordinates to document coordinates.

QRectF	shapeToDocument (const QRectF &rect) const
	Transforms rect from shape coordinates to document coordinates.

void	shear (qreal sx, qreal sy)
	Shear the shape The shape will be sheared using the zero-point which is the top-left corner.

virtual QSizeF	size () const
	Get the size of the shape in pt.

virtual KoSnapData	snapData () const
	Returns additional snap data the shape wants to have snapping to.

KoInsets	strokeInsets () const

TextRunAroundContour	textRunAroundContour () const

qreal	textRunAroundDistanceBottom () const

qreal	textRunAroundDistanceLeft () const

qreal	textRunAroundDistanceRight () const

qreal	textRunAroundDistanceTop () const

TextRunAroundSide	textRunAroundSide () const

qreal	textRunAroundThreshold () const

QSet< KoShape * >	toolDelegates () const

QTransform	transformation () const
	Returns the shapes local transformation matrix.

qreal	transparency (bool recursive=false) const

virtual void	update () const

virtual void	updateAbsolute (const QRectF &rect) const

KoShapeUserData *	userData () const

virtual void	waitUntilReady (bool asynchronous=true) const

qint16	zIndex () const

virtual	~KoShape ()
	Destructor.

Public Member Functions inherited from SvgShape
virtual bool	loadSvg (const QDomElement &element, SvgLoadingContext &context)
	Loads data from specified svg element.

void	saveMetadata (SvgSavingContext &context)

virtual	~SvgShape ()

Static Public Member Functions
static qreal	anchoredChunkShift (const QVector< CharacterResult > &result, const bool isHorizontal, const int start, int &end)

static void	applyAnchoring (QVector< CharacterResult > &result, bool isHorizontal, const KoSvgText::ResolutionHandler resHandler)

static void	applyTextPath (KisForest< KoSvgTextContentElement >::child_iterator parent, QVector< CharacterResult > &result, bool isHorizontal, QPointF &startPos, const KoSvgTextProperties resolvedProps)

static qreal	characterResultOnPath (CharacterResult &cr, qreal length, qreal offset, bool isHorizontal, bool isClosed)

static int	childCount (KisForest< KoSvgTextContentElement >::child_iterator it)
	Get the child count of the current node. A node without children is a text node.

static void	cleanUp (KisForest< KoSvgTextContentElement > &tree)
	cleanUp This cleans up the tree by...

static QVector< bool >	collapsedWhiteSpacesForText (KisForest< KoSvgTextContentElement > &tree, QString &allText, const bool alsoCollapseLowSurrogate=false)
	collapsedWhiteSpacesForText This returns the collapsed spaces for a given piece of text, without transforms.

static QVector< SubChunk >	collectSubChunks (KisForest< KoSvgTextContentElement >::child_iterator it, KoSvgTextProperties parent, bool textInPath, bool &firstTextInPath)

static void	computeFontMetrics (KisForest< KoSvgTextContentElement >::child_iterator parent, const KoSvgTextProperties &parentProps, const KoSvgText::FontMetrics &parentBaselineTable, const KoSvgText::Baseline parentBaseline, const QPointF superScript, const QPointF subScript, QVector< CharacterResult > &result, int &currentIndex, const KoSvgText::ResolutionHandler resHandler, const bool isHorizontal, const bool disableFontMatching)

static KoSvgTextNodeIndex	createTextNodeIndex (KisForest< KoSvgTextContentElement >::child_iterator textElement)

static const QString &	defaultPlaceholderText ()

static void	finalizeDecoration (QPainterPath decorationPath, const QPointF offset, const QPainterPathStroker &stroker, const KoSvgText::TextDecoration type, QMap< KoSvgText::TextDecoration, QPainterPath > &decorationPaths, const KoPathShape *currentTextPath, const bool isHorizontal, const qreal currentTextPathOffset, const bool textPathSide)

static KisForest< KoSvgTextContentElement >::depth_first_tail_iterator	findTextContentElementForIndex (KisForest< KoSvgTextContentElement > &tree, int &currentIndex, int sought, bool skipZeroWidth=false)
	findTextContentElementForIndex Finds the given leaf of the current tree-wide string index.

static void	handleLineBoxAlignment (KisForest< KoSvgTextContentElement >::child_iterator parent, QVector< CharacterResult > &result, const QVector< LineBox > lineBoxes, int &currentIndex, const bool isHorizontal, const KoSvgTextProperties resolvedProps)

static void	insertNewLinesAtAnchors (KisForest< KoSvgTextContentElement > &tree, bool shapesInside=false)
	insertNewLinesAtAnchors Resolves character transforms and then inserts new lines at each transform that creates a new chunk.

static void	insertNewLinesAtAnchorsImpl (std::reverse_iterator< KisForest< KoSvgTextContentElement >::child_iterator > current, QVector< KoSvgText::CharTransformation > &resolvedTransforms, bool &inTextPath)

static void	insertTransforms (KisForest< KoSvgTextContentElement > &tree, const int start, const int length, const bool allowSkipFirst)
	insertTransforms Inserts empty transforms into tree recursively.

static int	insertTransformsImpl (KisForest< KoSvgTextContentElement >::child_iterator currentTextElement, const int globalIndex, const int start, const int length, const QVector< bool > collapsedCharacters, const bool allowSkipFirst)
	insertTransformsImpl Recursive function that handles inserting empty transforms into a given range. Used by insertTransforms.

static KisForest< KoSvgTextContentElement >::child_iterator	iteratorForTreeIndex (const QVector< int > treeIndex, KisForest< KoSvgTextContentElement >::child_iterator parent)

static bool	loadGlyph (const KoSvgText::ResolutionHandler &resHandler, const FT_Int32 faceLoadFlags, const bool isHorizontal, const char32_t firstCodepoint, const KoSvgText::TextRendering rendering, raqm_glyph_t &currentGlyph, CharacterResult &charResult, QPointF &totalAdvanceFTFontCoordinates)

static std::pair< QTransform, qreal >	loadGlyphOnly (const QTransform &ftTF, FT_Int32 faceLoadFlags, bool isHorizontal, raqm_glyph_t &currentGlyph, CharacterResult &charResult, const KoSvgText::TextRendering rendering)

static int	numChars (KisForest< KoSvgTextContentElement >::child_iterator parent, bool withControls=false, KoSvgTextProperties resolvedProps=KoSvgTextProperties::defaultProperties())
	Get the number of characters for the whole subtree of this node.

static void	removeTransforms (KisForest< KoSvgTextContentElement > &tree, const int start, const int length)
	removeTransforms Remove all local SVG character transforms in a certain range. Local transforms are influenced by whitespace collapse and whether they are set to unicode codepoints, and they also accumulate from parent to child. This function removes all local transforms in a certain section.

static int	removeTransformsImpl (KisForest< KoSvgTextContentElement >::child_iterator currentTextElement, const int globalIndex, const int start, const int length, const QVector< bool > collapsedCharacters)
	removeTransformsImpl recursive function that handles removing local transforms in a certain range. Used by removeTransform.

static void	resolveTransforms (KisForest< KoSvgTextContentElement >::child_iterator currentTextElement, QString text, QVector< CharacterResult > &result, int &currentIndex, bool isHorizontal, bool wrapped, bool textInPath, QVector< KoSvgText::CharTransformation > &resolved, QVector< bool > collapsedChars, const KoSvgTextProperties resolvedProps, bool withControls=true)

static bool	splitContentElement (KisForest< KoSvgTextContentElement > &tree, int index)
	splitContentElement split the contentElement in tree at index into two nodes.

static bool	startIndexOfIterator (KisForest< KoSvgTextContentElement >::child_iterator parent, KisForest< KoSvgTextContentElement >::child_iterator target, int &currentIndex)

static QPainterPath	stretchGlyphOnPath (const QPainterPath &glyph, const QPainterPath &path, bool isHorizontal, qreal offset, bool isClosed)

Static Public Member Functions inherited from KoShape
static QRectF	absoluteOutlineRect (const QList< KoShape * > &shapes)

static QRectF	boundingRect (const QList< KoShape * > &shapes)

static bool	compareShapeZIndex (KoShape s1, KoShape s2)

static KisHandlePainterHelper	createHandlePainterHelperDocument (QPainter painter, KoShape shape, qreal handleRadius, int decorationThickness)

static KisHandlePainterHelper	createHandlePainterHelperView (QPainter painter, KoShape shape, const KoViewConverter &converter, qreal handleRadius=0.0, int decorationThickness=1)

static QVector< PaintOrder >	defaultPaintOrder ()
	default paint order as per SVG specification

static QList< KoShape * >	linearizeSubtree (const QList< KoShape * > &shapes)

static QList< KoShape * >	linearizeSubtreeSorted (const QList< KoShape * > &shapes)

Public Attributes
QVector< CursorPos >	cursorPos

bool	disableFontMatching = false
	Turn off font matching, which should speed up relayout slightly.

QPointF	initialTextPosition = QPointF()

bool	isBidi = false

bool	isLoading = false
	Turned on when loading in text data, blocks updates to shape listeners.

QVector< LineBox >	lineBoxes

QMap< int, int >	logicalToVisualCursorPos

QString	plainText

QVector< CharacterResult >	result

QList< KoShape * >	shapesInside

QList< KoShape * >	shapesSubtract

KisForest< KoSvgTextContentElement >	textData

int	xRes = 72

int	yRes = 72

Protected Member Functions
void	shapeChanged (ChangeType type, KoShape *shape) override

Protected Member Functions inherited from KoShape
	KoShape (const KoShape &rhs)

QList< ShapeChangeListener * >	listeners () const

void	setSizeImpl (const QSizeF &size) const

void	shapeChangedPriv (KoShape::ChangeType type)

QTransform	transform () const
	return the current matrix that contains the rotation/scale/position of this shape

Private Member Functions
QPainterPath	defaultCursorShape ()
	defaultCursorShape This returns a default cursor shape for when there's no text inside the text shape.

int	nextPos (int pos, bool visual)
	nextPos get the next position.

int	previousPos (int pos, bool visual)
	previousPos get the previous position.

void	setMementoImpl (const KoSvgTextShapeMementoSP memento)

Private Attributes
QScopedPointer< Private >	d

Private Attributes inherited from KoShape::Private
QList< KoShape * >	dependees
	list of shape dependent on this shape

QList< KoShape::ShapeChangeListener * >	listeners

KoShapeContainer *	parent

QSet< KoShapeManager * >	shapeManagers

QSet< KoShape * >	toolDelegates

Friends
class	KoSvgTextLoader

class	TestSvgText

Additional Inherited Members
Static Public Attributes inherited from KoShape
static const qint16	maxZIndex = std::numeric_limits<qint16>::max()

static const qint16	minZIndex = std::numeric_limits<qint16>::min()

Detailed Description

KoSvgTextShape is a root chunk of the <text> element subtree.

Definition at line 28 of file KoSvgTextShape.h.

Member Enumeration Documentation

◆ DebugElement

enum class KoSvgTextShape::DebugElement

strong

Enumerator
CharBbox
LineBox

Definition at line 46 of file KoSvgTextShape.h.

                            {
        CharBbox = 1 << 0,
        LineBox = 1 << 1,
    };

◆ TextType

enum KoSvgTextShape::TextType

Enumerator
PrePositionedText	SVG 1.1 text, white spaces are collapsed or only spaces are preserved. Identical to PreformattedText otherwise.
PreformattedText	Text-on-Path falls under this or PrePositionedText depending on collapse of lines. No wrapping, but preserves spaces and linebreaks.
InlineWrap	Uses inline size to wrap and preserves spaces.
TextInShape	Uses shape-inside to wrap and preserves spaces.

Definition at line 69 of file KoSvgTextShape.h.

                  {
        PrePositionedText = 0, 
        PreformattedText, 
        InlineWrap, 
        TextInShape 
    };

Constructor & Destructor Documentation

◆ KoSvgTextShape() [1/2]

KoSvgTextShape::KoSvgTextShape ( )

Definition at line 129 of file KoSvgTextShape.cpp.

    : KoShape()
    , d(new Private)
{
    setShapeId(KoSvgTextShape_SHAPEID);
    d->textData.insert(d->textData.childBegin(), KoSvgTextContentElement());
}

References d, KoSvgTextShape_SHAPEID, and KoShape::setShapeId().

◆ KoSvgTextShape() [2/2]

KoSvgTextShape::KoSvgTextShape ( const KoSvgTextShape & rhs )

Definition at line 137 of file KoSvgTextShape.cpp.

    : KoShape(rhs)
    , d(new Private(*rhs.d))
{
    setShapeId(KoSvgTextShape_SHAPEID);
}

References KoSvgTextShape_SHAPEID, and KoShape::setShapeId().

◆ ~KoSvgTextShape()

KoSvgTextShape::~KoSvgTextShape ( )

override

Definition at line 144 of file KoSvgTextShape.cpp.

145{

146}

◆ ~Private()

KoSvgTextShape::~Private ( )

inline

Definition at line 470 of file KoSvgTextShape_p.h.

               {
        qDeleteAll(shapesInside);
        qDeleteAll(shapesSubtract);
    }

Member Function Documentation

◆ anchoredChunkShift()

static qreal KoSvgTextShape::anchoredChunkShift	(	const QVector< CharacterResult > &	result,
		const bool	isHorizontal,
		const int	start,
		int &	end )

static

◆ applyAnchoring()

static void KoSvgTextShape::applyAnchoring	(	QVector< CharacterResult > &	result,
		bool	isHorizontal,
		const KoSvgText::ResolutionHandler	resHandler )

static

◆ applyTextLength()

void KoSvgTextShape::applyTextLength	(	KisForest< KoSvgTextContentElement >::child_iterator	currentTextElement,
		QVector< CharacterResult > &	result,
		int &	currentIndex,
		int &	resolvedDescendentNodes,
		bool	isHorizontal,
		const KoSvgTextProperties	resolvedProps,
		const KoSvgText::ResolutionHandler &	resHandler )

◆ applyTextPath()

static void KoSvgTextShape::applyTextPath	(	KisForest< KoSvgTextContentElement >::child_iterator	parent,
		QVector< CharacterResult > &	result,
		bool	isHorizontal,
		QPointF &	startPos,
		const KoSvgTextProperties	resolvedProps )

static

◆ applyWhiteSpace()

void KoSvgTextShape::applyWhiteSpace	(	KisForest< KoSvgTextContentElement > &	tree,
		const bool	convertToPreWrapped = false )

inline

applyWhiteSpace CSS Whitespace processes whitespaces so that duplicate white spaces and unnecessary hard breaks get removed from the text. Within the text layout we avoid removing the white spaces. However, when converting between text types it can be useful to remove these spaces. This function actually applies the white space rule to the active text.

Parameters

tree	– tree to apply the whitespace rule onto.
convertToPreWrapped	– switch all whitespace rules to pre-wrapped.

Definition at line 865 of file KoSvgTextShape_p.h.

                                                                                                           {
        QString allText;
        QVector<bool> collapsed = collapsedWhiteSpacesForText(tree, allText, false);
 
        auto end = std::make_reverse_iterator(tree.childBegin());
        auto begin = std::make_reverse_iterator(tree.childEnd());
 
        for (; begin != end; begin++) {
            applyWhiteSpaceImpl(begin, collapsed, allText, convertToPreWrapped);
        }
        if (convertToPreWrapped) {
            tree.childBegin()->properties.setProperty(KoSvgTextProperties::TextCollapseId, QVariant::fromValue(KoSvgText::Preserve));
            tree.childBegin()->properties.setProperty(KoSvgTextProperties::TextWrapId, QVariant::fromValue(KoSvgText::Wrap));
        }
    }

References KisForestDetail::Forest< T >::childBegin(), KisForestDetail::Forest< T >::childEnd(), KoSvgText::Preserve, KoSvgTextProperties::TextCollapseId, KoSvgTextProperties::TextWrapId, and KoSvgText::Wrap.

◆ applyWhiteSpaceImpl()

void KoSvgTextShape::applyWhiteSpaceImpl	(	std::reverse_iterator< KisForest< KoSvgTextContentElement >::child_iterator >	current,
		QVector< bool > &	collapsed,
		QString &	allText,
		const bool	convertToPreWrapped )

inline

Definition at line 881 of file KoSvgTextShape_p.h.

                                                                                                                                                                                        {
        auto base = current.base();
        // It seems that .base() refers to the next entry instead of the pointer,
        // which is coherent with the template implementation of "operator*" here:
        // https://en.cppreference.com/w/cpp/iterator/reverse_iterator.html
        base--;
        if(base != siblingEnd(base)) {
            auto end = std::make_reverse_iterator(childBegin(base));
            auto begin = std::make_reverse_iterator(childEnd(base));
            for (; begin != end; begin++) {
                applyWhiteSpaceImpl(begin, collapsed, allText, convertToPreWrapped);
            }
        }
 
        if (!current->text.isEmpty()) {
            const int total = current->text.size();
            QString currentText = allText.right(total);
 
            for (int i = 0; i < total; i++) {
                const int j = total - (i+1);
                const bool col = collapsed.takeLast();
                if (col) {
                    currentText.remove(j, 1);
                }
 
            }
            current->text = currentText;
            allText.chop(total);
        }
        if (convertToPreWrapped) {
            current->properties.removeProperty(KoSvgTextProperties::TextCollapseId);
            current->properties.removeProperty(KoSvgTextProperties::TextWrapId);
        }
    }

References KoSvgTextProperties::TextCollapseId, and KoSvgTextProperties::TextWrapId.

◆ background()

QSharedPointer< KoShapeBackground > KoSvgTextShape::background ( ) const

overridevirtual

Return the brush used to paint the background of this shape with. A QBrush can have a plain color, be fully transparent or have a complex fill. setting such a brush will allow the shape to fill itself using that brush and will be able to tell if its transparent or not.

Returns: the background-brush

Reimplemented from KoShape.

Definition at line 1148 of file KoSvgTextShape.cpp.

{
    KoSvgTextProperties props = KisForestDetail::size(d->textData)? d->textData.childBegin()->properties: KoSvgTextProperties();
    if (props.hasProperty(KoSvgTextProperties::FillId)) {
        return props.property(KoSvgTextProperties::FillId).value<KoSvgText::BackgroundProperty>().property;
    }
    return QSharedPointer<KoShapeBackground>(new KoColorBackground(Qt::black));
}

References d, KoSvgTextProperties::FillId, KoSvgTextProperties::hasProperty(), KoSvgTextProperties::properties(), KoSvgTextProperties::property(), and KisForestDetail::size().

◆ boundingRect()

QRectF KoSvgTextShape::boundingRect ( ) const

overridevirtual

Get the bounding box of the shape.

This includes the line width and the shadow of the shape

Returns: the bounding box of the shape

Reimplemented from KoShape.

Definition at line 1614 of file KoSvgTextShape.cpp.

{
    QRectF result;
    QList<KoShapeStrokeModelSP> parentStrokes;
    for (auto it = d->textData.compositionBegin(); it != d->textData.compositionEnd(); it++) {
        if (it.state() == KisForestDetail::Enter) {
            if (it->properties.hasProperty(KoSvgTextProperties::StrokeId)) {
                parentStrokes.append(it->properties.property(KoSvgTextProperties::StrokeId).value<KoSvgText::StrokeProperty>().property);
            }
        } else {
            KoShapeStrokeModelSP stroke = parentStrokes.size() > 0? parentStrokes.last(): nullptr;
            QRectF bb = it->associatedOutline.boundingRect();
            QMap<KoSvgText::TextDecoration, QPainterPath> decorations = it->textDecorations;
            for (int i = 0; i < decorations.values().size(); ++i) {
                bb |= decorations.values().at(i).boundingRect();
            }
            if (!bb.isEmpty()) {
                if (stroke) {
                    KoInsets insets;
                    stroke->strokeInsets(this, insets);
                    result |= bb.adjusted(-insets.left, -insets.top, insets.right, insets.bottom);
                } else {
                    result |= bb;
                }
            }
            if (it->properties.hasProperty(KoSvgTextProperties::StrokeId)) {
                // reset stroke to use parent stroke.
                parentStrokes.pop_back();
            }
        }
    }
    return this->absoluteTransformation().mapRect(result);
}

References KoShape::absoluteTransformation(), KoInsets::bottom, d, KisForestDetail::Enter, KoInsets::left, result, KoInsets::right, stroke(), KoSvgTextProperties::StrokeId, and KoInsets::top.

◆ characterResultOnPath()

static qreal KoSvgTextShape::characterResultOnPath	(	CharacterResult &	cr,
		qreal	length,
		qreal	offset,
		bool	isHorizontal,
		bool	isClosed )

static

◆ childCount()

static int KoSvgTextShape::childCount ( KisForest< KoSvgTextContentElement >::child_iterator it )

inlinestatic

Get the child count of the current node. A node without children is a text node.

Definition at line 608 of file KoSvgTextShape_p.h.

                                                                               {
        return std::distance(KisForestDetail::childBegin(it), KisForestDetail::childEnd(it));
    }

References KisForestDetail::childBegin(), and KisForestDetail::childEnd().

◆ cleanUp() [1/2]

void KoSvgTextShape::cleanUp ( )

Cleans up the internal text data. Used by undo commands.

Definition at line 1095 of file KoSvgTextShape.cpp.

{
    KoSvgTextShape::Private::cleanUp(d->textData);
    notifyChanged();
    shapeChangedPriv(ContentChanged);
}

References KoShape::ContentChanged, d, KoShape::notifyChanged(), and KoShape::shapeChangedPriv().

◆ cleanUp() [2/2]

static void KoSvgTextShape::cleanUp ( KisForest< KoSvgTextContentElement > & tree )

inlinestatic

cleanUp This cleans up the tree by...

Removing empty text elements that are not the root or text paths.
Merging sibling elements with similar properties.
Merging single children with parent if possible.
Parameters

tree – tree to clean up

Definition at line 1069 of file KoSvgTextShape_p.h.

                                                                  {
        for (auto it = tree.depthFirstTailBegin(); it != tree.depthFirstTailEnd(); it++) {
            const int children = childCount(siblingCurrent(it));
            if (children == 0) {
 
                // Remove empty leafs that are not the root or text paths.
                const int length = it->numChars(false);
                if (length == 0 && siblingCurrent(it) != tree.childBegin() && !it->textPath) {
                    tree.erase(siblingCurrent(it));
                } else {
                    // check if siblings are similar.
                    auto siblingPrev = siblingCurrent(it);
                    KoSvgText::UnicodeBidi bidi = KoSvgText::UnicodeBidi(it->properties.property(KoSvgTextProperties::UnicodeBidiId,
                                                                                                 QVariant(KoSvgText::BidiNormal)).toInt());
                    siblingPrev--;
                    if (!isEnd(siblingPrev)
                            && siblingPrev != siblingCurrent(it)
                            && (siblingPrev->localTransformations.isEmpty() && it->localTransformations.isEmpty())
                            && (!siblingPrev->textPath && !it->textPath)
                            && (siblingPrev->textLength.isAuto && it->textLength.isAuto)
                            && (siblingPrev->properties == it->properties)
                            && (bidi != KoSvgText::BidiIsolate && bidi != KoSvgText::BidiIsolateOverride)) {
                        // TODO: handle localtransforms better; annoyingly, this requires whitespace handling
                        siblingPrev->text += it->text;
                        tree.erase(siblingCurrent(it));
                    }
                }
            } else if (children == 1) {
                // merge single children into parents if possible.
                auto child = childBegin(siblingCurrent(it));
                if ((child->localTransformations.isEmpty() && it->localTransformations.isEmpty())
                        && (!child->textPath && !it->textPath)
                        && (child->textLength.isAuto && it->textLength.isAuto)
                        && (!child->properties.hasNonInheritableProperties() || !it->properties.hasNonInheritableProperties())) {
                    if (it->properties.hasNonInheritableProperties()) {
                        KoSvgTextProperties props = it->properties;
                        props.setAllButNonInheritableProperties(child->properties);
                        child->properties = props;
                    } else {
                        child->properties.inheritFrom(it->properties);
                    }
                    tree.move(child, siblingCurrent(it));
                    tree.erase(siblingCurrent(it));
                }
            }
        }
    }

References KoSvgText::BidiIsolate, KoSvgText::BidiIsolateOverride, KoSvgText::BidiNormal, KisForestDetail::Forest< T >::childBegin(), KisForestDetail::Forest< T >::depthFirstTailBegin(), KisForestDetail::Forest< T >::depthFirstTailEnd(), KisForestDetail::Forest< T >::erase(), length(), KisForestDetail::Forest< T >::move(), KoSvgTextProperties::properties(), KoSvgTextProperties::setAllButNonInheritableProperties(), and KoSvgTextProperties::UnicodeBidiId.

◆ clearAssociatedOutlines()

void KoSvgTextShape::clearAssociatedOutlines ( )

◆ cloneShape()

KoShape * KoSvgTextShape::cloneShape ( ) const

overridevirtual

creates a deep copy of the shape or shape's subtree

Returns: a cloned shape

Reimplemented from KoShape.

Definition at line 154 of file KoSvgTextShape.cpp.

{
    return new KoSvgTextShape(*this);
}

References KoSvgTextShape().

◆ collapsedWhiteSpacesForText()

static QVector< bool > KoSvgTextShape::collapsedWhiteSpacesForText	(	KisForest< KoSvgTextContentElement > &	tree,
		QString &	allText,
		const bool	alsoCollapseLowSurrogate = false )

inlinestatic

collapsedWhiteSpacesForText This returns the collapsed spaces for a given piece of text, without transforms.

Parameters

tree	– text data tree.
allText	– some collapseMethods modify the text. This is a pointer that sets the modified text.
alsoCollapseLowSurrogate	– whether to mark utf16 surrogates as collapsed too.

Returns: list of collapsed characters

Definition at line 703 of file KoSvgTextShape_p.h.

                                                                                                                                                              {
        QMap<int, KoSvgText::TextSpaceCollapse> collapseModes;
 
        QList<KoSvgTextProperties> parentProps = {KoSvgTextProperties::defaultProperties()};
        for (auto it = tree.compositionBegin(); it != tree.compositionEnd(); it++) {
            if (it.state() == KisForestDetail::Enter) {
                KoSvgTextProperties ownProperties = it->properties;
                ownProperties.inheritFrom(parentProps.last());
                parentProps.append(ownProperties);
 
                const int children = childCount(siblingCurrent(it));
                if (children == 0) {
                    QString text = it->text;
                    KoSvgText::TextSpaceCollapse collapse = KoSvgText::TextSpaceCollapse(parentProps.last().propertyOrDefault(KoSvgTextProperties::TextCollapseId).toInt());
                    collapseModes.insert(allText.size(), collapse);
                    allText += text;
                }
            } else {
                parentProps.pop_back();
            }
        }
        QVector<bool> collapsed = KoCssTextUtils::collapseSpaces(&allText, collapseModes);
 
        if (alsoCollapseLowSurrogate) {
            for (int i = 0; i < allText.size(); i++) {
                if (i > 0 && allText.at(i).isLowSurrogate() && allText.at(i-1).isHighSurrogate()) {
                    collapsed[i] = true;
                }
            }
        }
        return collapsed;
    }

References KoCssTextUtils::collapseSpaces(), KisForestDetail::Forest< T >::compositionBegin(), KisForestDetail::Forest< T >::compositionEnd(), KoSvgTextProperties::defaultProperties(), KisForestDetail::Enter, KoSvgTextProperties::inheritFrom(), KoSvgTextProperties::properties(), and KoSvgTextProperties::TextCollapseId.

◆ collectPaths()

KoShape * KoSvgTextShape::collectPaths	(	const KoShape *	rootShape,
		QVector< CharacterResult > &	result,
		int &	currentIndex )

◆ collectSubChunks()

static QVector< SubChunk > KoSvgTextShape::collectSubChunks	(	KisForest< KoSvgTextContentElement >::child_iterator	it,
		KoSvgTextProperties	parent,
		bool	textInPath,
		bool &	firstTextInPath )

static

Return a linearized representation of a subtree of text "subchunks".

◆ computeFontMetrics()

static void KoSvgTextShape::computeFontMetrics	(	KisForest< KoSvgTextContentElement >::child_iterator	parent,
		const KoSvgTextProperties &	parentProps,
		const KoSvgText::FontMetrics &	parentBaselineTable,
		const KoSvgText::Baseline	parentBaseline,
		const QPointF	superScript,
		const QPointF	subScript,
		QVector< CharacterResult > &	result,
		int &	currentIndex,
		const KoSvgText::ResolutionHandler	resHandler,
		const bool	isHorizontal,
		const bool	disableFontMatching )

static

◆ computeTextDecorations()

void KoSvgTextShape::computeTextDecorations	(	KisForest< KoSvgTextContentElement >::child_iterator	currentTextElement,
		const QVector< CharacterResult > &	result,
		const QMap< int, int > &	logicalToVisual,
		const KoSvgText::ResolutionHandler	resHandler,
		KoPathShape *	textPath,
		qreal	textPathoffset,
		bool	side,
		int &	currentIndex,
		bool	isHorizontal,
		bool	ltr,
		bool	wrapping,
		const KoSvgTextProperties	resolvedProps )

◆ convertCharTransformsToPreformatted()

void KoSvgTextShape::convertCharTransformsToPreformatted ( bool makeInlineSize = false )

convertCharTransformsToPreformatted Converts the text to a preformatted SVG 2.0 text. This changes the textType();

Parameters

makeInlineSize – whether to have inline size applied.

Definition at line 1259 of file KoSvgTextShape.cpp.

{
    const int inlineSize = writingMode() == KoSvgText::HorizontalTB? outlineRect().width(): outlineRect().height();
    d->applyWhiteSpace(d->textData, true);
    d->insertNewLinesAtAnchors(d->textData, !d->shapesInside.isEmpty());
    d->cleanUp(d->textData);
 
    KoSvgTextProperties props = this->propertiesForPos(-1);
    if (makeInlineSize) {
        KoSvgText::AutoValue val;
        // Using QCeil here because otherwise the text will layout too tight.
        val.customValue = qCeil(inlineSize);
        val.isAuto = false;
        if (!props.hasProperty(KoSvgTextProperties::InlineSizeId)) {
            props.setProperty(KoSvgTextProperties::InlineSizeId, QVariant::fromValue(val));
        }
    } else {
        props.removeProperty(KoSvgTextProperties::InlineSizeId);
    }
    // NOTE: applyWhiteSpace and insertNewLines don't notify changes,
    // so setProperties is the only thing triggering relayout();
    setPropertiesAtPos(-1, props);
}

References KoSvgText::AutoValue::customValue, d, KoSvgTextProperties::hasProperty(), KoSvgText::HorizontalTB, KoSvgTextProperties::InlineSizeId, KoSvgText::AutoValue::isAuto, outlineRect(), propertiesForPos(), KoSvgTextProperties::removeProperty(), setPropertiesAtPos(), KoSvgTextProperties::setProperty(), and writingMode().

◆ copyRange()

std::unique_ptr< KoSvgTextShape > KoSvgTextShape::copyRange	(	int	index,
		int	length ) const

copyRange Copy the rich text for the given range.

Parameters

index	– start string index of the range.
length	– length of the range.

Returns: a KoSvgTextShape with only the content elements inside the range.

Definition at line 1041 of file KoSvgTextShape.cpp.

{
    KoSvgTextShape *clone = new KoSvgTextShape(*this);
    int zero = 0;
    int endRange = index + length;
    int size = KoSvgTextShape::Private::numChars(clone->d->textData.childBegin(), false) - endRange;
    clone->removeText(endRange, size);
    clone->removeText(zero, index);
    KoSvgTextShape::Private::cleanUp(clone->d->textData);
    return std::unique_ptr<KoSvgTextShape>(clone);
}

References d, KoSvgTextShape(), length(), removeText(), and KoShape::size().

◆ createTextNodeIndex()

static KoSvgTextNodeIndex KoSvgTextShape::createTextNodeIndex ( KisForest< KoSvgTextContentElement >::child_iterator textElement )

static

◆ cursorForPos()

QPainterPath KoSvgTextShape::cursorForPos	(	int	pos,
		QLineF &	caret,
		QColor &	color,
		double	bidiFlagSize = 1.0 )

cursorForPos returns the QPainterPath associated with this cursorPosition.

Parameters

pos	the cursor Position
bidiFlagSize	– size of the bidirectional indicator.

Returns: a path to draw a cursor with.

Definition at line 541 of file KoSvgTextShape.cpp.

{
    if (d->result.isEmpty() || d->cursorPos.isEmpty() || pos < 0 || pos >= d->cursorPos.size()) {
        return defaultCursorShape();
    }
    QPainterPath p;
 
    CursorPos cursorPos = d->cursorPos.at(pos);
 
    CharacterResult res = d->result.at(cursorPos.cluster);
 
    const QTransform tf = res.finalTransform();
    color = res.cursorInfo.color;
    caret = res.cursorInfo.caret;
    caret.translate(res.cursorInfo.offsets.value(cursorPos.offset, QPointF()));
 
    p.moveTo(tf.map(caret.p1()));
    p.lineTo(tf.map(caret.p2()));
    if (d->isBidi && bidiFlagSize > 0) {
        int sign = res.cursorInfo.rtl ? -1 : 1;
        double bidiFlagHalf = bidiFlagSize * 0.5;
        QPointF point3;
        QPointF point4;
        if (writingMode() == KoSvgText::HorizontalTB) {
            qreal slope = bidiFlagHalf * (caret.dx()/ caret.dy());
            point3 = QPointF(caret.p2().x() + slope + (sign * bidiFlagHalf), caret.p2().y() + bidiFlagHalf);
            point4 = QPointF(point3.x() + slope - (sign * bidiFlagHalf),point3.y() + bidiFlagHalf);
        } else {
            qreal slope = bidiFlagHalf * (caret.dy()/ caret.dx());
            point3 = QPointF(caret.p2().x() - bidiFlagHalf, caret.p2().y() - slope + (sign * bidiFlagHalf));
            point4 = QPointF(point3.x() - bidiFlagHalf, point3.y() - slope - (sign * bidiFlagHalf));
        }
        p.lineTo(tf.map(point3));
        p.lineTo(tf.map(point4));
    }
    caret = tf.map(caret);
 
    return p;
}

References CursorInfo::caret, CursorInfo::color, CharacterResult::cursorInfo, cursorPos, d, defaultCursorShape(), CharacterResult::finalTransform(), KoSvgText::HorizontalTB, CursorInfo::offsets, p, CursorInfo::rtl, sign(), and writingMode().

◆ debugParsing()

void KoSvgTextShape::debugParsing ( )

Outputs debug with the current textData tree.

Definition at line 1488 of file KoSvgTextShape.cpp.

{
    qDebug() << "Tree size:" << KisForestDetail::size(d->textData);
    QString spaces;
    for (auto it = compositionBegin(d->textData); it != compositionEnd(d->textData); it++) {
        if (it.state() == KisForestDetail::Enter) {
 
            qDebug() << QString(spaces + "+") << it->text;
            qDebug() << QString(spaces + "|") << it->properties.convertToSvgTextAttributes();
            qDebug() << QString(spaces + "| PropertyType:") << it->properties.property(KoSvgTextProperties::KraTextStyleType).toString();
            qDebug() << QString(spaces + "| Fill set: ") << it->properties.hasProperty(KoSvgTextProperties::FillId);
            qDebug() << QString(spaces + "| Stroke set: ") << it->properties.hasProperty(KoSvgTextProperties::StrokeId);
            qDebug() << QString(spaces + "| Opacity: ") << it->properties.property(KoSvgTextProperties::Opacity);
            qDebug() << QString(spaces + "| PaintOrder: ") << it->properties.hasProperty(KoSvgTextProperties::PaintOrder);
            qDebug() << QString(spaces + "| Visibility set: ") << it->properties.hasProperty(KoSvgTextProperties::Visiblity);
            qDebug() << QString(spaces + "| TextPath set: ") << (!it->textPath.isNull());
            qDebug() << QString(spaces + "| Transforms set: ") << it->localTransformations;
            spaces.append(" ");
        }
 
        if (it.state() == KisForestDetail::Leave) {
            spaces.chop(1);
        }
    }
}

References d, KisForestDetail::Enter, KoSvgTextProperties::FillId, KoSvgTextProperties::KraTextStyleType, KisForestDetail::Leave, KoSvgTextProperties::Opacity, KoSvgTextProperties::PaintOrder, KisForestDetail::size(), KoSvgTextProperties::StrokeId, and KoSvgTextProperties::Visiblity.

◆ defaultCursorShape()

QPainterPath KoSvgTextShape::defaultCursorShape ( )

private

defaultCursorShape This returns a default cursor shape for when there's no text inside the text shape.

Returns: a QPainterPath for a cursor.

Definition at line 524 of file KoSvgTextShape.cpp.

{
    KoSvgText::WritingMode mode = writingMode();
    double fontSize = this->textProperties().fontSize().value;
    QPainterPath p;
    if (mode == KoSvgText::HorizontalTB) {
        p.moveTo(0, fontSize*0.2);
        p.lineTo(0, -fontSize);
    } else {
        p.moveTo(-fontSize * 0.5, 0);
        p.lineTo(fontSize, 0);
    }
    p.translate(d->initialTextPosition);
 
    return p;
}

References d, KoSvgTextProperties::fontSize(), KoSvgText::HorizontalTB, p, textProperties(), KoSvgText::CssLengthPercentage::value, and writingMode().

◆ defaultPlaceholderText()

const QString & KoSvgTextShape::defaultPlaceholderText ( )

static

Definition at line 148 of file KoSvgTextShape.cpp.

{
    static const QString s_placeholderText = i18nc("Default text for the text shape", "Placeholder Text");
    return s_placeholderText;
}

◆ enterNodeSubtree()

void KoSvgTextShape::enterNodeSubtree ( )

Set the current node to its first child, entering the subtree.

Definition at line 1437 of file KoSvgTextShape.cpp.

{
 
}

◆ finalizeDecoration()

static void KoSvgTextShape::finalizeDecoration	(	QPainterPath	decorationPath,
		const QPointF	offset,
		const QPainterPathStroker &	stroker,
		const KoSvgText::TextDecoration	type,
		QMap< KoSvgText::TextDecoration, QPainterPath > &	decorationPaths,
		const KoPathShape *	currentTextPath,
		const bool	isHorizontal,
		const qreal	currentTextPathOffset,
		const bool	textPathSide )

static

◆ findNodeIndexForPropertyId()

KoSvgTextNodeIndex KoSvgTextShape::findNodeIndexForPropertyId ( KoSvgTextProperties::PropertyId propertyId )

findNodeIndexForPropertyId

Returns: the nodeIndex of the first content element found with a given property id. @propertyId -- id to search for.

Definition at line 1116 of file KoSvgTextShape.cpp.

{
    for (auto it = d->textData.childBegin(); it != d->textData.childEnd(); it++) {
        if (it->properties.hasProperty(propertyId)) {
            return Private::createTextNodeIndex(it);
        } else if (KisForestDetail::childBegin(it) != KisForestDetail::childEnd(it)) {
            auto found = findNodeIndexForPropertyIdImpl(it, propertyId);
            if (found != it) {
                return Private::createTextNodeIndex(found);
            }
        }
    }
    return Private::createTextNodeIndex(d->textData.childBegin());
}

References KisForestDetail::childBegin(), KisForestDetail::childEnd(), d, and findNodeIndexForPropertyIdImpl().

◆ findRangeForNodeIndex()

QPair< int, int > KoSvgTextShape::findRangeForNodeIndex ( const KoSvgTextNodeIndex & node ) const

findRangeForNodeIndex Find the start and end cursor position for a given nodeIndex.

Parameters

node	the tree index to find the range for.

Returns: A QPair<int,int> describing cursor position range encompassed by the tree index and it's children. Will return {-1, -1} when the tree index is invalid.

Definition at line 1131 of file KoSvgTextShape.cpp.

{
    int startIndex = 0;
    int endIndex = 0;
    for (auto child = d->textData.childBegin(); child != d->textData.childEnd(); child++) {
        // count children
        d->startIndexOfIterator(child, node.d->textElement, startIndex);
        endIndex = d->numChars(node.d->textElement) + startIndex;
    }
    return qMakePair(posForIndex(startIndex), posForIndex(endIndex));
}

References d, KoSvgTextNodeIndex::d, and posForIndex().

◆ findTextContentElementForIndex()

static KisForest< KoSvgTextContentElement >::depth_first_tail_iterator KoSvgTextShape::findTextContentElementForIndex	(	KisForest< KoSvgTextContentElement > &	tree,
		int &	currentIndex,
		int	sought,
		bool	skipZeroWidth = false )

inlinestatic

findTextContentElementForIndex Finds the given leaf of the current tree-wide string index.

Parameters

tree	– tree to search in.
currentIndex	– currentIndex, will always be set to the start index of the found element.
sought	– index sought.
skipZeroWidth	– whether to explicitly skip zero-width chunks. Remove text may set this to true, while inserting text into empty chunks requires this to be false.

Returns: iterator – found iterator. Will default to tree end if nothing is found.

Definition at line 625 of file KoSvgTextShape_p.h.

    {
        auto it = tree.depthFirstTailBegin();
        for (; it != tree.depthFirstTailEnd(); it++) {
            if (childCount(siblingCurrent(it)) > 0) {
                continue;
            }
            int length = it->numChars(false);
            if (length == 0 && skipZeroWidth) {
                continue;
            }
 
            if (sought == currentIndex || (sought > currentIndex && sought < currentIndex + length)) {
                break;
            } else {
                currentIndex += length;
            }
        }
        return it;
    }

References KisForestDetail::Forest< T >::depthFirstTailBegin(), KisForestDetail::Forest< T >::depthFirstTailEnd(), and length().

◆ fontMatchingDisabled()

bool KoSvgTextShape::fontMatchingDisabled ( ) const

fontMatchingDisabled

Returns: whether font matching is disabled for this shape.

Definition at line 1529 of file KoSvgTextShape.cpp.

{
    return d->disableFontMatching;
}

References d.

◆ generateDecorationPaths()

QMap< KoSvgText::TextDecoration, QPainterPath > KoSvgTextShape::generateDecorationPaths	(	const int &	start,
		const int &	end,
		const KoSvgText::ResolutionHandler	resHandler,
		const QVector< CharacterResult > &	result,
		const bool	isHorizontal,
		const KoSvgText::TextDecorations &	decor,
		const KoSvgText::TextDecorationStyle	style = KoSvgText::TextDecorationStyle::Solid,
		const bool	textDecorationSkipInset = false,
		const KoPathShape *	currentTextPath = nullptr,
		const qreal	currentTextPathOffset = 0.0,
		const bool	textPathSide = false,
		const KoSvgText::TextDecorationUnderlinePosition	underlinePosH = KoSvgText::TextDecorationUnderlinePosition::UnderlineAuto,
		const KoSvgText::TextDecorationUnderlinePosition	underlinePosV = KoSvgText::TextDecorationUnderlinePosition::UnderlineAuto )

◆ getMemento()

KoSvgTextShapeMementoSP KoSvgTextShape::getMemento ( )

Get a memento holding the current textdata and layout info.

Definition at line 1447 of file KoSvgTextShape.cpp.

{
    return KoSvgTextShapeMementoSP(new KoSvgTextShapeMementoImpl(d->textData,
                                                                 d->result,
                                                                 d->lineBoxes,
                                                                 d->cursorPos,
                                                                 d->logicalToVisualCursorPos,
                                                                 d->plainText,
                                                                 d->isBidi,
                                                                 d->initialTextPosition));
}

References d.

◆ handleLineBoxAlignment()

static void KoSvgTextShape::handleLineBoxAlignment	(	KisForest< KoSvgTextContentElement >::child_iterator	parent,
		QVector< CharacterResult > &	result,
		const QVector< LineBox >	lineBoxes,
		int &	currentIndex,
		const bool	isHorizontal,
		const KoSvgTextProperties	resolvedProps )

static

◆ indexForPos()

int KoSvgTextShape::indexForPos ( int pos ) const

indexForPos get the string index for a given cursor position.

Parameters

pos	the cursor position.

Returns: the index in the string.

Definition at line 796 of file KoSvgTextShape.cpp.

{
    if (d->cursorPos.isEmpty() || pos < 0) {
        return -1;
    }
 
    return d->cursorPos.at(qMin(d->cursorPos.size()-1, pos)).index;
}

References d.

◆ initialTextPosition()

QPointF KoSvgTextShape::initialTextPosition ( ) const

initialTextPosition Returns the initial text position as per SVG algorithm. The eventual result of this can include transforms or repositioning due to text shapes.

Returns: the initial text position in shape coordinates.

◆ insertNewLinesAtAnchors()

static void KoSvgTextShape::insertNewLinesAtAnchors	(	KisForest< KoSvgTextContentElement > &	tree,
		bool	shapesInside = false )

inlinestatic

insertNewLinesAtAnchors Resolves character transforms and then inserts new lines at each transform that creates a new chunk.

Parameters

tree	– tree to apply to.
shapesInside	– whether we're wrapping in shape.

Definition at line 923 of file KoSvgTextShape_p.h.

                                                                                                             {
        QString all;
        QVector<bool> collapsed = collapsedWhiteSpacesForText(tree, all, false);
        QVector<CharacterResult> result(all.size());
        int globalIndex = 0;
        KoSvgTextProperties props = tree.childBegin()->properties;
        props.inheritFrom(KoSvgTextProperties::defaultProperties(), true);
        KoSvgText::WritingMode mode = KoSvgText::WritingMode(
                    props.propertyOrDefault(KoSvgTextProperties::WritingModeId).toInt());
        bool isHorizontal = mode == KoSvgText::HorizontalTB;
        bool isWrapped = (props.hasProperty(KoSvgTextProperties::InlineSizeId)
                          || shapesInside);
        QVector<KoSvgText::CharTransformation> resolvedTransforms(all.size());
        resolveTransforms(tree.childBegin(), all, result, globalIndex,
                          isHorizontal, isWrapped, false, resolvedTransforms,
                          collapsed, KoSvgTextProperties::defaultProperties(),
                          false);
 
        auto end = std::make_reverse_iterator(tree.childBegin());
        auto begin = std::make_reverse_iterator(tree.childEnd());
 
        bool inTextPath = false;
        for (; begin != end; begin++) {
            insertNewLinesAtAnchorsImpl(begin, resolvedTransforms, inTextPath);
        }
    }

References KisForestDetail::Forest< T >::childBegin(), KisForestDetail::Forest< T >::childEnd(), KoSvgTextProperties::defaultProperties(), KoSvgTextProperties::hasProperty(), KoSvgText::HorizontalTB, KoSvgTextProperties::inheritFrom(), KoSvgTextProperties::InlineSizeId, KoSvgTextProperties::propertyOrDefault(), and KoSvgTextProperties::WritingModeId.

◆ insertNewLinesAtAnchorsImpl()

static void KoSvgTextShape::insertNewLinesAtAnchorsImpl	(	std::reverse_iterator< KisForest< KoSvgTextContentElement >::child_iterator >	current,
		QVector< KoSvgText::CharTransformation > &	resolvedTransforms,
		bool &	inTextPath )

inlinestatic

Because sometimes we have to deal with multiple transforms on a span we only really want to insert newlines when at a content element start. In theory the other transforms can be tested, but this is hard, and semantically it doesn't make sense if a svg text does this.

Definition at line 950 of file KoSvgTextShape_p.h.

                                                              {
 
        inTextPath = (!current->textPath.isNull());
        auto base = current.base();
        base--;
        if(base != siblingEnd(base)) {
            auto end = std::make_reverse_iterator(childBegin(base));
            auto begin = std::make_reverse_iterator(childEnd(base));
            for (; begin != end; begin++) {
                insertNewLinesAtAnchorsImpl(begin,
                                            resolvedTransforms,
                                            inTextPath);
            }
        }
 
        if (!current->text.isEmpty()) {
            const int total = current->text.size();
 
            for (int i = 0; i < total; i++) {
                const int j = total - (i+1);
                KoSvgText::CharTransformation transform = resolvedTransforms.takeLast();
                bool startsNewChunk = transform.startsNewChunk() && j == 0;
 
                if (inTextPath) {
                    // First transform in path is always absolute, so we don't insert a newline.
                    startsNewChunk = false;
                    inTextPath = false;
                }
                // When there's no new chunk, we're not at the start of the text and there isn't already a line feed, insert a line feed.
                if (startsNewChunk && !resolvedTransforms.isEmpty() && current->text.at(j) != QChar::LineFeed) {
                    current->text.insert(j, "\n");
                }
            }
        }
        current->localTransformations.clear();
    }

◆ insertRichText()

bool KoSvgTextShape::insertRichText	(	int	pos,
		const KoSvgTextShape *	richText )

insertRichText Insert rich text at the given cursor pos. This will first split contents at the given pos before inserting the new rich text.

Parameters

pos	– cursor pos to insert at.
richText	– KoSvgTextShape with rich text data. TODO: make this const once KisForest constness issues have been fixed.

Returns: whether insertion happened successfully.

Definition at line 1053 of file KoSvgTextShape.cpp.

{
    bool success = false;
    int currentIndex = 0;
    int elementIndex = 0;
    int insertionIndex = 0;
 
    if (isEnd(richText->d->textData.childBegin())) {
        // rich text is empty.
        return success;
    }
 
    if (pos > -1 && !d->cursorPos.isEmpty()) {
        CursorPos cursorPos = d->cursorPos.at(qMin(d->cursorPos.size()-1, pos));
        CharacterResult res = d->result.at(cursorPos.cluster);
        elementIndex = res.plaintTextIndex;
        insertionIndex = cursorPos.index;
        elementIndex = qMin(elementIndex, d->result.size()-1);
    }
 
    KoSvgTextShape::Private::splitContentElement(this->d->textData, insertionIndex);
 
    auto it = d->findTextContentElementForIndex(d->textData, currentIndex, insertionIndex);
    if (it != d->textData.depthFirstTailEnd()) {
        d->textData.move(richText->d->textData.childBegin(), siblingCurrent(it));
        success = true;
    } else {
        currentIndex = 0;
        it = d->findTextContentElementForIndex(d->textData, currentIndex, elementIndex);
        if (it != d->textData.depthFirstTailEnd()) {
            d->textData.move(richText->d->textData.childBegin(), siblingEnd(siblingCurrent(it)));
            success = true;
        }
    }
 
    if (success) {
        notifyChanged();
        shapeChangedPriv(ContentChanged);
    }
    return success;
}

References KoShape::ContentChanged, cursorPos, d, KoShape::notifyChanged(), CharacterResult::plaintTextIndex, and KoShape::shapeChangedPriv().

◆ insertText()

bool KoSvgTextShape::insertText	(	int	pos,
		QString	text )

insertText Insert a text somewhere in the KoTextShape.

Parameters

pos	the cursor position.
text	the text to insert.

Returns: whether it was successful in inserting text.

< Current position of the search.

The distinction between element and insertion index allows us to insert text at the start or end of a content element, without ambiguity on whether we're inserting into the next element.

Definition at line 810 of file KoSvgTextShape.cpp.

{
    bool success = false;
    int currentIndex = 0; 
 
    int elementIndex = 0;
    int insertionIndex = 0;
    if (pos > -1 && !d->cursorPos.isEmpty()) {
        CursorPos cursorPos = d->cursorPos.at(pos);
        CharacterResult res = d->result.at(cursorPos.cluster);
        elementIndex = res.plaintTextIndex;
        insertionIndex = cursorPos.index;
        elementIndex = qMin(elementIndex, d->result.size()-1);
    }
    auto it = d->findTextContentElementForIndex(d->textData, currentIndex, elementIndex);
    if (it != d->textData.depthFirstTailEnd()) {
        const int offset = insertionIndex - currentIndex;
        it->insertText(offset, text);
 
        d->insertTransforms(d->textData, insertionIndex, text.size(), (elementIndex == insertionIndex));
        notifyChanged();
        shapeChangedPriv(ContentChanged);
        success = true;
    }
    return success;
}

References KoShape::ContentChanged, cursorPos, d, KoShape::notifyChanged(), CharacterResult::plaintTextIndex, and KoShape::shapeChangedPriv().

◆ insertTransforms()

static void KoSvgTextShape::insertTransforms	(	KisForest< KoSvgTextContentElement > &	tree,
		const int	start,
		const int	length,
		const bool	allowSkipFirst )

inlinestatic

insertTransforms Inserts empty transforms into tree recursively.

Parameters

tree	– tree to insert transforms on.
start	– start index.
length	– amount of transforms to insert.
allowSkipFirst	– whether we're allowed to skip the first transform because it is at the start of a text element.

Definition at line 802 of file KoSvgTextShape_p.h.

                                                                                                                                         {
        QString all;
        QVector<bool> collapsedCharacters = collapsedWhiteSpacesForText(tree, all, true);
 
        auto root = tree.childBegin();
        insertTransformsImpl(root, 0, start, length, collapsedCharacters, allowSkipFirst);
    }

References KisForestDetail::Forest< T >::childBegin(), and length().

◆ insertTransformsImpl()

static int KoSvgTextShape::insertTransformsImpl	(	KisForest< KoSvgTextContentElement >::child_iterator	currentTextElement,
		const int	globalIndex,
		const int	start,
		const int	length,
		const QVector< bool >	collapsedCharacters,
		const bool	allowSkipFirst )

inlinestatic

insertTransformsImpl Recursive function that handles inserting empty transforms into a given range. Used by insertTransforms.

Definition at line 814 of file KoSvgTextShape_p.h.

                                                                                                                                                                                                                                       {
        int currentLength = 0;
        auto it = childBegin(currentTextElement);
        if (it != childEnd(currentTextElement)) {
            for (; it != childEnd(currentTextElement); it++) {
                currentLength += insertTransformsImpl(it, globalIndex + currentLength, start, length, collapsedCharacters, allowSkipFirst);
            }
        } else {
            currentLength = currentTextElement->text.size();
        }
 
        if (!currentTextElement->localTransformations.isEmpty()) {
            int transformOffset = 0;
            int transformOffsetEnd = 0;
 
            for (int i = globalIndex; i < globalIndex + currentLength; i++) {
                if (i < start) {
                    transformOffset += collapsedCharacters.at(i)? 0: 1;
                }
                if (i < start + length) {
                    transformOffsetEnd += collapsedCharacters.at(i)? 0: 1;
                } else {
                    break;
                }
            }
 
            // When at the start, skip the first transform.
            if (transformOffset == 0 && allowSkipFirst && currentTextElement->localTransformations.at(0).startsNewChunk()) {
                transformOffset += 1;
            }
 
            if (transformOffset < currentTextElement->localTransformations.size()) {
                for (int i = transformOffset; i < transformOffsetEnd; i++) {
                    currentTextElement->localTransformations.insert(i, KoSvgText::CharTransformation());
                }
            }
 
        }
        return currentLength;
    }

References length().

◆ iteratorForTreeIndex()

static KisForest< KoSvgTextContentElement >::child_iterator KoSvgTextShape::iteratorForTreeIndex	(	const QVector< int >	treeIndex,
		KisForest< KoSvgTextContentElement >::child_iterator	parent )

inlinestatic

Definition at line 1117 of file KoSvgTextShape_p.h.

                                                                                                                                                                        {
        if (treeIndex.isEmpty()) return parent;
        QVector<int> idx = treeIndex;
        int count = idx.takeFirst();
        for (auto child = KisForestDetail::childBegin(parent); child != KisForestDetail::childEnd(parent); child++) {
            if (count == 0) {
                if ((KisForestDetail::childBegin(child) != KisForestDetail::childEnd(child))) {
                    return iteratorForTreeIndex(idx, child);
                } else {
                    return child;
                }
            }
            count -= 1;
        }
        return KisForestDetail::childEnd(parent);
    }

References KisForestDetail::childBegin(), and KisForestDetail::childEnd().

◆ leaveNodeSubtree()

void KoSvgTextShape::leaveNodeSubtree ( )

Set the current node to its parent, leaving the subtree.

Definition at line 1442 of file KoSvgTextShape.cpp.

{
 
}

◆ lineEnd()

int KoSvgTextShape::lineEnd ( int pos )

lineEnd return the 'line end' for this pos. This uses anchored chunks, so each absolute x, y posititioning will be considered a line-start.

Parameters

pos	– the cursor pos for which to find the line end.

Returns: the line end.

Definition at line 266 of file KoSvgTextShape.cpp.

{
    if (pos < 0 || d->cursorPos.isEmpty() || d->result.isEmpty()) {
        return pos;
    }
    if (pos > d->cursorPos.size() - 1) {
        return d->cursorPos.size() - 1;
    }
    int candidate = 0;
    int posCluster = d->cursorPos.at(pos).cluster;
    for (int i = pos; i < d->cursorPos.size(); i++) {
        CursorPos p = d->cursorPos.at(i);
        if (d->result.at(p.cluster).anchored_chunk && i > pos && posCluster != p.cluster) {
            break;
        }
        candidate = i;
    }
    return candidate;
}

References cursorPos, d, and p.

◆ lineStart()

int KoSvgTextShape::lineStart ( int pos )

lineStart return the 'line start' for this pos. This uses anchored chunks, so each absolute x, y posititioning will be considered a line-start.

Parameters

pos	– the cursor pos for which to find the line start.

Returns: the line start.

Definition at line 247 of file KoSvgTextShape.cpp.

{
    if (pos < 0 || d->cursorPos.isEmpty() || d->result.isEmpty()) {
        return pos;
    }
    CursorPos p = d->cursorPos.at(pos);
    if (d->result.at(p.cluster).anchored_chunk && p.offset == 0) {
        return pos;
    }
    int candidate = 0;
    for (int i = 0; i < pos; i++) {
        CursorPos p2 = d->cursorPos.at(i);
        if (d->result.at(p2.cluster).anchored_chunk && p2.offset == 0) {
            candidate = i;
        }
    }
    return candidate;
}

References cursorPos, d, p, and p2.

◆ loadGlyph()

static bool KoSvgTextShape::loadGlyph	(	const KoSvgText::ResolutionHandler &	resHandler,
		const FT_Int32	faceLoadFlags,
		const bool	isHorizontal,
		const char32_t	firstCodepoint,
		const KoSvgText::TextRendering	rendering,
		raqm_glyph_t &	currentGlyph,
		CharacterResult &	charResult,
		QPointF &	totalAdvanceFTFontCoordinates )

static

◆ loadGlyphOnly()

static std::pair< QTransform, qreal > KoSvgTextShape::loadGlyphOnly	(	const QTransform &	ftTF,
		FT_Int32	faceLoadFlags,
		bool	isHorizontal,
		raqm_glyph_t &	currentGlyph,
		CharacterResult &	charResult,
		const KoSvgText::TextRendering	rendering )

static

◆ mergePropertiesIntoRange()

void KoSvgTextShape::mergePropertiesIntoRange	(	const int	startPos,
		const int	endPos,
		const KoSvgTextProperties	properties,
		const QSet< KoSvgTextProperties::PropertyId >	removeProperties = QSet<KoSvgTextProperties::PropertyId>() )

mergePropertiesIntoRange Merge given properties into the given range. This will first split the nodes at the two range ends, and then merge in the properties into each leaf node. Won't do anything when startPos == endPos

First, the properties in removeProperties list will be removed, then properties in properties will be applied. If the property is present in both lists, then the value from properties will be used.

Parameters

startPos	– cursor pos start.
endPos	– cursor pos end.
properties	– properties to merge in.
removeProperties	– optional list of properties to remove, these will always apply after merging.

Definition at line 974 of file KoSvgTextShape.cpp.

{
    if ((startPos < 0 && startPos == endPos) || d->cursorPos.isEmpty()) {
        if (KisForestDetail::size(d->textData)) {
            Q_FOREACH(KoSvgTextProperties::PropertyId p, properties.properties()) {
                d->textData.childBegin()->properties.setProperty(p, properties.property(p));
            }
            Q_FOREACH(KoSvgTextProperties::PropertyId p, removeProperties) {
                d->textData.childBegin()->properties.removeProperty(p);
            }
        }
        notifyChanged();
        shapeChangedPriv(ContentChanged);
        return;
    }
    const int startIndex = d->cursorPos.at(startPos).index;
    const int endIndex = d->cursorPos.at(endPos).index;
    if (startIndex != endIndex) {
        KoSvgTextShape::Private::splitContentElement(d->textData, startIndex);
        KoSvgTextShape::Private::splitContentElement(d->textData, endIndex);
    }
    bool changed = false;
    int currentIndex = 0;
    KoSvgText::AutoValue inlineSize = d->textData.childBegin()->properties.propertyOrDefault(KoSvgTextProperties::InlineSizeId).value<KoSvgText::AutoValue>();
    bool isWrapping = !d->shapesInside.isEmpty() || !inlineSize.isAuto;
    for (auto it = d->textData.depthFirstTailBegin(); it != d->textData.depthFirstTailEnd(); it++) {
        if (KoSvgTextShape::Private::childCount(siblingCurrent(it)) > 0) {
            continue;
        }
 
        if (currentIndex >= startIndex && currentIndex < endIndex) {
            Q_FOREACH(KoSvgTextProperties::PropertyId p, removeProperties) {
                if (KoSvgTextProperties::propertyIsBlockOnly(p)) {
                    d->textData.childBegin()->properties.removeProperty(p);
                } else {
                    it->properties.removeProperty(p);
                }
            }
            Q_FOREACH(KoSvgTextProperties::PropertyId p, properties.properties()) {
                if (KoSvgTextProperties::propertyIsBlockOnly(p) || (p == KoSvgTextProperties::TextAnchorId && isWrapping)) {
                    d->textData.childBegin()->properties.setProperty(p, properties.property(p));
                } else {
                    it->properties.setProperty(p, properties.property(p));
                }
            }
 
            changed = true;
        }
        currentIndex += it->numChars(false);
    }
 
    if (changed){
        KoSvgTextShape::Private::cleanUp(d->textData);
        notifyChanged();
        shapeChangedPriv(ContentChanged);
        if (properties.hasProperty(KoSvgTextProperties::FillId)) {
            shapeChangedPriv(BackgroundChanged);
        }
        if (properties.hasProperty(KoSvgTextProperties::StrokeId)) {
            shapeChangedPriv(StrokeChanged);
        }
    }
}

References KoShape::BackgroundChanged, KoShape::ContentChanged, d, KoSvgTextProperties::FillId, KoSvgTextProperties::hasProperty(), KoSvgTextProperties::InlineSizeId, KoSvgText::AutoValue::isAuto, KoShape::notifyChanged(), p, KoSvgTextProperties::properties(), KoSvgTextProperties::property(), KoSvgTextProperties::propertyIsBlockOnly(), KoShape::shapeChangedPriv(), KisForestDetail::size(), KoShape::StrokeChanged, KoSvgTextProperties::StrokeId, and KoSvgTextProperties::TextAnchorId.

◆ nextIndex()

int KoSvgTextShape::nextIndex ( int pos )

nextIndex Return the first cursor position with a higher string index.

Parameters

pos	the cursor position.

Returns: the first pos with a higher cluster or same cluster and higher offset.

Definition at line 313 of file KoSvgTextShape.cpp.

{
    if (d->cursorPos.isEmpty()) {
        return pos;
    }
    int currentIndex = d->cursorPos.at(pos).index;
 
    for (int i = pos; i < d->cursorPos.size(); i++) {
        if (d->cursorPos.at(i).index > currentIndex) {
            return i;
        }
    }
    return pos;
}

References d.

◆ nextLine()

int KoSvgTextShape::nextLine ( int pos )

nextLine get a position on the next line for this position.

Parameters

pos	– cursor position.

Returns: the pos on the next line;

Definition at line 371 of file KoSvgTextShape.cpp.

{
    if (pos < 0 || pos > d->cursorPos.size()-1 || d->result.isEmpty() || d->cursorPos.isEmpty()) {
        return pos;
    }
 
    int nextLineStart = lineEnd(pos)+1;
    int nextLineEnd = lineEnd(nextLineStart);
    CursorPos cursorPos = d->cursorPos.at(pos);
    if (!this->shapesInside().isEmpty()) {
        LineBox nextLineBox;
        for (int i = 0; i < d->lineBoxes.size(); ++i) {
            for (int j = 0; j < d->lineBoxes.at(i).chunks.size(); ++j) {
                if (d->lineBoxes.at(i).chunks.at(j).chunkIndices.contains(cursorPos.cluster)) {
                    nextLineBox = d->lineBoxes.at(qMin(i + 1, d->lineBoxes.size()-1));
                }
            }
        }
        if (nextLineBox.chunks.size()>0) {
            int first = -1;
            int last = -1;
            Q_FOREACH(LineChunk chunk, nextLineBox.chunks) {
                Q_FOREACH (int i, chunk.chunkIndices) {
                    if (d->result.at(i).addressable) {
                        if (first < 0) {
                            first = d->result.at(i).cursorInfo.graphemeIndices.first();
                        }
                        last = d->result.at(i).cursorInfo.graphemeIndices.last();
                    }
                }
            }
            if (first > -1 && last > -1) {
                nextLineStart = posForIndex(first);
                nextLineEnd = posForIndex(last);
            }
        }
    }
 
 
    if (nextLineStart > d->cursorPos.size()-1) {
        return d->cursorPos.size()-1;
    }
 
    CharacterResult res = d->result.at(cursorPos.cluster);
    QPointF currentPoint = res.finalPosition;
    currentPoint += res.cursorInfo.offsets.value(cursorPos.offset, res.advance);
    int candidate = posForPoint(currentPoint, nextLineStart, nextLineEnd+1);
    if (candidate < 0) {
        return pos;
    }
 
    return candidate;
}

References CharacterResult::advance, LineChunk::chunkIndices, LineBox::chunks, CharacterResult::cursorInfo, cursorPos, d, CharacterResult::finalPosition, lineEnd(), CursorInfo::offsets, posForIndex(), posForPoint(), and shapesInside.

◆ nextPos()

int KoSvgTextShape::nextPos	(	int	pos,
		bool	visual )

private

nextPos get the next position.

Parameters

pos	– cursor position.

Returns: the next pos;

Definition at line 343 of file KoSvgTextShape.cpp.

{
    if (d->cursorPos.isEmpty()) {
        return -1;
    }
 
    if(visual) {
        int visualIndex = d->logicalToVisualCursorPos.value(pos);
        return d->logicalToVisualCursorPos.key(qMin(visualIndex + 1, d->cursorPos.size() - 1), d->cursorPos.size() - 1);
    }
 
    return qMin(pos + 1, d->cursorPos.size() - 1);
}

References d.

◆ notifyCursorPosChanged()

void KoSvgTextShape::notifyCursorPosChanged	(	int	pos,
		int	anchor )

Notify that the cursor position has changed.

Definition at line 1233 of file KoSvgTextShape.cpp.

{
    if (d->isLoading) {
        return;
    }
    Q_FOREACH (KoShape::ShapeChangeListener *listener, listeners()) {
        TextCursorChangeListener *cursorListener = dynamic_cast<TextCursorChangeListener*>(listener);
        if (cursorListener) {
            cursorListener->notifyCursorPosChanged(pos, anchor);
        }
    }
}

References KoShape::anchor(), d, KoShape::Private::listeners, and KoSvgTextShape::TextCursorChangeListener::notifyCursorPosChanged().

◆ notifyMarkupChanged()

void KoSvgTextShape::notifyMarkupChanged ( )

Notify that the markup has changed.

Definition at line 1246 of file KoSvgTextShape.cpp.

{
    if (d->isLoading) {
        return;
    }
    Q_FOREACH (KoShape::ShapeChangeListener *listener, listeners()) {
        TextCursorChangeListener *cursorListener = dynamic_cast<TextCursorChangeListener*>(listener);
        if (cursorListener) {
            cursorListener->notifyMarkupChanged();
        }
    }
}

References d, KoShape::Private::listeners, and KoSvgTextShape::TextCursorChangeListener::notifyMarkupChanged().

◆ numChars()

static int KoSvgTextShape::numChars	(	KisForest< KoSvgTextContentElement >::child_iterator	parent,
		bool	withControls = false,
		KoSvgTextProperties	resolvedProps = KoSvgTextProperties::defaultProperties() )

inlinestatic

Get the number of characters for the whole subtree of this node.

Definition at line 597 of file KoSvgTextShape_p.h.

                                                                                                                                                                                        {
        KoSvgTextProperties props = parent->properties;
        props.inheritFrom(resolvedProps, true);
        int count = parent->numChars(withControls, props);
        for (auto it = KisForestDetail::childBegin(parent); it != KisForestDetail::childEnd(parent); it++) {
            count += numChars(it, withControls, props);
        }
        return count;
    }

References KisForestDetail::childBegin(), KisForestDetail::childEnd(), and KoSvgTextProperties::inheritFrom().

◆ outline()

QPainterPath KoSvgTextShape::outline ( ) const

overridevirtual

returns the outline of the shape in the form of a path. The outline returned will always be relative to the position() of the shape, so moving the shape will not alter the result. The outline is used to draw the stroke on, for example.

Returns: the outline of the shape in the form of a path.

Reimplemented from KoShape.

Definition at line 1598 of file KoSvgTextShape.cpp.

                                           {
    QPainterPath result;
    for (auto it = d->textData.depthFirstTailBegin(); it != d->textData.depthFirstTailEnd(); it++) {
        result.addPath(it->associatedOutline);
        for (int i = 0; i < it->textDecorations.values().size(); ++i) {
            result.addPath(it->textDecorations.values().at(i));
        }
 
    }
    return result;
}

References d, and result.

◆ outlineRect()

QRectF KoSvgTextShape::outlineRect ( ) const

overridevirtual

returns the outline of the shape in the form of a rect. The outlineRect returned will always be relative to the position() of the shape, so moving the shape will not alter the result. The outline is used to calculate the boundingRect.

Returns: the outline of the shape in the form of a rect.

Reimplemented from KoShape.

Definition at line 1609 of file KoSvgTextShape.cpp.

{
    return outline().boundingRect();
}

References outline().

◆ paint()

void KoSvgTextShape::paint ( QPainter & painter ) const

overridevirtual

Paint the shape fill The class extending this one is responsible for painting itself. painter is expected to be preconfigured to work in "document" pixels.

Parameters

painter used for painting the shape

Implements KoShape.

Definition at line 1534 of file KoSvgTextShape.cpp.

{
    painter.save();
    KoSvgText::TextRendering textRendering = KoSvgText::TextRendering(textProperties().propertyOrDefault(KoSvgTextProperties::TextRenderingId).toInt());
    if (textRendering == KoSvgText::RenderingOptimizeSpeed || !painter.testRenderHint(QPainter::Antialiasing)) {
        // also apply antialiasing only if antialiasing is active on provided target QPainter
        painter.setRenderHint(QPainter::Antialiasing, false);
        painter.setRenderHint(QPainter::SmoothPixmapTransform, false);
    } else {
        painter.setRenderHint(QPainter::Antialiasing, true);
        painter.setRenderHint(QPainter::SmoothPixmapTransform, true);
    }
 
    QPainterPath chunk;
    int currentIndex = 0;
    if (!d->result.isEmpty()) {
        QPainterPath rootBounds;
        rootBounds.addRect(this->outline().boundingRect());
        d->paintTextDecoration(painter, rootBounds, this, KoSvgText::DecorationUnderline, textRendering);
        d->paintTextDecoration(painter, rootBounds, this, KoSvgText::DecorationOverline, textRendering);
        d->paintPaths(painter, rootBounds, this, d->result, textRendering, chunk, currentIndex);
        d->paintTextDecoration(painter, rootBounds, this, KoSvgText::DecorationLineThrough, textRendering);
    }
#if 0 // Debug
    Q_FOREACH (KoShape *child, this->shapes()) {
        const KoSvgTextChunkShape *textPathChunk = dynamic_cast<const KoSvgTextChunkShape *>(child);
        if (textPathChunk) {
            painter.save();
            painter.setPen(Qt::magenta);
            painter.setOpacity(0.5);
            if (textPathChunk->layoutInterface()->textPath()) {
                QPainterPath p = textPathChunk->layoutInterface()->textPath()->outline();
                p = textPathChunk->layoutInterface()->textPath()->transformation().map(p);
                painter.strokePath(p, QPen(Qt::green));
                painter.drawPoint(p.pointAtPercent(0));
                painter.drawPoint(p.pointAtPercent(p.percentAtLength(p.length() * 0.5)));
                painter.drawPoint(p.pointAtPercent(1.0));
            }
            painter.restore();
        }
    }
#endif
#if 0 // Debug
    Q_FOREACH (KoShape *shapeInside, d->shapesInside) {
        QPainterPath p = shapeInside->outline();
        p = shapeInside->transformation().map(p);
        painter.strokePath(p, QPen(Qt::green));
    }
    Q_FOREACH (KoShape *shapeInside, d->shapesSubtract) {
        QPainterPath p = shapeInside->outline();
        p = shapeInside->transformation().map(p);
        painter.strokePath(p, QPen(Qt::red));
    }
#endif
 
    painter.restore();
}

References boundingRect(), d, KoSvgText::DecorationLineThrough, KoSvgText::DecorationOverline, KoSvgText::DecorationUnderline, KoShape::outline(), outline(), p, KoSvgText::RenderingOptimizeSpeed, textProperties(), KoSvgTextProperties::TextRenderingId, and KoShape::transformation().

◆ paintDebug() [1/2]

void KoSvgTextShape::paintDebug	(	QPainter &	painter,
		const QVector< CharacterResult > &	result,
		int &	currentIndex )

◆ paintDebug() [2/2]

void KoSvgTextShape::paintDebug	(	QPainter &	painter,
		DebugElements	elements ) const

Definition at line 1648 of file KoSvgTextShape.cpp.

{
    if (elements & DebugElement::CharBbox) {
        int currentIndex = 0;
        if (!d->result.isEmpty()) {
            QPainterPath rootBounds;
            rootBounds.addRect(this->outline().boundingRect());
            d->paintDebug(painter, d->result, currentIndex);
        }
    }
 
    if (elements & DebugElement::LineBox) {
        Q_FOREACH (LineBox lineBox, d->lineBoxes) {
            Q_FOREACH (const LineChunk &chunk, lineBox.chunks) {
                QPen pen;
                pen.setCosmetic(true);
                pen.setWidth(2);
                painter.setBrush(QBrush(Qt::transparent));
                pen.setColor(QColor(0, 128, 255, 128));
                painter.setPen(pen);
                painter.drawLine(chunk.length);
                pen.setColor(QColor(255, 128, 0, 128));
                painter.setPen(pen);
                painter.drawRect(chunk.boundingBox);
 
                pen.setColor(QColor(255, 0, 0, 128));
                pen.setStyle(Qt::DashDotDotLine);
                painter.setPen(pen);
                painter.drawLine(chunk.length.translated(lineBox.baselineTop));
                pen.setColor(QColor(0, 128, 0, 128));
                pen.setStyle(Qt::DashDotLine);
                painter.setPen(pen);
                painter.drawLine(chunk.length.translated(lineBox.baselineBottom));
            }
        }
    }
}

References LineBox::baselineBottom, LineBox::baselineTop, LineChunk::boundingBox, boundingRect(), CharBbox, LineBox::chunks, d, LineChunk::length, LineBox, and outline().

◆ paintOrder()

QVector< KoShape::PaintOrder > KoSvgTextShape::paintOrder ( ) const

overridevirtual

paintOrder

Returns: vector of paint orders, will always be 3 big and contain a fill, stroke and marker entry.

Reimplemented from KoShape.

Definition at line 1186 of file KoSvgTextShape.cpp.

{
    KoSvgTextProperties props = KisForestDetail::size(d->textData)? d->textData.childBegin()->properties: KoSvgTextProperties();
    if (props.hasProperty(KoSvgTextProperties::PaintOrder)) {
        return props.property(KoSvgTextProperties::PaintOrder).value<QVector<KoShape::PaintOrder>>();
    }
    return KoShape::paintOrder();
}

References d, KoSvgTextProperties::hasProperty(), KoShape::paintOrder(), KoSvgTextProperties::PaintOrder, KoSvgTextProperties::properties(), KoSvgTextProperties::property(), and KisForestDetail::size().

◆ paintPaths()

void KoSvgTextShape::paintPaths	(	QPainter &	painter,
		const QPainterPath &	outlineRect,
		const KoShape *	rootShape,
		const QVector< CharacterResult > &	result,
		const KoSvgText::TextRendering	rendering,
		QPainterPath &	chunk,
		int &	currentIndex )

◆ paintStroke()

void KoSvgTextShape::paintStroke ( QPainter & painter ) const

overridevirtual

paintStroke paints the shape's stroked outline

Parameters

painter used for painting the shape

See also: applyConversion()

Reimplemented from KoShape.

Definition at line 1592 of file KoSvgTextShape.cpp.

{
    Q_UNUSED(painter);
    // do nothing! everything is painted in paint()
}

◆ paintTextDecoration()

void KoSvgTextShape::paintTextDecoration	(	QPainter &	painter,
		const QPainterPath &	outlineRect,
		const KoShape *	rootShape,
		const KoSvgText::TextDecoration	type,
		const KoSvgText::TextRendering	rendering )

◆ plainText()

QString KoSvgTextShape::plainText ( )

plainText plain text of all text inside this text shape, without the bidi controls or any transforms.

Returns: a string of plain text.

◆ posDown()

int KoSvgTextShape::posDown	(	int	pos,
		bool	visual = false )

return position below.

Definition at line 232 of file KoSvgTextShape.cpp.

{
    KoSvgText::WritingMode mode = writingMode();
    KoSvgText::Direction direction = KoSvgText::Direction(this->textProperties().propertyOrDefault(KoSvgTextProperties::DirectionId).toInt());
    if (mode == KoSvgText::VerticalRL || mode == KoSvgText::VerticalLR) {
        if (direction == KoSvgText::DirectionRightToLeft) {
            return previousPos(pos, visual);
        } else {
            return nextPos(pos, visual);
        }
    } else {
        return nextLine(pos);
    }
}

References KoSvgTextProperties::DirectionId, KoSvgText::DirectionRightToLeft, nextLine(), nextPos(), previousPos(), textProperties(), KoSvgText::VerticalLR, KoSvgText::VerticalRL, and writingMode().

◆ posForIndex()

int KoSvgTextShape::posForIndex	(	int	index,
		bool	firstIndex = false,
		bool	skipSynthetic = false ) const

posForIndex Get the cursor position for a given index in a string.

Parameters

index	– index in the string.
firstIndex	– whether to return for the first instance of the index.
skipSynthetic	– whether to skip over synthetic cursorPositions.

Returns: the cursor – position for an index.

Definition at line 773 of file KoSvgTextShape.cpp.

{
    int pos = -1;
    if (d->cursorPos.isEmpty() || index < 0) {
        return pos;
    }
    for (int i = 0; i< d->cursorPos.size(); i++) {
        if (skipSynthetic && d->cursorPos.at(i).synthetic) {
            continue;
        }
        if (d->cursorPos.at(i).index <= index) {
            pos = i;
            if (d->cursorPos.at(i).index == index && firstIndex) {
                break;
            }
        } else if (d->cursorPos.at(i).index > index) {
            break;
        }
    }
 
    return pos;
}

References d.

◆ posForPoint()

int KoSvgTextShape::posForPoint	(	QPointF	point,
		int	start = -1,
		int	end = -1,
		bool *	overlaps = nullptr )

posForPoint Finds the closest cursor position for the given point in shape coordinates.

Parameters

point
start	– optional start position;
end	– optional end position;
overlaps	– optional bool that is set if the point overlaps any glyph box.

Returns: the closest cursor position.

Definition at line 702 of file KoSvgTextShape.cpp.

{
    int a = 0;
    int b = d->cursorPos.size();
    if (start >= 0 && end >= 0) {
        a = qMax(start, a);
        b = qMin(end, b);
    }
    double closest = std::numeric_limits<double>::max();
    int candidate = 0;
    for (int i = a; i < b; i++) {
        CursorPos pos = d->cursorPos.at(i);
        CharacterResult res = d->result.at(pos.cluster);
        QPointF cursorStart = res.finalPosition;
        cursorStart += res.cursorInfo.offsets.value(pos.offset, res.advance);
        double distance = kisDistance(cursorStart, point);
        if (distance < closest) {
            candidate = i;
            closest = distance;
            if (overlaps) {
               *overlaps = res.finalTransform().map(res.layoutBox()).containsPoint(point, Qt::WindingFill);
            }
        }
    }
    return candidate;
}

References CharacterResult::advance, CursorPos::cluster, CharacterResult::cursorInfo, d, distance(), CharacterResult::finalPosition, CharacterResult::finalTransform(), kisDistance(), CharacterResult::layoutBox(), CursorPos::offset, and CursorInfo::offsets.

◆ posForPointLineSensitive()

int KoSvgTextShape::posForPointLineSensitive ( QPointF point )

posForPointLineSensitive When clicking on an empty space in a wrapped text, it is preferable to have the caret be at the end of the line visually associated with that empty space than the positions above or below that might be closer.

Because SVG has several situations where there's no real lines, we first test for the closest cursorpos and also whether there's an actual overlap with a glyph. If there's no such overlap, we test against whether there's an anchored chunk in the inline direction, and if so search the line resulting from that. If not, we return the closest pos.

Parameters

point the point in shape coordinates.

Returns: the closest pos, taking into account any line starts or ends.

Definition at line 729 of file KoSvgTextShape.cpp.

{
    bool overlaps = false;
    int initialPos = posForPoint(point, -1, -1, &overlaps);
 
    if (overlaps) {
        return initialPos;
    }
 
    KoSvgText::WritingMode mode = writingMode();
 
    int candidateLineStart = 0;
    double closest = std::numeric_limits<double>::max();
    for (int i = 0; i < d->cursorPos.size(); i++) {
        CursorPos pos = d->cursorPos.at(i);
        CharacterResult res = d->result.at(pos.cluster);
        if (res.anchored_chunk) {
            QLineF caret = res.cursorInfo.caret;
            caret.translate(res.finalPosition);
            QPointF cursorStart = res.finalPosition;
            cursorStart += res.cursorInfo.offsets.value(pos.offset, res.advance);
            double distance = kisDistance(cursorStart, point);
            if (mode == KoSvgText::HorizontalTB) {
                if (caret.p1().y() > point.y() && caret.p2().y() <= point.y() && closest > distance) {
                    candidateLineStart = i;
                    closest = distance;
                }
            } else {
                if (caret.p2().x() > point.x() && caret.p1().x() <= point.x() && closest > distance) {
                    candidateLineStart = i;
                    closest = distance;
                }
            }
        }
    }
 
    if (candidateLineStart > -1) {
        int end = lineEnd(candidateLineStart);
        initialPos = posForPoint(point, candidateLineStart, qMin(end + 1, d->cursorPos.size()));
    }
 
    return initialPos;
}

References CharacterResult::advance, CharacterResult::anchored_chunk, CursorInfo::caret, CursorPos::cluster, CharacterResult::cursorInfo, d, distance(), CharacterResult::finalPosition, KoSvgText::HorizontalTB, kisDistance(), lineEnd(), CursorPos::offset, CursorInfo::offsets, posForPoint(), and writingMode().

◆ posLeft()

int KoSvgTextShape::posLeft	(	int	pos,
		bool	visual = false )

return position to the left; visual indicates whether to use logical ('previous') or visual left (depending on direction).

Definition at line 182 of file KoSvgTextShape.cpp.

{
    KoSvgText::WritingMode mode = writingMode();
    KoSvgText::Direction direction = KoSvgText::Direction(this->textProperties().propertyOrDefault(KoSvgTextProperties::DirectionId).toInt());
    if (mode == KoSvgText::VerticalRL) {
        return nextLine(pos);
    } else if (mode == KoSvgText::VerticalLR) {
        return previousLine(pos);
    } else {
        if (direction == KoSvgText::DirectionRightToLeft) {
            return nextPos(pos, visual);
        } else {
            return previousPos(pos, visual);
        }
    }
}

References KoSvgTextProperties::DirectionId, KoSvgText::DirectionRightToLeft, nextLine(), nextPos(), previousLine(), previousPos(), textProperties(), KoSvgText::VerticalLR, KoSvgText::VerticalRL, and writingMode().

◆ posRight()

int KoSvgTextShape::posRight	(	int	pos,
		bool	visual = false )

return position to the right; visual indicates whether to use logical ('next') or visual right (depending on direction).

Definition at line 199 of file KoSvgTextShape.cpp.

{
    KoSvgText::WritingMode mode = writingMode();
    KoSvgText::Direction direction = KoSvgText::Direction(this->textProperties().propertyOrDefault(KoSvgTextProperties::DirectionId).toInt());
 
    if (mode == KoSvgText::VerticalRL) {
        return previousLine(pos);
    } else if (mode == KoSvgText::VerticalLR) {
        return nextLine(pos);
    } else {
        if (direction == KoSvgText::DirectionRightToLeft) {
            return previousPos(pos, visual);
        } else {
            return nextPos(pos, visual);
        }
    }
}

References KoSvgTextProperties::DirectionId, KoSvgText::DirectionRightToLeft, nextLine(), nextPos(), previousLine(), previousPos(), textProperties(), KoSvgText::VerticalLR, KoSvgText::VerticalRL, and writingMode().

◆ posUp()

int KoSvgTextShape::posUp	(	int	pos,
		bool	visual = false )

return position above.

Definition at line 217 of file KoSvgTextShape.cpp.

{
    KoSvgText::WritingMode mode = writingMode();
    KoSvgText::Direction direction = KoSvgText::Direction(this->textProperties().propertyOrDefault(KoSvgTextProperties::DirectionId).toInt());
    if (mode == KoSvgText::VerticalRL || mode == KoSvgText::VerticalLR) {
        if (direction == KoSvgText::DirectionRightToLeft) {
            return nextPos(pos, visual);
        } else {
            return previousPos(pos, visual);
        }
    } else {
        return previousLine(pos);
    }
}

References KoSvgTextProperties::DirectionId, KoSvgText::DirectionRightToLeft, nextPos(), previousLine(), previousPos(), textProperties(), KoSvgText::VerticalLR, KoSvgText::VerticalRL, and writingMode().

◆ previousIndex()

int KoSvgTextShape::previousIndex ( int pos )

previousIndex Return the first pos which has a lower string index.

Parameters

pos	the cursor position.

Returns: the first cursor position with a lower index.

Definition at line 328 of file KoSvgTextShape.cpp.

{
    if (d->cursorPos.isEmpty()) {
        return pos;
    }
    int currentIndex = d->cursorPos.at(pos).index;
 
    for (int i = pos; i >= 0; i--) {
        if (d->cursorPos.at(i).index < currentIndex) {
            return i;
        }
    }
    return pos;
}

References d.

◆ previousLine()

int KoSvgTextShape::previousLine ( int pos )

previousLine get a position on the previous line for this position.

Parameters

pos	– cursor position.

Returns: the pos on the previous line;

Definition at line 425 of file KoSvgTextShape.cpp.

{
    if (pos < 0 || pos > d->cursorPos.size()-1 || d->result.isEmpty() || d->cursorPos.isEmpty()) {
        return pos;
    }
    int currentLineStart = lineStart(pos);
    if (currentLineStart - 1 < 0) {
        return 0;
    }
    int previousLineStart = lineStart(currentLineStart-1);
 
    CursorPos cursorPos = d->cursorPos.at(pos);
    if (!this->shapesInside().isEmpty()) {
        LineBox previousLineBox;
        for (int i = 0; i < d->lineBoxes.size(); ++i) {
            for (int j = 0; j < d->lineBoxes.at(i).chunks.size(); ++j) {
                if (d->lineBoxes.at(i).chunks.at(j).chunkIndices.contains(cursorPos.cluster)) {
                    previousLineBox = d->lineBoxes.at(qMax(i - 1, 0));
                }
            }
        }
        if (previousLineBox.chunks.size()>0) {
            int first = -1;
            int last = -1;
            Q_FOREACH(LineChunk chunk, previousLineBox.chunks) {
                Q_FOREACH (int i, chunk.chunkIndices) {
                    if (d->result.at(i).addressable) {
                        if (first < 0) {
                            first = d->result.at(i).cursorInfo.graphemeIndices.first();
                        }
                        last = d->result.at(i).cursorInfo.graphemeIndices.last();
                    }
                }
            }
            if (first > -1 && last > -1) {
                previousLineStart = posForIndex(first);
                currentLineStart = posForIndex(last);
            }
        }
    }
 
    CharacterResult res = d->result.at(cursorPos.cluster);
    QPointF currentPoint = res.finalPosition;
    currentPoint += res.cursorInfo.offsets.value(cursorPos.offset, res.advance);
    int candidate = posForPoint(currentPoint, previousLineStart, currentLineStart);
    if (candidate < 0) {
        return pos;
    }
 
    return candidate;
}

References CharacterResult::advance, LineChunk::chunkIndices, LineBox::chunks, CharacterResult::cursorInfo, cursorPos, d, CharacterResult::finalPosition, lineStart(), CursorInfo::offsets, posForIndex(), posForPoint(), and shapesInside.

◆ previousPos()

int KoSvgTextShape::previousPos	(	int	pos,
		bool	visual )

private

previousPos get the previous position.

Parameters

pos	– cursor position.

Returns: the previous pos;

Definition at line 357 of file KoSvgTextShape.cpp.

{
    if (d->cursorPos.isEmpty()) {
        return -1;
    }
 
    if(visual) {
        int visualIndex = d->logicalToVisualCursorPos.value(pos);
        return d->logicalToVisualCursorPos.key(qMax(visualIndex - 1, 0), 0);
    }
 
    return qMax(pos - 1, 0);
}

References d.

◆ Private() [1/2]

KoSvgTextShape::Private ( )

default

◆ Private() [2/2]

KoSvgTextShape::Private ( const Private & rhs )

inline

Definition at line 441 of file KoSvgTextShape_p.h.

        : textData(rhs.textData) {
        Q_FOREACH (KoShape *shape, rhs.shapesInside) {
            KoShape *clonedShape = shape->cloneShape();
            KIS_ASSERT_RECOVER(clonedShape) { continue; }
 
            shapesInside.append(clonedShape);
        }
        Q_FOREACH (KoShape *shape, rhs.shapesSubtract) {
            KoShape *clonedShape = shape->cloneShape();
            KIS_ASSERT_RECOVER(clonedShape) { continue; }
 
            shapesSubtract.append(clonedShape);
        }
        yRes = rhs.yRes;
        xRes = rhs.xRes;
        result = rhs.result;
        lineBoxes = rhs.lineBoxes;
 
        cursorPos = rhs.cursorPos;
        logicalToVisualCursorPos = rhs.logicalToVisualCursorPos;
        plainText = rhs.plainText;
        isBidi = rhs.isBidi;
        initialTextPosition = rhs.initialTextPosition;
 
        isLoading = rhs.isLoading;
        disableFontMatching = rhs.disableFontMatching;
    }

References KoShape::cloneShape(), and KIS_ASSERT_RECOVER.

◆ propertiesForPos()

KoSvgTextProperties KoSvgTextShape::propertiesForPos	(	const int	pos,
		bool	inherited = false ) const

Return the properties at a given position.

Definition at line 879 of file KoSvgTextShape.cpp.

{
    return propertiesForRange(pos, pos, inherited).value(0, KoSvgTextProperties());
}

References propertiesForRange().

◆ propertiesForRange()

QList< KoSvgTextProperties > KoSvgTextShape::propertiesForRange	(	const int	startPos,
		const int	endPos,
		bool	inherited = false ) const

propertiesForRange get the properties for a range.

Parameters

startPos	– range start.
endPos	– range end.

Returns: list of properties.

Sometimes this gets called when xml data is uploaded into the shape, at which point the tree is empty.

Definition at line 895 of file KoSvgTextShape.cpp.

{
    QList<KoSvgTextProperties> props;
 
    if (d->isLoading) return props;
 
    if (((startPos < 0 || startPos >= d->cursorPos.size()) && startPos == endPos) || d->cursorPos.isEmpty()) {
        props = {KisForestDetail::size(d->textData)? d->textData.childBegin()->properties: KoSvgTextProperties()};
        return props;
    }
    const int finalPos = d->cursorPos.size() - 1;
    const int startIndex = d->cursorPos.at(qBound(0, startPos, finalPos)).index;
    const int endIndex = d->cursorPos.at(qBound(0, endPos, finalPos)).index;
    int sought = startIndex;
    if (startIndex == endIndex) {
        int currentIndex = 0;
        auto it = d->findTextContentElementForIndex(d->textData, currentIndex, sought);
        if (it != d->textData.depthFirstTailEnd()) {
            if (inherited) {
                props.append(inheritProperties(it));
            } else {
                props.append(it->properties);
            }
        } else {
            currentIndex = 0;
            it = d->findTextContentElementForIndex(d->textData, currentIndex, sought - 1);
            if (it != d->textData.depthFirstTailEnd()) {
                if (inherited) {
                    props.append(inheritProperties(it));
                } else {
                    props.append(it->properties);
                }
            }
        }
    } else {
        while(sought < endIndex) {
            int currentIndex = 0;
            auto it = d->findTextContentElementForIndex(d->textData, currentIndex, sought);
            if (KisForestDetail::siblingCurrent(it) == d->textData.childBegin()) {
                // If there's a selection and the search algorithm only returns the root, return empty.
                // The root text properties should be retrieved explicitly (either by using -1 as pos, or by calling textProperties()).
                props = {KoSvgTextProperties()};
                return props;
            } else if (it != d->textData.depthFirstTailEnd()) {
                if (inherited) {
                    props.append(inheritProperties(it));
                } else {
                    props.append(it->properties);
                }
            }
            sought = currentIndex + it->numChars(false);
        }
    }
 
    return props;
}

References d, inheritProperties(), KisForestDetail::siblingCurrent(), and KisForestDetail::size().

◆ Q_DECLARE_FLAGS()

KoSvgTextShape::Q_DECLARE_FLAGS	(	DebugElements	,
		DebugElement	)

◆ relayout() [1/2]

void KoSvgTextShape::relayout ( )

◆ relayout() [2/2]

void KoSvgTextShape::relayout ( ) const

Create a new text layout for the current content of the text shape chunks tree. The user should always call relayout() after every change in the text shapes hierarchy.

Definition at line 1760 of file KoSvgTextShape.cpp.

{
    d->relayout();
}

References d.

◆ relayoutIsBlocked()

bool KoSvgTextShape::relayoutIsBlocked ( ) const

relayoutIsBlocked

Returns: whether automatic relayout is blocked, as are updates to shape listeners.

Definition at line 1519 of file KoSvgTextShape.cpp.

{
    return d->isLoading;
}

References d.

◆ removeText()

bool KoSvgTextShape::removeText	(	int &	index,
		int &	length )

removeText Where insert text explicitly uses a cursorposition, remove text uses a string index. It will modify these values so that...

Whole code points are deleted at any time, avoiding no dangling surrogates.
Graphemes don't end with Zero-width-joiners, as that can lead to the grapheme merging with the next.
Variation selectors are deleted along their base.
regional sequences are deleted in pairs.
Parameters

index - index (not cursorpos!) of the start position.

length - total length of text to remove.

Returns
whether it was successful.

Definition at line 840 of file KoSvgTextShape.cpp.

{
    bool success = false;
    if (index < -1) {
        return success;
    }
    int currentLength = length;
    int endLength = 0;
    while (currentLength > 0) {
        int currentIndex = 0;
 
        auto it = d->findTextContentElementForIndex(d->textData, currentIndex, index, true);
        if (it != d->textData.depthFirstTailEnd()) {
            int offset = index > currentIndex? index - currentIndex: 0;
            int size = it->numChars(false);
            it->removeText(offset, currentLength);
            int diff = size - it->numChars(false);
            currentLength -= diff;
            endLength += diff;
 
            if (index >= currentIndex) {
                index = currentIndex + offset;
            }
 
            d->removeTransforms(d->textData, index, endLength);
 
            success = true;
        } else {
            currentLength = -1;
        }
    }
    if (success) {
        length = endLength;
        notifyChanged();
        shapeChangedPriv(ContentChanged);
    }
    return success;
}

References KoShape::ContentChanged, d, length(), KoShape::notifyChanged(), KoShape::shapeChangedPriv(), and KoShape::size().

◆ removeTransforms()

static void KoSvgTextShape::removeTransforms	(	KisForest< KoSvgTextContentElement > &	tree,
		const int	start,
		const int	length )

inlinestatic

removeTransforms Remove all local SVG character transforms in a certain range. Local transforms are influenced by whitespace collapse and whether they are set to unicode codepoints, and they also accumulate from parent to child. This function removes all local transforms in a certain section.

Parameters

tree	– tree to remove transforms from.
start	– start at which to remove transforms.
length	– end to remove from.

Definition at line 747 of file KoSvgTextShape_p.h.

                                                                                                              {
        QString all;
        QVector<bool> collapsedCharacters = collapsedWhiteSpacesForText(tree, all, true);
 
        auto root = tree.childBegin();
        removeTransformsImpl(root, 0, start, length, collapsedCharacters);
    }

References KisForestDetail::Forest< T >::childBegin(), and length().

◆ removeTransformsImpl()

static int KoSvgTextShape::removeTransformsImpl	(	KisForest< KoSvgTextContentElement >::child_iterator	currentTextElement,
		const int	globalIndex,
		const int	start,
		const int	length,
		const QVector< bool >	collapsedCharacters )

inlinestatic

removeTransformsImpl recursive function that handles removing local transforms in a certain range. Used by removeTransform.

Definition at line 760 of file KoSvgTextShape_p.h.

                                                                                                                                                                                                            {
        int currentLength = 0;
        auto it = childBegin(currentTextElement);
        if (it != childEnd(currentTextElement)) {
            for (; it != childEnd(currentTextElement); it++) {
                currentLength += removeTransformsImpl(it, globalIndex + currentLength, start, length, collapsedCharacters);
            }
        } else {
            currentLength = currentTextElement->text.size();
        }
 
        if (!currentTextElement->localTransformations.isEmpty()) {
            int transformOffset = 0;
            int transformOffsetEnd = 0;
 
            for (int i = globalIndex; i < globalIndex + currentLength; i++) {
                if (i < start) {
                    transformOffset += collapsedCharacters.at(i)? 0: 1;
                }
                if (i < start + length) {
                    transformOffsetEnd += collapsedCharacters.at(i)? 0: 1;
                } else {
                    break;
                }
            }
            if (transformOffset < currentTextElement->localTransformations.size()) {
                currentTextElement->localTransformations.remove(transformOffset, transformOffsetEnd-transformOffset);
            }
 
        }
        return currentLength;
    }

References length().

◆ resolveTransforms()

static void KoSvgTextShape::resolveTransforms	(	KisForest< KoSvgTextContentElement >::child_iterator	currentTextElement,
		QString	text,
		QVector< CharacterResult > &	result,
		int &	currentIndex,
		bool	isHorizontal,
		bool	wrapped,
		bool	textInPath,
		QVector< KoSvgText::CharTransformation > &	resolved,
		QVector< bool >	collapsedChars,
		const KoSvgTextProperties	resolvedProps,
		bool	withControls = true )

static

◆ saveHtml()

bool KoSvgTextShape::saveHtml ( HtmlSavingContext & context )

Definition at line 1357 of file KoSvgTextShape.cpp.

{
    bool success = true;
    QList<KoSvgTextProperties> parentProps = {KoSvgTextProperties::defaultProperties()};
    for (auto it = d->textData.compositionBegin(); it != d->textData.compositionEnd(); it++) {
        if (it.state() == KisForestDetail::Enter) {
            QMap<QString, QString> shapeSpecificStyles;
 
            if (it == d->textData.compositionBegin()) {
                context.shapeWriter().startElement("p", false);
            } else {
                context.shapeWriter().startElement("span", false);
            }
            KoSvgTextProperties ownProperties = it->properties.ownProperties(parentProps.last(),
                                                                             it == d->textData.compositionBegin());
            parentProps.append(ownProperties);
            QMap<QString, QString> attributes = ownProperties.convertToSvgTextAttributes();
            if (it == d->textData.compositionBegin())
                attributes.insert(ownProperties.convertParagraphProperties());
            bool addedFill = false;
            if (attributes.size() > 0) {
                QString styleString;
                for (auto it = attributes.constBegin(); it != attributes.constEnd(); ++it) {
                    if (QString(it.key().toLatin1().data()).contains("text-anchor")) {
                        QString val = it.value();
                        if (it.value()=="middle") {
                            val = "center";
                        } else if (it.value()=="end") {
                            val = "right";
                        } else {
                            val = "left";
                        }
                        styleString.append("text-align")
                                .append(": ")
                                .append(val)
                                .append(";" );
                    } else if (QString(it.key().toLatin1().data()).contains("fill")) {
                        styleString.append("color")
                                .append(": ")
                                .append(it.value())
                                .append(";" );
                        addedFill = true;
                    } else if (QString(it.key().toLatin1().data()).contains("font-size")) {
                        QString val = it.value();
                        styleString.append(it.key().toLatin1().data())
                                .append(": ")
                                .append(val)
                                .append(";" );
                    } else {
                        styleString.append(it.key().toLatin1().data())
                                .append(": ")
                                .append(it.value())
                                .append(";" );
                    }
                }
                if (ownProperties.hasProperty(KoSvgTextProperties::FillId) && !addedFill) {
                    KoColorBackground *b = dynamic_cast<KoColorBackground *>(it->properties.background().data());
                    if (b) {
                        styleString.append("color")
                                .append(": ")
                                .append(b->color().name())
                                .append(";" );
                    }
                }
                context.shapeWriter().addAttribute("style", styleString);
 
                if (d->childCount(siblingCurrent(it)) == 0) {
                    debugFlake << "saveHTML" << this << it->text;
                    // After adding all the styling to the <p> element, add the text
                    context.shapeWriter().addTextNode(it->text);
                }
            }
        } else {
            parentProps.pop_back();
            context.shapeWriter().endElement();
        }
    }
    return success;
}

References KoXmlWriter::addAttribute(), KoXmlWriter::addTextNode(), KoSvgTextProperties::convertParagraphProperties(), KoSvgTextProperties::convertToSvgTextAttributes(), d, debugFlake, KoSvgTextProperties::defaultProperties(), KoXmlWriter::endElement(), KisForestDetail::Enter, KoSvgTextProperties::FillId, KoSvgTextProperties::hasProperty(), KoSvgTextProperties::properties(), HtmlSavingContext::shapeWriter(), and KoXmlWriter::startElement().

◆ saveSvg()

bool KoSvgTextShape::saveSvg ( SvgSavingContext & context )

overridevirtual

Saves SVG data.

Reimplemented from SvgShape.

Definition at line 1298 of file KoSvgTextShape.cpp.

{
    bool success = false;
    for (auto it = d->textData.compositionBegin(); it != d->textData.compositionEnd(); it++) {
        if (it.state() == KisForestDetail::Enter) {
            bool isTextPath = false;
            QMap<QString, QString> shapeSpecificStyles;
            if (it->textPath) {
                isTextPath = true;
            }
            if (it == d->textData.compositionBegin()) {
                context.shapeWriter().startElement("text", false);
 
                if (!context.strippedTextMode()) {
                    context.shapeWriter().addAttribute("id", context.getID(this));
 
                    // save the version to distinguish from the buggy Krita version
                    // 2: Wrong font-size.
                    // 3: Wrong font-size-adjust.
                    context.shapeWriter().addAttribute("krita:textVersion", 3);
 
                    SvgUtil::writeTransformAttributeLazy("transform", transformation(), context.shapeWriter());
                    SvgStyleWriter::saveSvgStyle(this, context);
                } else {
                    SvgStyleWriter::saveSvgFill(this->background(), false, this->outlineRect(), this->size(), this->absoluteTransformation(), context);
                    SvgStyleWriter::saveSvgStroke(this->stroke(), context);
                    SvgStyleWriter::saveSvgBasicStyle(true, 0, paintOrder(),
                                                      inheritPaintOrder(), context, true);
                }
                shapeSpecificStyles = this->shapeTypeSpecificStyles(context);
            } else {
                if (isTextPath) {
                    context.shapeWriter().startElement("textPath", false);
                } else {
                    context.shapeWriter().startElement("tspan", false);
                }
                SvgStyleWriter::saveSvgBasicStyle(it->properties.property(KoSvgTextProperties::Visiblity, true).toBool(),
                                                  it->properties.property(KoSvgTextProperties::Opacity, 0).toReal(),
                                                  it->properties.property(KoSvgTextProperties::PaintOrder,
                                                                          QVariant::fromValue(paintOrder())
                                                                          ).value<QVector<KoShape::PaintOrder>>(),
                                                  !it->properties.hasProperty(KoSvgTextProperties::PaintOrder), context, true);
 
            }
 
            success = it->saveSvg(context,
                                  it == d->textData.compositionBegin(),
                                  d->childCount(siblingCurrent(it)) == 0,
                                  shapeSpecificStyles);
        } else {
            if (it == d->textData.compositionBegin()) {
                SvgStyleWriter::saveMetadata(this, context);
            }
            context.shapeWriter().endElement();
        }
    }
    return success;
}

References KoShape::absoluteTransformation(), background(), d, KisForestDetail::Enter, SvgSavingContext::getID(), KoShape::inheritPaintOrder(), KoSvgTextProperties::Opacity, outlineRect(), KoSvgTextProperties::PaintOrder, paintOrder(), SvgStyleWriter::saveMetadata(), SvgStyleWriter::saveSvgBasicStyle(), SvgStyleWriter::saveSvgFill(), SvgStyleWriter::saveSvgStroke(), SvgStyleWriter::saveSvgStyle(), shapeTypeSpecificStyles(), SvgSavingContext::shapeWriter, KoShape::size(), SvgSavingContext::strippedTextMode, stroke(), KoShape::transformation(), value(), KoSvgTextProperties::Visiblity, and SvgUtil::writeTransformAttributeLazy().

◆ selectionBoxes()

QPainterPath KoSvgTextShape::selectionBoxes	(	int	pos,
		int	anchor )

selectionBoxes returns all selection boxes for a given range. Range will be normalized internally.

Parameters

pos	– the main cursor pos.
anchor	– the anchor from which the selection is calculated.

Returns: a winding-fill style QPainterPath will all boxes added as subpaths.

Definition at line 581 of file KoSvgTextShape.cpp.

{
    int start = qMin(pos, anchor);
    int end = qMax(pos, anchor);
    end = qMin(d->cursorPos.size()-1, end);
 
    if (start == end || start < 0) {
        return QPainterPath();
    }
 
    QPainterPath p;
    p.setFillRule(Qt::WindingFill);
    for (int i = start+1; i <= end; i++) {
        CursorPos cursorPos = d->cursorPos.at(i);
        CharacterResult res = d->result.at(cursorPos.cluster);
        const QTransform tf = res.finalTransform();
        QLineF first = res.cursorInfo.caret;
        QLineF last = first;
        if (res.cursorInfo.rtl) {
            last.translate(res.cursorInfo.offsets.value(cursorPos.offset-1,  res.advance));
            first.translate(res.cursorInfo.offsets.value(cursorPos.offset, QPointF()));
        } else {
            first.translate(res.cursorInfo.offsets.value(cursorPos.offset-1,  QPointF()));
            last.translate(res.cursorInfo.offsets.value(cursorPos.offset, res.advance));
        }
        QPolygonF poly;
        poly << first.p1() << first.p2() << last.p2() << last.p1() << first.p1();
        p.addPolygon(tf.map(poly));
    }
 
    return p;
}

References CharacterResult::advance, KoShape::anchor(), CursorInfo::caret, CharacterResult::cursorInfo, cursorPos, d, CharacterResult::finalTransform(), CursorInfo::offsets, p, and CursorInfo::rtl.

◆ setBackground()

void KoSvgTextShape::setBackground ( QSharedPointer< KoShapeBackground > background )

overridevirtual

Set the background of the shape. A shape background can be a plain color, a gradient, a pattern, be fully transparent or have a complex fill. Setting such a background will allow the shape to be filled and will be able to tell if it is transparent or not.

If the shape inherited the background from its parent, its stops inheriting it, that is inheritBackground property resets to false.

Parameters

background the new shape background.

Reimplemented from KoShape.

Definition at line 1157 of file KoSvgTextShape.cpp.

{
    if (KisForestDetail::size(d->textData) == 0) {
        d->textData.insert(d->textData.childBegin(), KoSvgTextContentElement());
    }
    d->textData.childBegin()->properties.setProperty(KoSvgTextProperties::FillId,
                                                     QVariant::fromValue(KoSvgText::BackgroundProperty(background)));
 
    shapeChangedPriv(BackgroundChanged);
    notifyChanged();
}

References background(), KoShape::BackgroundChanged, d, KoSvgTextProperties::FillId, KoShape::notifyChanged(), KoShape::shapeChangedPriv(), and KisForestDetail::size().

◆ setCharacterTransformsFromLayout()

void KoSvgTextShape::setCharacterTransformsFromLayout ( )

setCharacterTransformsFromLayout Converts the text to a prepositioned SVG 1.1 text. This changes the textType();

Definition at line 1283 of file KoSvgTextShape.cpp.

{
    if (d->result.isEmpty()) return;
    d->setTransformsFromLayout(d->textData, d->result);
    d->cleanUp(d->textData);
    //d->applyWhiteSpace(d->textData, true);
    KoSvgTextProperties props = this->propertiesForPos(-1);
    props.removeProperty(KoSvgTextProperties::InlineSizeId);
    props.removeProperty(KoSvgTextProperties::TextCollapseId);
    props.removeProperty(KoSvgTextProperties::TextWrapId);
 
    setPropertiesAtPos(-1, props);
}

References d, KoSvgTextProperties::InlineSizeId, propertiesForPos(), KoSvgTextProperties::removeProperty(), setPropertiesAtPos(), KoSvgTextProperties::TextCollapseId, and KoSvgTextProperties::TextWrapId.

◆ setFontMatchingDisabled()

void KoSvgTextShape::setFontMatchingDisabled ( const bool disable )

setDisableFontMatching

Parameters

disable font matching when retrieving fonts for text layout (if possible). This speeds up text layout, but should only be done if there's only one font necessary and it can be found with the KoFFWWSconverter.

Definition at line 1524 of file KoSvgTextShape.cpp.

{
    d->disableFontMatching = disable;
}

References d.

◆ setMemento() [1/2]

void KoSvgTextShape::setMemento ( const KoSvgTextShapeMementoSP memento )

Set the text data and layout info, reset listening cursors to 0.

Definition at line 1474 of file KoSvgTextShape.cpp.

{
    setMementoImpl(memento);
    notifyCursorPosChanged(0, 0);
    notifyMarkupChanged();
}

References notifyCursorPosChanged(), notifyMarkupChanged(), and setMementoImpl().

◆ setMemento() [2/2]

void KoSvgTextShape::setMemento	(	const KoSvgTextShapeMementoSP	memento,
		int	pos,
		int	anchor )

Set the text data, layout info and also adjust any listening cursors.

Definition at line 1481 of file KoSvgTextShape.cpp.

{
    setMementoImpl(memento);
    notifyCursorPosChanged(pos, anchor);
    notifyMarkupChanged();
}

References KoShape::anchor(), notifyCursorPosChanged(), notifyMarkupChanged(), and setMementoImpl().

◆ setMementoImpl()

void KoSvgTextShape::setMementoImpl ( const KoSvgTextShapeMementoSP memento )

private

Definition at line 1459 of file KoSvgTextShape.cpp.

{
    KoSvgTextShapeMementoImpl *impl = dynamic_cast<KoSvgTextShapeMementoImpl*>(memento.data());
    if (impl) {
        d->textData = impl->textData;
        d->result = impl->result;
        d->lineBoxes = impl->lineBoxes;
        d->cursorPos = impl->cursorPos;
        d->logicalToVisualCursorPos = impl->logicalToVisualCursorPos;
        d->plainText = impl->plainText;
        d->isBidi = impl->isBidi;
        d->initialTextPosition = impl->initialTextPosition;
    }
}

References KoSvgTextShapeMementoImpl::cursorPos, d, KoSvgTextShapeMementoImpl::initialTextPosition, KoSvgTextShapeMementoImpl::isBidi, KoSvgTextShapeMementoImpl::lineBoxes, KoSvgTextShapeMementoImpl::logicalToVisualCursorPos, KoSvgTextShapeMementoImpl::plainText, KoSvgTextShapeMementoImpl::result, and KoSvgTextShapeMementoImpl::textData.

◆ setPaintOrder()

void KoSvgTextShape::setPaintOrder	(	KoShape::PaintOrder	first,
		KoShape::PaintOrder	second )

overridevirtual

setPaintOrder set the paint order. As there's only three entries in any given paintorder, you only need to have the first and second entry to set it.

Parameters

first	first thing to paint
second	second thing to paint.

Reimplemented from KoShape.

Definition at line 1195 of file KoSvgTextShape.cpp.

{
    if (KisForestDetail::size(d->textData) == 0) {
        d->textData.insert(d->textData.childBegin(), KoSvgTextContentElement());
    }
    KIS_SAFE_ASSERT_RECOVER_RETURN(first != second);
    QVector<PaintOrder> order = KoShape::defaultPaintOrder();
 
    if (first != Fill) {
        if (order.at(1) == first) {
            order[1] = order[0];
            order[0] = first;
        } else if (order.at(2) == first) {
            order[2] = order[0];
            order[0] = first;
        }
    }
    if (second != first && second != Stroke) {
        if (order.at(2) == second) {
            order[2] = order[1];
            order[1] = second;
        }
    }
    d->textData.childBegin()->properties.setProperty(KoSvgTextProperties::PaintOrder,
                                                    QVariant::fromValue(order));
    setInheritPaintOrder(false);
}

References d, KoShape::defaultPaintOrder(), KoShape::Fill, KIS_SAFE_ASSERT_RECOVER_RETURN, KoSvgTextProperties::PaintOrder, KoShape::setInheritPaintOrder(), and KisForestDetail::size().

◆ setPropertiesAtPos()

void KoSvgTextShape::setPropertiesAtPos	(	int	pos,
		KoSvgTextProperties	properties )

setPropertiesAtPos will set the properties at pos.

Parameters

pos
properties

Definition at line 953 of file KoSvgTextShape.cpp.

{
    if (pos < 0 || d->cursorPos.isEmpty()) {
        if (KisForestDetail::size(d->textData)) {
            d->textData.childBegin()->properties = properties;
        }
        notifyChanged();
        shapeChangedPriv(ContentChanged);
        return;
    }
    CursorPos cursorPos = d->cursorPos.at(pos);
    CharacterResult res = d->result.at(cursorPos.cluster);
    int currentIndex = 0;
    auto it = d->findTextContentElementForIndex(d->textData, currentIndex, res.plaintTextIndex);
    if (it != d->textData.depthFirstTailEnd()) {
        it->properties = properties;
        notifyChanged();
        shapeChangedPriv(ContentChanged);
    }
}

References KoShape::ContentChanged, cursorPos, d, KoShape::notifyChanged(), CharacterResult::plaintTextIndex, KoShape::shapeChangedPriv(), and KisForestDetail::size().

◆ setRelayoutBlocked()

void KoSvgTextShape::setRelayoutBlocked ( const bool disable )

Definition at line 1514 of file KoSvgTextShape.cpp.

{
    d->isLoading = disable;
}

References d.

◆ setResolution()

void KoSvgTextShape::setResolution	(	qreal	xRes,
		qreal	yRes )

overridevirtual

Update the image resolution in pixels per inch. Shapes should override this if they need to know the image resolution.

Parameters

xRes
yRes

Reimplemented from KoShape.

Definition at line 171 of file KoSvgTextShape.cpp.

{
    int roundedX = qRound(xRes);
    int roundedY = qRound(yRes);
    if (roundedX != d->xRes || roundedY != d->yRes) {
        d->xRes = roundedX;
        d->yRes = roundedY;
        relayout();
    }
}

References d, relayout(), xRes, and yRes.

◆ setShapesInside()

void KoSvgTextShape::setShapesInside ( QList< KoShape * > shapesInside )

setShapesInside

Parameters

shapesInside the list of shapes to make up the content area.

Definition at line 1717 of file KoSvgTextShape.cpp.

{
    d->shapesInside = shapesInside;
}

References d, and shapesInside.

◆ setShapesSubtract()

void KoSvgTextShape::setShapesSubtract ( QList< KoShape * > shapesSubtract )

setShapesSubtract

Parameters

shapesSubtract the list of shapes that subtract from the wrapping area.

Definition at line 1727 of file KoSvgTextShape.cpp.

{
    d->shapesSubtract = shapesSubtract;
}

References d, and shapesSubtract.

◆ setStroke()

void KoSvgTextShape::setStroke ( KoShapeStrokeModelSP stroke )

overridevirtual

Set a new stroke, removing the old one. The stroke inheritance becomes disabled.

Parameters

stroke the new stroke, or 0 if there should be no stroke.

Reimplemented from KoShape.

Definition at line 1175 of file KoSvgTextShape.cpp.

{
    if (KisForestDetail::size(d->textData) == 0) {
        d->textData.insert(d->textData.childBegin(), KoSvgTextContentElement());
    }
    d->textData.childBegin()->properties.setProperty(KoSvgTextProperties::StrokeId,
                                                     QVariant::fromValue(KoSvgText::StrokeProperty(stroke)));
    shapeChangedPriv(StrokeChanged);
    notifyChanged();
}

References d, KoShape::notifyChanged(), KoShape::shapeChangedPriv(), KisForestDetail::size(), stroke(), KoShape::StrokeChanged, and KoSvgTextProperties::StrokeId.

◆ setTransformsFromLayout()

void KoSvgTextShape::setTransformsFromLayout	(	KisForest< KoSvgTextContentElement > &	tree,
		const QVector< CharacterResult >	layout )

inline

Definition at line 995 of file KoSvgTextShape_p.h.

                                                                                                                  {
        for (int i = 0; i< layout.size(); i++) {
            //split all anchored chunks, so we can set transforms on them.
            if (layout.at(i).anchored_chunk) {
                int plainTextIndex = layout.at(i).plaintTextIndex;
                splitContentElement(tree, plainTextIndex);
            }
        }
 
        int globalIndex = 0;
        for (auto it = tree.childBegin(); it != tree.childEnd(); it++) {
            KoSvgText::WritingMode mode = KoSvgText::WritingMode(
                        it->properties.propertyOrDefault(KoSvgTextProperties::WritingModeId).toInt());
            bool isHorizontal = mode == KoSvgText::HorizontalTB;
            setTransformsFromLayoutImpl(it, KoSvgTextProperties::defaultProperties(), layout, globalIndex, isHorizontal);
        }
    }

References KisForestDetail::Forest< T >::childBegin(), KisForestDetail::Forest< T >::childEnd(), KoSvgTextProperties::defaultProperties(), KoSvgText::HorizontalTB, and KoSvgTextProperties::WritingModeId.

◆ setTransformsFromLayoutImpl()

void KoSvgTextShape::setTransformsFromLayoutImpl	(	KisForest< KoSvgTextContentElement >::child_iterator	current,
		const KoSvgTextProperties	parentProps,
		const QVector< CharacterResult >	layout,
		int &	globalIndex,
		bool	isHorizontal )

inline

Definition at line 1013 of file KoSvgTextShape_p.h.

                                                                          {
        KoSvgTextProperties props = current->properties;
        props.inheritFrom(parentProps);
        if (current->textPath) return; // When we're doing text-on-path, we're already in preformatted mode.
        for (auto it = childBegin(current); it!= childEnd(current); it++) {
            setTransformsFromLayoutImpl(it, props, layout, globalIndex, isHorizontal);
        }
 
        if (current->text.isEmpty()) {
            current->localTransformations.clear();
        } else {
            QVector<KoSvgText::CharTransformation> transforms;
            const int length = current->numChars(true, props);
 
            for (int i = globalIndex; i< globalIndex+length; i++) {
                CharacterResult result = layout.value(i);
 
                if (!result.addressable) {
                    continue;
                }
                KoSvgText::CharTransformation transform;
 
                //TODO: Also split up content element if multiple anchored chunks.
                if (result.anchored_chunk) {
                    int endIndex = 0;
                    qreal shift = anchoredChunkShift(layout, isHorizontal, i, endIndex);
                    QPointF offset = isHorizontal? QPointF(shift, 0): QPointF(0, shift);
                    transform.xPos = result.finalPosition.x() - offset.x();
                    transform.yPos = result.finalPosition.y() - offset.y();
                } else if (i > 0) {
                    CharacterResult resultPrev = layout.value(i-1);
                    QPointF offset = (result.finalPosition - result.cssPosition) - (resultPrev.finalPosition - resultPrev.cssPosition);
 
                    transform.dxPos = offset.x();
                    transform.dyPos = offset.y();
                }
                transform.rotate = result.rotate;
 
                transforms.append(transform);
            }
            current->localTransformations = transforms;
            current->text = current->text.split("\n").join(" ");
            globalIndex += length;
        }
    }

References CharacterResult::addressable, CharacterResult::anchored_chunk, CharacterResult::cssPosition, KoSvgText::CharTransformation::dxPos, KoSvgText::CharTransformation::dyPos, CharacterResult::finalPosition, KoSvgTextProperties::inheritFrom(), length(), KoSvgText::CharTransformation::rotate, CharacterResult::rotate, KoSvgText::CharTransformation::xPos, and KoSvgText::CharTransformation::yPos.

◆ shapeChanged()

void KoSvgTextShape::shapeChanged	(	ChangeType	type,
		KoShape *	shape )

overrideprotectedvirtual

A hook that allows inheriting classes to do something after a KoShape property changed This is called whenever the shape, position rotation or scale properties were altered.

Parameters

type	an indicator which type was changed.
shape	the shape.

Reimplemented from KoShape.

Definition at line 159 of file KoSvgTextShape.cpp.

{
    if (d->isLoading) {
        return;
    }
    KoShape::shapeChanged(type, shape);
 
    if (type == ContentChanged) {
        relayout();
    }
}

References KoShape::ContentChanged, d, relayout(), and KoShape::shapeChanged().

◆ shapesInside()

QList< KoShape * > KoSvgTextShape::shapesInside ( ) const

shapesInside

Returns: the list of shapes that make up the content area.

◆ shapesSubtract()

QList< KoShape * > KoSvgTextShape::shapesSubtract ( ) const

shapesSubtract

Returns: list of subtract shapes.

◆ shapeTypeSpecificStyles()

QMap< QString, QString > KoSvgTextShape::shapeTypeSpecificStyles ( SvgSavingContext & context ) const

Definition at line 1737 of file KoSvgTextShape.cpp.

{
    QMap<QString, QString> map = this->textProperties().convertParagraphProperties();
    if (!d->shapesInside.isEmpty()) {
        QStringList shapesInsideList;
        Q_FOREACH(KoShape* shape, d->shapesInside) {
            QString id = SvgStyleWriter::embedShape(shape, context);
            shapesInsideList.append(QString("url(#%1)").arg(id));
        }
        map.insert("shape-inside", shapesInsideList.join(" "));
    }
    if (!d->shapesSubtract.isEmpty()) {
        QStringList shapesInsideList;
        Q_FOREACH(KoShape* shape, d->shapesSubtract) {
            QString id = SvgStyleWriter::embedShape(shape, context);
            shapesInsideList.append(QString("url(#%1)").arg(id));
        }
        map.insert("shape-subtract", shapesInsideList.join(" "));
    }
 
    return map;
}

References KoSvgTextProperties::convertParagraphProperties(), d, SvgStyleWriter::embedShape(), and textProperties().

◆ splitContentElement()

static bool KoSvgTextShape::splitContentElement	(	KisForest< KoSvgTextContentElement > &	tree,
		int	index )

inlinestatic

splitContentElement split the contentElement in tree at index into two nodes.

Parameters

tree	– tree to work on.
index	– index

Returns: whether it was successful.

Definition at line 655 of file KoSvgTextShape_p.h.

                                                                                         {
        int currentIndex = 0;
 
        // If there's only a single root element, don't bother searching.
        auto contentElement = depth(tree) == 1? tree.depthFirstTailBegin(): findTextContentElementForIndex(tree, currentIndex, index, true);
        if (contentElement == tree.depthFirstTailEnd()) return false;
 
        bool suitableStartIndex = siblingCurrent(contentElement) == tree.childBegin()? index >= currentIndex: index > currentIndex;
        bool suitableEndIndex = siblingCurrent(contentElement) == tree.childBegin()? true: index < currentIndex + contentElement->numChars(false);
 
        if (suitableStartIndex && suitableEndIndex) {
            KoSvgTextContentElement duplicate = KoSvgTextContentElement();
            duplicate.text = contentElement->text;
            int start = index - currentIndex;
            int length = contentElement->numChars(false) - start;
            int zero = 0;
            duplicate.removeText(start, length);
 
            // TODO: handle localtransforms better; annoyingly, this requires whitespace handling
 
            if (siblingCurrent(contentElement) != tree.childBegin()
                    && !contentElement->textPath
                    && contentElement->textLength.isAuto
                    && contentElement->localTransformations.isEmpty()) {
                contentElement->removeText(zero, start);
                duplicate.properties = contentElement->properties;
                tree.insert(siblingCurrent(contentElement), duplicate);
            } else {
                KoSvgTextContentElement duplicate2 = KoSvgTextContentElement();
                duplicate2.text = contentElement->text;
                duplicate2.removeText(zero, start);
                contentElement->text.clear();
                tree.insert(childBegin(contentElement), duplicate);
                tree.insert(childEnd(contentElement), duplicate2);
            }
            return true;
        }
        return false;
    }

References KisForestDetail::Forest< T >::childBegin(), KisForestDetail::Forest< T >::depthFirstTailBegin(), KisForestDetail::Forest< T >::depthFirstTailEnd(), KisForestDetail::Forest< T >::insert(), length(), KoSvgTextContentElement::properties, KoSvgTextProperties::properties(), KoSvgTextContentElement::removeText(), and KoSvgTextContentElement::text.

◆ startIndexOfIterator()

static bool KoSvgTextShape::startIndexOfIterator	(	KisForest< KoSvgTextContentElement >::child_iterator	parent,
		KisForest< KoSvgTextContentElement >::child_iterator	target,
		int &	currentIndex )

inlinestatic

Definition at line 1134 of file KoSvgTextShape_p.h.

                                                                                                                                                                          {
        for (auto child = KisForestDetail::childBegin(parent); child != KisForestDetail::childEnd(parent); child++) {
            if (child == target) {
                return true;
            } else if ((KisForestDetail::childBegin(child) != KisForestDetail::childEnd(child))) {
                if (startIndexOfIterator(child, target, currentIndex)) {
                    return true;
                }
            } else {
                currentIndex += numChars(child);
            }
        }
        return false;
    }

References KisForestDetail::childBegin(), KisForestDetail::childEnd(), and target().

◆ stretchGlyphOnPath()

static QPainterPath KoSvgTextShape::stretchGlyphOnPath	(	const QPainterPath &	glyph,
		const QPainterPath &	path,
		bool	isHorizontal,
		qreal	offset,
		bool	isClosed )

static

◆ stroke()

KoShapeStrokeModelSP KoSvgTextShape::stroke ( ) const

overridevirtual

Returns the currently set stroke, or 0 if there is no stroke.

Returns: the currently set stroke, or 0 if there is no stroke.

Reimplemented from KoShape.

Definition at line 1169 of file KoSvgTextShape.cpp.

{
    KoSvgTextProperties props = KisForestDetail::size(d->textData)? d->textData.childBegin()->properties: KoSvgTextProperties();
    return props.property(KoSvgTextProperties::StrokeId).value<KoSvgText::StrokeProperty>().property;
}

References d, KoSvgTextProperties::properties(), KoSvgTextProperties::property(), KisForestDetail::size(), and KoSvgTextProperties::StrokeId.

◆ textOutline()

KoShape * KoSvgTextShape::textOutline ( ) const

textOutline This turns the text object into non-text KoShape(s) to the best of its abilities.

Returns: a single KoPathShape if only a single path is necessary, or multiple KoShapes (Paths, Images, and Rectangles with Masks are all possible) inside a KoShapeGroup.

Definition at line 1686 of file KoSvgTextShape.cpp.

{
    KoShape *shape;
    int currentIndex = 0;
    if (!d->result.empty()) {
        shape = d->collectPaths(this, d->result, currentIndex);
    }
 
    return shape;
}

References d.

◆ textProperties()

KoSvgTextProperties KoSvgTextShape::textProperties ( ) const

Definition at line 1143 of file KoSvgTextShape.cpp.

{
    return KisForestDetail::size(d->textData)? d->textData.childBegin()->properties: KoSvgTextProperties();
}

References d, KoSvgTextProperties::properties(), and KisForestDetail::size().

◆ textType()

KoSvgTextShape::TextType KoSvgTextShape::textType ( ) const

textType This enum gives an indication of what kind of text this shape is. The different text types are a bit blurry as SVG allows a mixutre to provide fallback information. When such fallback is in place, this will only return the primary text type, that is, TextInShape before InlineWrap and InlineWrap before PrePositioned/Preformatted. This primarily exists to give UI feedback.

Returns: estimated TextType

Definition at line 1697 of file KoSvgTextShape.cpp.

{
    KoSvgText::AutoValue inlineSize = d->textData.childBegin()->properties.propertyOrDefault(KoSvgTextProperties::InlineSizeId).value<KoSvgText::AutoValue>();
    if (!d->shapesInside.isEmpty()) {
        return TextType::TextInShape;
    } else if (!inlineSize.isAuto) {
        return TextType::InlineWrap;
    } else {
        bool textSpaceCollapse = false;
        for (auto it = d->textData.depthFirstTailBegin(); it != d->textData.depthFirstTailEnd(); it++) {
            KoSvgText::TextSpaceCollapse collapse = KoSvgText::TextSpaceCollapse(it->properties.propertyOrDefault(KoSvgTextProperties::TextCollapseId).toInt());
            if (collapse == KoSvgText::Collapse || collapse == KoSvgText::PreserveSpaces) {
                textSpaceCollapse = true;
                break;
            }
        }
        return textSpaceCollapse? TextType::PrePositionedText: TextType::PreformattedText;
    }
}

References KoSvgText::Collapse, d, KoSvgTextProperties::InlineSizeId, InlineWrap, KoSvgText::AutoValue::isAuto, PreformattedText, PrePositionedText, KoSvgText::PreserveSpaces, KoSvgTextProperties::TextCollapseId, and TextInShape.

◆ underlines()

QPainterPath KoSvgTextShape::underlines	(	int	pos,
		int	anchor,
		KoSvgText::TextDecorations	decor,
		KoSvgText::TextDecorationStyle	style,
		qreal	minimum,
		bool	thick )

Definition at line 614 of file KoSvgTextShape.cpp.

{
    int start = qMin(pos, anchor);
    int end = qMax(pos, anchor);
 
    if (start == end || start < 0 || end >= d->cursorPos.size()) {
        return QPainterPath();
    }
    QPainterPathStroker stroker;
 
    KoSvgText::WritingMode mode = KoSvgText::WritingMode(this->textProperties().propertyOrDefault(KoSvgTextProperties::WritingModeId).toInt());
    stroker.setCapStyle(Qt::FlatCap);
    if (style == KoSvgText::Solid) {
        stroker.setDashPattern(Qt::SolidLine);
    } else if (style == KoSvgText::Dashed) {
        stroker.setDashPattern(Qt::DashLine);
    } else if (style == KoSvgText::Dotted) {
        stroker.setDashPattern(Qt::DotLine);
    } else {
        stroker.setDashPattern(Qt::SolidLine);
    }
 
    QPainterPath underPath;
    QPainterPath overPath;
    QPainterPath middlePath;
    qint32 strokeWidth = 0;
    QPointF inset = mode == KoSvgText::HorizontalTB? QPointF(minimum*0.5, 0): QPointF(0, minimum*0.5);
    for (int i = start+1; i <= end; i++) {
        CursorPos pos = d->cursorPos.at(i);
        CharacterResult res = d->result.at(pos.cluster);
        strokeWidth += res.metrics.underlineThickness;
        const QTransform tf = res.finalTransform();
        QPointF first = res.cursorInfo.caret.p1();
        QPointF last = first;
        if (res.cursorInfo.rtl) {
            last  += res.cursorInfo.offsets.value(pos.offset-1,  res.advance);
            first += res.cursorInfo.offsets.value(pos.offset, QPointF());
            if (i == start+1) {
                first -= inset;
            }
            if (i == end) {
                last += inset;
            }
        } else {
            first += res.cursorInfo.offsets.value(pos.offset-1,  QPointF());
            last  += res.cursorInfo.offsets.value(pos.offset, res.advance);
            if (i == start+1) {
                first += inset;
            }
            if (i == end) {
                last -= inset;
            }
        }
 
        if (decor.testFlag(KoSvgText::DecorationUnderline)){
            underPath.moveTo(tf.map(first));
            underPath.lineTo(tf.map(last));
        }
        QPointF diff = res.cursorInfo.caret.p2() - res.cursorInfo.caret.p1();
        if (decor.testFlag(KoSvgText::DecorationOverline)){
            overPath.moveTo(tf.map(first+diff));
            overPath.lineTo(tf.map(last+diff));
        }
        if (decor.testFlag(KoSvgText::DecorationLineThrough)){
            middlePath.moveTo(tf.map(first+(diff*0.5)));
            middlePath.lineTo(tf.map(last+(diff*0.5)));
        }
    }
 
    const qreal freetypePixelsToPt = (1.0 / 64.0) * (72. / qMin(d->xRes, d->yRes));
    const qreal width = strokeWidth > 0 ? qMax(qreal(strokeWidth/qMax(1, end-(start+1)))*freetypePixelsToPt, minimum): minimum;
 
    stroker.setWidth(thick? width*2: width);
 
    QPainterPath final;
    if (decor.testFlag(KoSvgText::DecorationUnderline)){
        final.addPath(stroker.createStroke(underPath));
    }
    if (decor.testFlag(KoSvgText::DecorationOverline)){
        final.addPath(stroker.createStroke(overPath));
    }
    if (decor.testFlag(KoSvgText::DecorationLineThrough)){
        final.addPath(stroker.createStroke(middlePath));
    }
 
    return final;
}

References CharacterResult::advance, KoShape::anchor(), CursorInfo::caret, CursorPos::cluster, CharacterResult::cursorInfo, d, KoSvgText::Dashed, KoSvgText::DecorationLineThrough, KoSvgText::DecorationOverline, KoSvgText::DecorationUnderline, KoSvgText::Dotted, CharacterResult::finalTransform(), KoSvgText::HorizontalTB, CharacterResult::metrics, CursorPos::offset, CursorInfo::offsets, CursorInfo::rtl, KoSvgText::Solid, textProperties(), KoSvgText::FontMetrics::underlineThickness, and KoSvgTextProperties::WritingModeId.

◆ wordEnd()

int KoSvgTextShape::wordEnd ( int pos )

wordEnd return the pos of the first wordbreak.

Parameters

pos	– cursor position.

Returns: the first wordbreak or line end.

Definition at line 477 of file KoSvgTextShape.cpp.

{
    if (pos < 0 || pos > d->cursorPos.size()-1 || d->result.isEmpty() || d->cursorPos.isEmpty()) {
        return pos;
    }
    int currentLineEnd = lineEnd(pos);
    if (pos == lineStart(pos) || pos == currentLineEnd) {
        return pos;
    }
 
    int wordEnd = pos;
    for (int i = pos; i<= currentLineEnd; i++) {
        wordEnd = i;
        CursorPos cursorPos = d->cursorPos.at(i);
        if (d->result.at(cursorPos.cluster).cursorInfo.isWordBoundary && cursorPos.offset == 0) {
            break;
        }
 
    }
 
    return wordEnd;
}

References cursorPos, d, lineEnd(), lineStart(), and wordEnd().

◆ wordLeft()

int KoSvgTextShape::wordLeft	(	int	pos,
		bool	visual = false )

wordLeft return the cursorpos for the word left or the extreme of the line.

Parameters

pos	the position.
visual	whether to flip for rtl.

Returns: the first pos before a wordbreak at the left.

Definition at line 286 of file KoSvgTextShape.cpp.

{
    //TODO: figure out preferred behaviour for wordLeft in RTL && visual.
    Q_UNUSED(visual)
    if (pos < 0 || pos > d->cursorPos.size()-1 || d->result.isEmpty() || d->cursorPos.isEmpty()) {
        return pos;
    }
    KoSvgText::Direction direction = KoSvgText::Direction(this->textProperties().propertyOrDefault(KoSvgTextProperties::DirectionId).toInt());
    if (direction == KoSvgText::DirectionRightToLeft) {
        return wordEnd(pos);
    }
    return wordStart(pos);
}

References d, KoSvgTextProperties::DirectionId, KoSvgText::DirectionRightToLeft, textProperties(), wordEnd(), and wordStart().

◆ wordRight()

int KoSvgTextShape::wordRight	(	int	pos,
		bool	visual = false )

wordRight return the cursorpos for the word right or the extreme of the line.

Parameters

pos	the position.
visual	whether to flip for rtl.

Returns: the first word break at the right.

Definition at line 300 of file KoSvgTextShape.cpp.

{
    Q_UNUSED(visual)
    if (pos < 0 || pos > d->cursorPos.size()-1 || d->result.isEmpty() || d->cursorPos.isEmpty()) {
        return pos;
    }
    KoSvgText::Direction direction = KoSvgText::Direction(this->textProperties().propertyOrDefault(KoSvgTextProperties::DirectionId).toInt());
    if (direction == KoSvgText::DirectionRightToLeft) {
        return wordStart(pos);
    }
    return wordEnd(pos);
}

References d, KoSvgTextProperties::DirectionId, KoSvgText::DirectionRightToLeft, textProperties(), wordEnd(), and wordStart().

◆ wordStart()

int KoSvgTextShape::wordStart ( int pos )

wordStart return the first pos before a wordbreak in the start direction.

Parameters

pos	– cursor position

Returns: the first position before a wordbreak or the line start.

Definition at line 500 of file KoSvgTextShape.cpp.

{
    if (pos < 0 || pos > d->cursorPos.size()-1 || d->result.isEmpty() || d->cursorPos.isEmpty()) {
        return pos;
    }
    int currentLineStart = lineStart(pos);
    if (pos == currentLineStart || pos == lineEnd(pos)) {
        return pos;
    }
 
    int wordStart = pos;
    bool breakNext = false;
    for (int i = pos; i >= currentLineStart; i--) {
        if (breakNext) break;
        CursorPos cursorPos = d->cursorPos.at(i);
        if (d->result.at(cursorPos.cluster).cursorInfo.isWordBoundary && cursorPos.offset == 0) {
            breakNext = true;
        }
        wordStart = i;
    }
 
    return wordStart;
}

References cursorPos, d, lineEnd(), lineStart(), and wordStart().

◆ writingMode()

KoSvgText::WritingMode KoSvgTextShape::writingMode ( ) const

writingMode There's a number of places we need to check the writing mode to provide proper controls.

Returns: the writing mode of this text.

Definition at line 1228 of file KoSvgTextShape.cpp.

{
    return KoSvgText::WritingMode(this->textProperties().propertyOrDefault(KoSvgTextProperties::WritingModeId).toInt());
}

References textProperties(), and KoSvgTextProperties::WritingModeId.

Friends And Related Symbol Documentation

◆ KoSvgTextLoader

friend class KoSvgTextLoader

friend

Definition at line 518 of file KoSvgTextShape.h.

◆ TestSvgText

friend class TestSvgText

friend

Definition at line 517 of file KoSvgTextShape.h.

Member Data Documentation

◆ cursorPos

QVector<CursorPos> KoSvgTextShape::cursorPos

Definition at line 488 of file KoSvgTextShape_p.h.

◆ d

QScopedPointer<Private> KoSvgTextShape::d

private

Definition at line 545 of file KoSvgTextShape.h.

◆ disableFontMatching

bool KoSvgTextShape::disableFontMatching = false

Turn off font matching, which should speed up relayout slightly.

Definition at line 483 of file KoSvgTextShape_p.h.

◆ initialTextPosition

QPointF KoSvgTextShape::initialTextPosition = QPointF()

Definition at line 493 of file KoSvgTextShape_p.h.

◆ isBidi

bool KoSvgTextShape::isBidi = false

Definition at line 492 of file KoSvgTextShape_p.h.

◆ isLoading

bool KoSvgTextShape::isLoading = false

Turned on when loading in text data, blocks updates to shape listeners.

Definition at line 481 of file KoSvgTextShape_p.h.

◆ lineBoxes

QVector<LineBox> KoSvgTextShape::lineBoxes

Definition at line 486 of file KoSvgTextShape_p.h.

◆ logicalToVisualCursorPos

QMap<int, int> KoSvgTextShape::logicalToVisualCursorPos

Definition at line 489 of file KoSvgTextShape_p.h.

◆ plainText

QString KoSvgTextShape::plainText

Definition at line 491 of file KoSvgTextShape_p.h.

◆ result

QVector<CharacterResult> KoSvgTextShape::result

Definition at line 485 of file KoSvgTextShape_p.h.

◆ shapesInside

QList< KoShape * > KoSvgTextShape::shapesInside

Definition at line 477 of file KoSvgTextShape_p.h.

◆ shapesSubtract

QList< KoShape * > KoSvgTextShape::shapesSubtract

Definition at line 478 of file KoSvgTextShape_p.h.

◆ textData

KisForest<KoSvgTextContentElement> KoSvgTextShape::textData

Definition at line 480 of file KoSvgTextShape_p.h.

◆ xRes

int KoSvgTextShape::xRes = 72

Definition at line 475 of file KoSvgTextShape_p.h.

◆ yRes

int KoSvgTextShape::yRes = 72

Definition at line 476 of file KoSvgTextShape_p.h.

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

libs/flake/text/KoSvgTextShape.h
libs/flake/text/KoSvgTextShape_p.h
libs/flake/text/KoSvgTextShape.cpp

index	- index (not cursorpos!) of the start position.
length	- total length of text to remove.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ DebugElement

◆ TextType

Constructor & Destructor Documentation

◆ KoSvgTextShape() [1/2]

◆ KoSvgTextShape() [2/2]

◆ ~KoSvgTextShape()

◆ ~Private()

Member Function Documentation

◆ anchoredChunkShift()

◆ applyAnchoring()

◆ applyTextLength()

◆ applyTextPath()

◆ applyWhiteSpace()

◆ applyWhiteSpaceImpl()

◆ background()

◆ boundingRect()

◆ characterResultOnPath()

◆ childCount()

◆ cleanUp() [1/2]

◆ cleanUp() [2/2]

◆ clearAssociatedOutlines()

◆ cloneShape()

◆ collapsedWhiteSpacesForText()

◆ collectPaths()

◆ collectSubChunks()

◆ computeFontMetrics()

◆ computeTextDecorations()

◆ convertCharTransformsToPreformatted()

◆ copyRange()

◆ createTextNodeIndex()

◆ cursorForPos()

◆ debugParsing()

◆ defaultCursorShape()

◆ defaultPlaceholderText()

◆ enterNodeSubtree()

◆ finalizeDecoration()

◆ findNodeIndexForPropertyId()

◆ findRangeForNodeIndex()

◆ findTextContentElementForIndex()

◆ fontMatchingDisabled()

◆ generateDecorationPaths()

◆ getMemento()

◆ handleLineBoxAlignment()

◆ indexForPos()

◆ initialTextPosition()

◆ insertNewLinesAtAnchors()

◆ insertNewLinesAtAnchorsImpl()

◆ insertRichText()

◆ insertText()

◆ insertTransforms()

◆ insertTransformsImpl()

◆ iteratorForTreeIndex()

◆ leaveNodeSubtree()

◆ lineEnd()

◆ lineStart()

◆ loadGlyph()

◆ loadGlyphOnly()

◆ mergePropertiesIntoRange()

◆ nextIndex()

◆ nextLine()

◆ nextPos()

◆ notifyCursorPosChanged()

◆ notifyMarkupChanged()

◆ numChars()

◆ outline()

◆ outlineRect()

◆ paint()

◆ paintDebug() [1/2]