QTextBoundaryFinder¶

The QTextBoundaryFinder class provides a way of finding Unicode text boundaries in a string. More…

Synopsis¶

Functions¶

def boundaryReasons ()
def isAtBoundary ()
def isValid ()
def position ()
def setPosition (position)
def string ()
def toEnd ()
def toNextBoundary ()
def toPreviousBoundary ()
def toStart ()
def type ()

Detailed Description¶

QTextBoundaryFinder allows to find Unicode text boundaries in a string, accordingly to the Unicode text boundary specification (see Unicode Standard Annex #14 and Unicode Standard Annex #29 ).

QTextBoundaryFinder can operate on a QString in four possible modes depending on the value of BoundaryType .

Units of Unicode characters that make up what the user thinks of as a character or basic unit of the language are here called Grapheme clusters. The two unicode characters ‘A’ + diaeresis do for example form one grapheme cluster as the user thinks of them as one character, yet it is in this case represented by two unicode code points (see https://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries ).

Word boundaries are there to locate the start and end of what a language considers to be a word (see https://www.unicode.org/reports/tr29/#Word_Boundaries ).

Line break boundaries give possible places where a line break might happen and sentence boundaries will show the beginning and end of whole sentences (see https://www.unicode.org/reports/tr29/#Sentence_Boundaries and https://www.unicode.org/reports/tr14/ ).

The first position in a string is always a valid boundary and refers to the position before the first character. The last position at the length of the string is also valid and refers to the position after the last character.

class PySide2.QtCore.QTextBoundaryFinder¶

PySide2.QtCore.QTextBoundaryFinder(type, string)

PySide2.QtCore.QTextBoundaryFinder(other)

param type:

BoundaryType

param string:

str

param other:

PySide2.QtCore.QTextBoundaryFinder

Constructs an invalid QTextBoundaryFinder object.

Creates a QTextBoundaryFinder object of type operating on string .

Copies the QTextBoundaryFinder object, other .

PySide2.QtCore.QTextBoundaryFinder.BoundaryType¶

Constant	Description
QTextBoundaryFinder.Grapheme	Finds a grapheme which is the smallest boundary. It including letters, punctuation marks, numerals and more.
QTextBoundaryFinder.Word	Finds a word.
QTextBoundaryFinder.Line	Finds possible positions for breaking the text into multiple lines.
QTextBoundaryFinder.Sentence	Finds sentence boundaries. These include periods, question marks etc.

PySide2.QtCore.QTextBoundaryFinder.BoundaryReason¶

Constant	Description
QTextBoundaryFinder.NotAtBoundary	The boundary finder is not at a boundary position.
QTextBoundaryFinder.BreakOpportunity	The boundary finder is at a break opportunity position. Such a break opportunity might also be an item boundary (either , , or combination of both), a mandatory line break, or a soft hyphen.
QTextBoundaryFinder.StartOfItem	Since 5.0. The boundary finder is at the start of a grapheme, a word, a sentence, or a line.
QTextBoundaryFinder.EndOfItem	Since 5.0. The boundary finder is at the end of a grapheme, a word, a sentence, or a line.
QTextBoundaryFinder.MandatoryBreak	Since 5.0. The boundary finder is at the end of line (can occur for a Line boundary type only).
QTextBoundaryFinder.SoftHyphen	The boundary finder is at the soft hyphen (can occur for a Line boundary type only).

PySide2.QtCore.QTextBoundaryFinder.boundaryReasons()¶

Return type:: BoundaryReasons

Returns the reasons for the boundary finder to have chosen the current position as a boundary.

PySide2.QtCore.QTextBoundaryFinder.isAtBoundary()¶

Return type:: bool

Returns true if the object’s position() is currently at a valid text boundary.

PySide2.QtCore.QTextBoundaryFinder.isValid()¶

Return type:: bool

Returns true if the text boundary finder is valid; otherwise returns false . A default QTextBoundaryFinder is invalid.

PySide2.QtCore.QTextBoundaryFinder.position()¶

Return type:: int

Returns the current position of the QTextBoundaryFinder .

The range is from 0 (the beginning of the string) to the length of the string inclusive.

Table of Contents

Previous topic

Next topic

QTextBoundaryFinder¶

Synopsis¶

Functions¶

Detailed Description¶