Класс QTextBoundaryFinder

Класс QTextBoundaryFinder предоставляет способ нахождения границ юникод-текста в строке. Подробнее...

Заголовок:	#include <QTextBoundaryFinder>
qmake:	QT += core
С момента:	Qt 4.4

Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются повторно входящими.

Типы публичного интерфейса

Перечисление	BoundaryReason { NotAtBoundary, BreakOpportunity, StartOfItem, EndOfItem, MandatoryBreak, SoftHyphen }
Флаги	BoundaryReasons
Перечисление	BoundaryType { Grapheme, Word, Line, Sentence }

Публичные функции

	QTextBoundaryFinder()
	QTextBoundaryFinder(const QTextBoundaryFinder &other)
	QTextBoundaryFinder(QTextBoundaryFinder::BoundaryType type, const QString &string)
	QTextBoundaryFinder(QTextBoundaryFinder::BoundaryType type, const QChar *chars, int length, unsigned char *buffer = nullptr, int bufferSize = 0)
	~QTextBoundaryFinder()
QTextBoundaryFinder::BoundaryReasons	boundaryReasons() const
bool	isAtBoundary() const
bool	isValid() const
int	position() const
void	setPosition(int position)
QString	string() const
void	toEnd()
int	toNextBoundary()
int	toPreviousBoundary()
void	toStart()
QTextBoundaryFinder::BoundaryType	type() const
QTextBoundaryFinder &	operator=(const QTextBoundaryFinder &other)

Подробное описание

Класс QTextBoundaryFinder предоставляет способ нахождения границ юникод-текста в строке.

QTextBoundaryFinder позволяет находить границы юникод-текста в строке в соответствии со спецификацией границ юникод-текста (см. Приложение #14 к стандарту Юникод и Приложение #29 к стандарту Юникод).

QTextBoundaryFinder может работать со строкой QString в четырёх возможных режимах в зависимости от значения BoundaryType.

Единицы юникод-символов, составляющие то, что пользователь воспринимает как символ или базовую единицу языка, здесь называются кластерами графем. Например, два юникод-символа «A» + диэрез образуют один кластер графем, так как пользователь воспринимает их как один символ, но в этом случае он представлен двумя юникод-кодовыми точками (см. http://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries).

Границы слов предназначены для определения начала и конца того, что язык считает словом (см. http://www.unicode.org/reports/tr29/#Word_Boundaries).

Границы разрыва строк указывают возможные места, где может произойти разрыв строки, а граница предложения покажет начало и конец целого предложения (см. http://www.unicode.org/reports/tr29/#Sentence_Boundaries и http://www.unicode.org/reports/tr14/).

Первая позиция в строке всегда является допустимой границей и относится к позиции перед первым символом. Последняя позиция в длине строки также допустима и относится к позиции после последнего символа.

Документация по типам членов

перечисление QTextBoundaryFinder::BoundaryReasonФлаги QTextBoundaryFinder::BoundaryReasons

Константа	Значение	Описание
`QTextBoundaryFinder::NotAtBoundary`	`0`	Поиск границ не находится в позиции границы.
`QTextBoundaryFinder::BreakOpportunity`	`0x1f`	Поиск границ находится в позиции возможности разрыва. Такая возможность разрыва также может быть границей элемента (либо StartOfItem, либо EndOfItem, или сочетание обоих), обязательным разрывом строки или мягким тире.
`QTextBoundaryFinder::StartOfItem`	`0x20`	Начиная с версии 5.0. Поиск границ находится в начале графемы, слова, предложения или строки.
`QTextBoundaryFinder::EndOfItem`	`0x40`	Начиная с версии 5.0. Поиск границ находится в конце графемы, слова, предложения или строки.
`QTextBoundaryFinder::MandatoryBreak`	`0x80`	Начиная с версии 5.0. Поиск границ находится в конце строки (может произойти только для типа границы Line).
`QTextBoundaryFinder::SoftHyphen`	`0x100`	Поиск границ находится в мягком тире (может произойти только для типа границы Line).

Тип BoundaryReasons является псевдонимом для QFlags<BoundaryReason>. Он хранит комбинацию значений BoundaryReason через операцию OR.

перечисление QTextBoundaryFinder::BoundaryType

Константа	Значение	Описание
`QTextBoundaryFinder::Grapheme`	`0`	Находит графему, которая является наименьшей границей. Она включает буквы, знаки препинания, цифры и многое другое.
`QTextBoundaryFinder::Word`	`1`	Находит слово.
`QTextBoundaryFinder::Line`	`3`	Находит возможные позиции для разбиения текста на несколько строк.
`QTextBoundaryFinder::Sentence`	`2`	Находит границы предложения. Они включают точки, вопросительные знаки и т. д.

Документация по функциям членов

QTextBoundaryFinder::QTextBoundaryFinder()

Создаёт недействительный объект QTextBoundaryFinder.

QTextBoundaryFinder::QTextBoundaryFinder(const QTextBoundaryFinder &other)

Копирует объект QTextBoundaryFinder, other.

QTextBoundaryFinder::QTextBoundaryFinder(QTextBoundaryFinder::BoundaryType type, const QString &string)

Создаёт объект QTextBoundaryFinder типа type, работающий со строкой string.

QTextBoundaryFinder::QTextBoundaryFinder(QTextBoundaryFinder::BoundaryType type, const QChar **chars, int length*, unsigned char **buffer* = nullptr, int bufferSize = 0)

Создаёт объект QTextBoundaryFinder типа type, работающий с chars длиной length.

buffer — это необязательный рабочий буфер размером bufferSize, который вы можете передать объекту QTextBoundaryFinder. Если буфер достаточно велик для хранения необходимых рабочих данных (bufferSize >= length + 1), он будет использован вместо выделения собственного буфера.

Предупреждение: QTextBoundaryFinder не создаёт копию chars. Приложением программиста гарантируется, что массив выделен до тех пор, пока объект QTextBoundaryFinder остаётся активным. То же самое относится к buffer.

QTextBoundaryFinder::~QTextBoundaryFinder()

Уничтожает объект QTextBoundaryFinder.

QTextBoundaryFinder::BoundaryReasons QTextBoundaryFinder::boundaryReasons() const

Возвращает причины, по которым поиск границ определил текущую позицию как границу.

bool QTextBoundaryFinder::isAtBoundary() const

Возвращает true, если позиция объекта position() в данный момент находится на корректной границе текста.

bool QTextBoundaryFinder::isValid() const

Возвращает true, если поиск границ текста валиден; в противном случае возвращает false. По умолчанию QTextBoundaryFinder не валиден.

int QTextBoundaryFinder::position() const

Возвращает текущую позицию QTextBoundaryFinder.

Диапазон от 0 (начало строки) до длины строки включительно.

См. также setPosition().

void QTextBoundaryFinder::setPosition(int position)

Устанавливает текущую позицию QTextBoundaryFinder в position.

Если position выходит за пределы, она будет ограничена только допустимыми позициями. В этом случае допустимые позиции — от 0 до длины строки включительно.

См. также position().

QString QTextBoundaryFinder::string() const

Возвращает строку, с которой работает объект QTextBoundaryFinder.

void QTextBoundaryFinder::toEnd()

Перемещает указатель в конец строки. Это эквивалентно setPosition(string.length()).

См. также setPosition() и position().

int QTextBoundaryFinder::toNextBoundary()

Перемещает QTextBoundaryFinder к следующей позиции границы и возвращает эту позицию.

Возвращает -1, если следующей границы нет.

int QTextBoundaryFinder::toPreviousBoundary()

Перемещает QTextBoundaryFinder к предыдущей позиции границы и возвращает эту позицию.

Возвращает -1, если предыдущей границы нет.

void QTextBoundaryFinder::toStart()

Перемещает указатель в начало строки. Это эквивалентно setPosition(0).