Класс QTextBrowser

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

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

Свойства

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

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

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

• 62 открытых функции унаследовано от QTextEdit
• 20 открытых функций унаследовано от QAbstractScrollArea
• 14 открытых функций унаследовано от QFrame
• 211 открытых функций унаследовано от QWidget
• 31 открытых функций унаследовано от 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

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

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

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

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

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

Если вы хотите предоставить пользователям редактор форматированного текста, используйте QTextEdit. Если вам нужен браузер текста без навигации по гиперссылкам, используйте QTextEdit и отключите редактирование с помощью QTextEdit::setReadOnly(). Если вам просто нужно отобразить небольшой фрагмент форматированного текста, используйте 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 = Q_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().

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

Переопределено из QObject::event().

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

Переопределено из QWidget::focusNextPrevChild().

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

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

[virtual slot] void QTextBrowser::forward()

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

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

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

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

int QTextBrowser::forwardHistoryCount() const

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

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

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

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

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

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

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

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

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

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

connect(textBrowser, static_cast<void(QTextBrowser::*)(const QString &)>(&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().

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

Переопределено из QWidget::keyPressEvent().

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[virtual slot] void QTextBrowser::reload()

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

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

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

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