feat(example): add RemoteTerm example target and Qt6 fixes#595
Open
yangwei-x wants to merge 1 commit intolxqt:masterfrom
Open
feat(example): add RemoteTerm example target and Qt6 fixes#595yangwei-x wants to merge 1 commit intolxqt:masterfrom
yangwei-x wants to merge 1 commit intolxqt:masterfrom
Conversation
yangwei-x
commented
Sep 15, 2025
yangwei-x
commented
- Add optional RemoteTerm example (BUILD_EXAMPLE_REMOTETERM) with CMake target 'remoteterm'
- Use QStringLiteral for usage message in RemoteTerm main.cpp for Qt6 compatibility.
Add optional RemoteTerm example (BUILD_EXAMPLE_REMOTETERM) with CMake target 'remoteterm' Use QStringLiteral for usage message in RemoteTerm main.cpp for Qt6 compatibility.
Member
|
@yan12125 |
yan12125
reviewed
Sep 18, 2025
Member
yan12125
left a comment
yan12125
left a comment
There was a problem hiding this comment.
Some thoughts after a quick glance. Didn't test them yet
| Examples using QTermWidget | ||
| ========================== | ||
|
|
||
| This directory contains minimal examples showing how to embed and use `QTermWidget` in both C++ and Python (PyQt/PySide) applications. |
Member
There was a problem hiding this comment.
Currently there is only PyQt binding, no official one for PySide yet.
| -------- | ||
| * `cpp/main.cpp` – Basic single–terminal C++ example with menu actions (Find / Copy / Paste / About Qt) and runtime selection of color schemes and key bindings via command‑line arguments. | ||
| * `cpp/RemoteTerm/` – A simple remote client example that connects to a TCP server exposing a pseudo terminal. Local keystrokes are sent to the remote host; data received over the socket is written into the local PTY backing the widget. | ||
| * `pyqt/` – Python examples (PyQt/PySide) demonstrating how to instantiate and configure the terminal widget from Python. See the files inside for details. |
| mkdir -p build | ||
| cd build | ||
| cmake -DBUILD_EXAMPLE=ON -DBUILD_EXAMPLE_REMOTETERM=ON .. | ||
| cmake --build . -j |
Member
There was a problem hiding this comment.
Personally I'm not a fan of -j, which often makes the system hang, especially on not-so-powerful machines.
|
|
||
| Python Examples | ||
| --------------- | ||
| Install the Python bindings (PyQt6 recommended for Qt6 builds) and run the scripts directly, for example: |
Member
There was a problem hiding this comment.
Minor: PyQt5 is no longer supported. Only PyQt6 is supported, so it is not only recommended, but also needed for the Python example.
Member
|
Running Apparently the signal is renamed. Here is a quick fix: diff --git a/examples/cpp/RemoteTerm/remoteterm.cpp b/examples/cpp/RemoteTerm/remoteterm.cpp
index 551ac25..b48be65 100644
--- a/examples/cpp/RemoteTerm/remoteterm.cpp
+++ b/examples/cpp/RemoteTerm/remoteterm.cpp
@@ -18,7 +18,9 @@ RemoteTerm::RemoteTerm(const QString &ipaddr, quint16 port, QWidget *parent)
QByteArray data = socket->readAll();
write(this->getPtySlaveFd(), data.data(), data.size());
});
- connect(socket, SIGNAL(error(QAbstractSocket::SocketError)),this,SLOT(atError()));
+ connect(socket, &QTcpSocket::errorOccurred, [this](QAbstractSocket::SocketError){
+ atError();
+ });
// Here we start an empty pty.
this->startTerminalTeletype();After this, I got "Connection refused" for a random IP and port as expected. It would be great to have an example for the server to actually test the functionality of this program. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.