Класс QTextBrowser

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

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

Свойства

Открытые функции

Переопределенные открытые функции

Открытые слоты

Сигналы

Переопределенные защищенные функции

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

Этот класс расширяет QTextEdit (в режиме только для чтения), добавляя некоторые функции навигации, чтобы пользователи могли следовать ссылкам в гипертекстовых документах.

Если вы хотите предоставить пользователям редактор форматированного текста с возможностью редактирования, используйте QTextEdit. Если вам нужен браузер текста без навигации по гиперссылкам, используйте QTextEdit и используйте QTextEdit::setReadOnly(), чтобы отключить редактирование. Если вам просто нужно отобразить небольшой фрагмент форматированного текста, используйте QLabel.

Источник документа и его содержимое

Содержимое QTextEdit устанавливается с помощью setHtml() или setPlainText(), но QTextBrowser также реализует функцию setSource(), что позволяет использовать именованный документ в качестве исходного текста. Имя ищется в списке путей поиска и в каталоге текущего фабрики документов.

Если имя документа оканчивается на якорь (например, "#anchor"), браузер автоматически прокручивает просмотр к этому положению (используя scrollToAnchor()). Когда пользователь нажимает на гиперссылку, браузер сам вызовет setSource() с значением href ссылки в качестве аргумента. Вы можете отслеживать текущий источник, подключившись к сигналу sourceChanged().

Навигация

QTextBrowser предоставляет слоты backward() и forward(), которые вы можете использовать для реализации кнопок «Назад» и «Вперед». Слоты home() устанавливает текст на первый отображаемый документ. Сигнал anchorClicked() генерируется, когда пользователь нажимает на якорь. Чтобы переопределить стандартное поведение навигации браузера, вызовите функцию setSource(), чтобы предоставить новый текст документа в слоте, подключенном к этому сигналу.

Если вы хотите загружать документы, хранящиеся в системе ресурсов Qt, используйте qrc в качестве схемы в URL для загрузки. Например, для пути к ресурсу документа :/docs/index.html используйте qrc:/docs/index.html в качестве URL с setSource().

См. также QTextEdit и QTextDocument.

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

QTextBrowser::QTextBrowser(QWidget *parent = nullptr)

Создаёт пустой QTextBrowser с родителем parent.

[signal] void QTextBrowser::anchorClicked(const QUrl &link)

Этот сигнал отправляется, когда пользователь нажимает на якорь. URL, на который ссылается якорь, передаётся в link.

Обратите внимание, что браузер автоматически обработает переходы по местоположению, указанному в link, если свойство openLinks не установлено в false или вы не вызываете setSource() в подключённом слоте. Этот механизм используется для переопределения стандартных функций навигации в браузере.

[virtual slot] void QTextBrowser::backward()

Изменяет отображаемый документ на предыдущий документ в списке документов, созданном при навигации по ссылкам. Ничего не делает, если нет предыдущего документа.

См. также forward() и backwardAvailable().

[signal] void QTextBrowser::backwardAvailable(bool available)

Этот сигнал отправляется при изменении доступности backward(). available — false, когда пользователь находится на странице home; в противном случае — true.

[virtual slot] void QTextBrowser::forward()

Изменяет отображаемый документ на следующий документ в списке документов, созданном при навигации по ссылкам. Ничего не делает, если нет следующего документа.

См. также backward() и forwardAvailable().

[signal] void QTextBrowser::forwardAvailable(bool available)

Этот сигнал отправляется при изменении доступности forward(). available — true после навигации backward() и false, когда пользователь переходит или переходит по forward().

[signal] void QTextBrowser::highlighted(const QString &link)

Это перегруженная функция.

Удобный сигнал, позволяющий подключиться к слоту, принимающему только QString, например, к сообщению QStatusBar().

Примечание: Сигнал highlighted перегружен в этом классе. Для подключения к этому сигналу с помощью синтаксиса указателя на функцию Qt предоставляет удобный помощник для получения указателя на функцию, как показано в этом примере:

connect(textBrowser, QOverload<const QString &>::of(&QTextBrowser::highlighted),
    [=](const QString &link){ /* ... */ });

[signal] void QTextBrowser::highlighted(const QUrl &link)

Этот сигнал отправляется, когда пользователь выбрал, но не активировал якорь в документе. URL, на который ссылается якорь, передаётся в link.

Примечание: Сигнал highlighted перегружен в этом классе. Для подключения к этому сигналу с помощью синтаксиса указателя на функцию Qt предоставляет удобный помощник для получения указателя на функцию, как показано в этом примере:

connect(textBrowser, QOverload<const QUrl &>::of(&QTextBrowser::highlighted),
    [=](const QUrl &link){ /* ... */ });

[signal] void QTextBrowser::historyChanged()

Этот сигнал отправляется при изменении истории.

Эта функция была добавлена в Qt 4.4.

См. также historyTitle() и historyUrl().

[virtual slot] void QTextBrowser::home()

Изменяет отображаемый документ на первый документ из истории.

[virtual slot] void QTextBrowser::reload()

Перезагружает текущий заданный источник.

[signal] void QTextBrowser::sourceChanged(const QUrl &src)

Этот сигнал отправляется при изменении источника, src — новый источник.

Изменения источника происходят как программно, при вызове setSource(), forward(), backward() или home(), так и при нажатии пользователем на ссылки или нажатии эквивалентных комбинаций клавиш.

int QTextBrowser::backwardHistoryCount() const

Возвращает количество местоположений назад в истории.

Эта функция была добавлена в Qt 4.4.

void QTextBrowser::clearHistory()

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

Эта функция была добавлена в Qt 4.2.

См. также backward() и forward().

[override virtual protected] bool QTextBrowser::event(QEvent *e)

[override virtual protected] bool QTextBrowser::focusNextPrevChild(bool next)

Реализует: QTextEdit::focusNextPrevChild(bool next).

[override virtual protected] void QTextBrowser::focusOutEvent(QFocusEvent *ev)

Реализует: QTextEdit::focusOutEvent(QFocusEvent *e).

int QTextBrowser::forwardHistoryCount() const

Возвращает количество позиций вперёд в истории.

Данная функция была добавлена в Qt 4.4.

QString QTextBrowser::historyTitle(int i) const

Возвращает documentTitle() элемента истории.

backaction.setToolTip(browser.historyTitle(-1));
forwardaction.setToolTip(browser.historyTitle(+1));

Данная функция была добавлена в Qt 4.4.

QUrl QTextBrowser::historyUrl(int i) const

Возвращает URL элемента истории.

Данная функция была добавлена в Qt 4.4.

bool QTextBrowser::isBackwardAvailable() const

Возвращает true , если текстовый браузер может перейти назад в истории документа с помощью backward().

Данная функция была добавлена в Qt 4.2.

См. также backwardAvailable() и backward().

bool QTextBrowser::isForwardAvailable() const

Возвращает true , если текстовый браузер может перейти вперёд в истории документа с помощью forward().

Данная функция была добавлена в Qt 4.2.

См. также forwardAvailable() и forward().

[override virtual protected] void QTextBrowser::keyPressEvent(QKeyEvent *ev)

Переопределяет: QTextEdit::keyPressEvent(QKeyEvent *e).

Событие ev используется для предоставления следующих сочетаний клавиш:

[override virtual] QVariant QTextBrowser::loadResource(int type, const QUrl &name)

Переопределяет: QTextEdit::loadResource(int type, const QUrl &name).

Эта функция вызывается при загрузке документа и для каждого изображения в документе. Параметр type указывает тип ресурса, который требуется загрузить. Недействительный QVariant возвращается, если ресурс не может быть загружен.

В реализации по умолчанию параметр type игнорируется, и попытка поиска ресурсов осуществляется с интерпретацией name как имени файла. Если это не абсолютный путь, то поиск файла производится в пути свойств searchPaths и в той же директории, что и текущий источник. В случае успеха, результатом является QVariant, хранящий QByteArray с содержимым файла.

Если вы переопределяете эту функцию, вы можете вернуть другие типы QVariant. В таблице ниже показаны поддерживаемые типы вариантов в зависимости от типа ресурса:

[override virtual protected] void QTextBrowser::mouseMoveEvent(QMouseEvent *e)

Переопределяет: QTextEdit::mouseMoveEvent(QMouseEvent *e).

[override virtual protected] void QTextBrowser::mousePressEvent(QMouseEvent *e)

Переопределяет: QTextEdit::mousePressEvent(QMouseEvent *e).

[override virtual protected] void QTextBrowser::mouseReleaseEvent(QMouseEvent *e)

Переопределяет: QTextEdit::mouseReleaseEvent(QMouseEvent *e).

[override virtual protected] void QTextBrowser::paintEvent(QPaintEvent *e)

Переопределяет: QTextEdit::paintEvent(QPaintEvent *event).