Класс 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, например, к message() 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()

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

[slot] void QTextBrowser::setSource(const QUrl &url, QTextDocument::ResourceType type)

Попытка загрузить документ по указанному url со специфицированным type.

Если type равен UnknownResource (значение по умолчанию), тип документа будет определён: если url оканчивается расширением .md, .mkd или .markdown, документ будет загружен через QTextDocument::setMarkdown; иначе — через QTextDocument::setHtml(). Это определение можно обойти, явно указав type.

Примечание: Функция-сеттер для свойства source.

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

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

Изменение источника происходит как программно, при вызове setSource(), forward(), backword() или home(), так и при нажатии пользователем на ссылки или соответствующих последовательностей клавиш.

int QTextBrowser::backwardHistoryCount() const

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

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

void QTextBrowser::clearHistory()

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

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

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

[protected] void QTextBrowser::doSetSource(const QUrl &url, QTextDocument::ResourceType type = QTextDocument::UnknownResource)

Попытка загрузить документ по указанному url со специфицированным type.

setSource() вызывает doSetSource. В Qt 5, setSource(const QUrl &url) был виртуальным. В Qt 6, doSetSource() стал виртуальным, чтобы его можно было переопределить в подклассах.

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

Переопределяет: QAbstractScrollArea::event(QEvent *event).

[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).