[Python3] [PyQt5] QTextBrowserに文字列を追加するとスクロールバーが一番上になる

Question

self.textBrowser = QTextBrowser(self.centralwidget)
self.textBrowser.setObjectName(u"textBrowser")

# 文字列追加処理
self.textBrowser.setText(str(self.textBrowser.toPlainText()) + "test\n")

上記の文字列追加処理を行った場合、追加するたびにスクロールバーが一番上に来ていて、最新の文字列を見るためにはスクロールバーを自力で操作しなくてはなりません。

文字列を追加した際にスクロールバーを最下段に固定するにはどうしたらよいのでしょうか？

Answer 1

テキスト追加時のみであれば append() も使えます。

self.textBrowser.append("test")

中の実装は、can110さんの回答と同じですが、
若干挙動が違う部分があって、

現在のスクロールバーの状態が、一番下であれば自動でスクロールされます。
そうでない場合は、スクロールしません。

これは、ログ等が頻繁に流れる場合で、
途中のテキストを見たい場合に、自動スクロールしてしまうと、
対象のテキストをじっくりと見れず困ることがあるので、そういった時に便利な挙動になります。

厳密には、append()ではスクロールしない状況もあるので、
質問の要件を満たせないことも有るのですが、
目的・用途に応じて使い分けて下さい。

---

該当部分のソースコード(C++)

void QTextEdit::append(const QString &text)
{
    Q_D(QTextEdit);
    const bool atBottom = isReadOnly() ?  d->verticalOffset() >= d->vbar->maximum() :
            d->control->textCursor().atEnd();
    d->control->append(text);
    if (atBottom)
        d->vbar->setValue(d->vbar->maximum());
}

widgets/qtextedit.cpp append() source code

Comments

[question01]

ありがとうございます。

append() であれば setText() よりも簡単に命令でき、さらに改行コードも必要ないのでとても有用でした。
今回の質問させていただいた処理ではログの流れを見たかったので、verticalScrollBar() を使わせていただきましたが、ログの内容が重要な処理の時には append() を使わせていただきたいと思います。

setText() より指定が簡単な append() と verticalScrollBar() を組み合わせれば今よりもっと簡単に処理ができそうです。

いつも有用な追加情報ありがとうございます。

[teamikl]

テキスト挿入に関しては、（スクロールは別として）
append代替なら insert を組み合わせる方が良いかも知れませんね。
カーソル操作が必要なので、1行ではできませんが

tb.moveCursor(QtGui.QTextCursor.End) # カーソルを末尾に移動
tb.insertPlainText("text" + "\n") # カーソル位置にテキスト挿入

ログを追加の度に、内容を全部複製するのは避けられます。

[question01]

追加情報に対する返信が遅れていまい申し訳ありません。

自分が最初にしていた setText で「全ログ + 追加文字列」に比べればとてもスマートな命令文です！

append と insert の細かな違いがあるのでしょうか？
文字列の追加が出来て、スクロールの自動追跡可/不可ぐらいならどちらでも対応できそうだと思うのですが。

[teamikl]

insert はカーソルの現在位置に追加です。スクロールはしない。
append は末尾に追加に加えて、必要があればスクロールとなります。

insert の方がカーソル操作次第ではより細かな操作が可能で、
append は良くある操作に特化といった感じです。
(appendの内部ではカーソル移動 + insertを使ってます)

append では上述の通り、スクロールしないことがあるので、
この用途では insert + 強制スクロールが適切ですね。

append + 強制スクロールだと
append 内でのスクロールが余分になります。

----
d->control->append(text); の内部詳細

※ C++言語ですが、API呼び出しだけでも追ってみると
insert で append 相当の操作をする際の参考になります。

https://code.qt.io/cgit/qt/qtbase.git/tree/src/widgets/widgets/qwidgettextcontrol.cpp?h=dev#n3185

細かな違いはありますが、用途次第ではそれ程影響のある違いはありません。
テキストの書式情報や、「Undo」の際にひとまとまりの処理として扱う等。

[question01]

細かな説明ありがとうございます。

確かに二重でスクロール処理をする必要はなさそうです。
処理に応じて使い分けさせてもらいます。
ありがとうございます。

Answer 2

以下のようにverticalScrollBar()を取得して、その最大値をセットすればよいです。

import sys
from PyQt5 import QtWidgets
from PyQt5.QtWidgets import QApplication, QWidget

def on_clicked():
    tb.setText(str(tb.toPlainText()) + "test\n")
    sb = tb.verticalScrollBar()
    sb.setValue(sb.maximum())

a = QApplication(sys.argv)
w = QWidget()
w.setLayout(QtWidgets.QVBoxLayout())
l = w.layout()

tb = QtWidgets.QTextBrowser()
tb.setText(''.join(['abc\n' for _ in range(10)]))
l.addWidget(tb)

pb = QtWidgets.QPushButton('Add')
pb.clicked.connect(on_clicked)
l.addWidget(pb)

w.resize(320, 240)
w.show()

sys.exit(a.exec_())

Comments

[question01]

ありがとうございます。

この処理を求めていました！