Класс QTextBrowser

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

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

Свойства

• 17 свойств унаследовано от QTextEdit
• 3 свойства унаследовано от QAbstractScrollArea
• 6 свойств унаследовано от QFrame
• 59 свойств унаследовано от QWidget
• 1 свойство унаследовано от QObject

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

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

• 62 открытые функции унаследованы от QTextEdit
• 20 открытых функций унаследованы от QAbstractScrollArea
• 14 открытых функций унаследованы от QFrame
• 214 открытых функций унаследованы от QWidget
• 34 открытых функций унаследованы от QObject
• 14 открытых функций унаследованы от QPaintDevice

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

• 25 открытых слотов унаследовано от QTextEdit
• 19 открытых слотов унаследовано от QWidget
• 1 открытый слот унаследован от QObject

Сигналы

• 7 сигналов унаследовано от QTextEdit
• 3 сигнала унаследовано от QWidget
• 2 сигнала унаследовано от QObject

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

• 24 защищенных функции унаследованы от QTextEdit
• 20 защищенных функций унаследованы от QAbstractScrollArea
• 4 защищенных функции унаследованы от QFrame
• 35 защищенных функций унаследованы от QWidget
• 9 защищенных функций унаследованы от QObject
• 1 защищенная функция унаследована от QPaintDevice

Дополнительные унаследованные члены

• 1 public variable inherited from QObject
• 5 static public members inherited from QWidget
• 10 static public members inherited from QObject
• 24 protected functions inherited from QTextEdit
• 20 protected functions inherited from QAbstractScrollArea
• 4 protected functions inherited from QFrame
• 35 protected functions inherited from QWidget
• 9 protected functions inherited from QObject
• 1 protected function inherited from QPaintDevice
• 1 protected slot inherited from QWidget
• 2 protected variables inherited from QObject
• 1 protected type inherited from QPaintDevice

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

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

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

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

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

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

Если имя документа заканчивается якорем (например, "#anchor"), браузер автоматически прокручивает текст до этого якоря (используя scrollToAnchor()). При щелчке пользователем на гиперссылке браузер вызовет setSource() с значением ссылки в качестве аргумента. Вы можете отслеживать текущий источник, подключившись к сигналу 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.

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

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

Переопределено из QTextEdit::focusOutEvent().

[virtual slot] void QTextBrowser::forward()

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

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

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

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

int QTextBrowser::forwardHistoryCount() const

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

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

[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::highlighted(const QString &link)

Это перегруженный метод.

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

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

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

[signal] void QTextBrowser::historyChanged()

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

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

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

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.

[virtual slot] void QTextBrowser::home()

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

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

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

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

Переопределено из QTextEdit::loadResource().

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

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

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

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

Переопределено из QTextEdit::mouseMoveEvent().

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

Переопределено из QTextEdit::mousePressEvent().

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

Переопределено из QTextEdit::mouseReleaseEvent().

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

Переопределено из QTextEdit::paintEvent().

[virtual slot] void QTextBrowser::reload()

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

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

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

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