QTermWidget

Overview

A terminal emulator widget for Qt 5.

QTermWidget is an open-source project originally based on the KDE4 Konsole application, but it took its own direction later on. The main goal of this project is to provide a Unicode-enabled, embeddable Qt widget for using as a built-in console (or terminal emulation widget).

It is compatible with BSD, Linux and OS X.

This project is licensed under the terms of the GPLv2 or any later version. See the LICENSE file for the full text of the license. Some files are published under compatible licenses:

Files: example/main.cpp
       lib/TerminalCharacterDecoder.cpp
       lib/TerminalCharacterDecoder.h
       lib/kprocess.cpp
       lib/kprocess.h
       lib/kpty.cpp
       lib/kpty.h
       lib/kpty_p.h
       lib/kptydevice.cpp
       lib/kptydevice.h
       lib/kptyprocess.cpp
       lib/kptyprocess.h
       lib/qtermwidget.cpp
       lib/qtermwidget.h
       lib/qtermwidget_interface.h
Copyright: Author Adriaan de Groot <groot@kde.org>
           2010, KDE e.V <kde-ev-board@kde.org>
           2002-2007, Oswald Buddenhagen <ossi@kde.org>
           2006-2008, Robert Knight <robertknight@gmail.com>
           2002, Waldo Bastian <bastian@kde.org>
           2008, e_k <e_k@users.sourceforge.net>
           2022, Francesc Martinez <info@francescmm.com>
License: LGPL-2+

Files: cmake/FindUtf8Proc.cmake
Copyright: 2009-2011, Kitware, Inc
           2009-2011, Philip Lowman <philip@yhbt.com>
License: BSD-3-clause

Installation

Compiling sources

The only runtime dependency is qtbase ≥ 5.12.0. Build dependencies are as follows:

CMake ≥ 3.1.0 serves as the build system and therefore needs to be present to compile.
The latest lxqt-build-tools is also needed for compilation.
Git is needed to optionally pull latest VCS checkouts.

Code configuration is handled by CMake. CMake variable CMAKE_INSTALL_PREFIX will normally have to be set to /usr, depending on the way library paths are dealt with on 64bit systems. Variables like CMAKE_INSTALL_LIBDIR may have to be set as well.

To build, run make. To install, run make install which accepts variable DESTDIR as usual.

To build PyQt bindings, build this library first, and then invoke sip-wheel in pyqt/ directory. Environment variables CXXFLAGS and LDFLAGS can be used to specify non-installed or non-standard directories for headers and shared libraries, and the built Python wheel can be installed by standard tools like pip. See the CI script for a complete example.

Binary packages

The library is provided by all major Linux distributions. This includes Arch Linux, Debian, Fedora, openSUSE and all of their children, given they use the same package repositories. Just use the distributions’ package managers to search for string qtermwidget.

Translation

Translations can be done in LXQt-Weblate

API

Public Types

Type | Variable | —: | :— enum | ScrollBarPosition { NoScrollBar, ScrollBarLeft, ScrollBarRight } enum | KeyboardCursorShape { BlockCursor, UnderlineCursor, IBeamCursor }

Properties

flowControlEnabled : bool
getPtySlaveFd : const int
getShellPID : int
getTerminalFont : QFont
historyLinesCount : int
icon : const QString
keyBindings : QString
screenColumnsCount : int
selectedText(bool preserveLineBreaks = true) : QString
sizeHint : const QSize
terminalSizeHint : bool
title : const QString
workingDirectory : QString

Public Functions

Public Slots

Signals

Static Public Members

Protected Functions

Type | Function | —: | :— virtual void | resizeEvent(QResizeEvent*)

Protected Slots

Member Type Documentation

enum QTermWidget::ScrollBarPosition
This enum describes the location where the scroll bar is positioned in the display widget when calling QTermWidget::setScrollBarPosition().

Constant | Value | Description | — | :—: | — | QTermWidget::NoScrollBar | 0x0 | Do not show the scroll bar. QTermWidget::ScrollBarLeft | 0x1 | Show the scroll bar on the left side of the display. QTermWidget::ScrollBarRight | 0x2 | Show the scroll bar on the right side of the display.

enum QTermWidget::KeyboardCursorShape
This enum describes the available shapes for the keyboard cursor when calling QTermWidget::setKeyboardCursorShape().

Constant | Value | Description | — | :—: | — | QTermWidget::BlockCursor | 0x0 | A rectangular block which covers the entire area of the cursor character. QTermWidget::UnderlineCursor | 0x1 | A single flat line which occupies the space at the bottom of the cursor character’s area. QTermWidget::IBeamCursor | 0x2 | A cursor shaped like the capital letter ‘I’, similar to the IBeam cursor used in Qt/KDE text editors.

Property Documentation

flowControlEnabled : bool
Returns whether flow control is enabled.

getPtySlaveFd : const int
Returns a pty slave file descriptor. This can be used for display and control a remote terminal.

historyLinesCount : int
Returns the number of lines in the history buffer.

keyBindings : QString
Returns current key bindings.

selectedText(bool preserveLineBreaks = true) : QString
Returns the currently selected text.

Member Function Documentation

__void changeDir(const QString &dir)__
Attempt to change shell directory (Linux only).

__void clear()__
Clear the terminal content and move to home position.

__void copyClipboard()__
Copy selection to clipboard.

__void pasteClipboard()__
Paste clipboard to terminal.

__void pasteSelection()__
Paste selection to terminal.

__void receivedData(const QString &text)__
Signals that we received new data from the process running in the terminal emulator.

__void scrollToEnd()__
Wrapped, scroll to end of text.

__void sendData(const char*, int)__
Emitted when emulator send data to the terminal process (redirected for external recipient). It can be used for control and display the remote terminal.

__void sendText(QString &text)__
Send text to terminal.

__void setArgs(QStringList &args)__
Sets the shell program arguments, default is none.

__void setAutoClose(bool enabled)__
Automatically close the terminal session after the shell process exits or keep it running.

__void setColorScheme(const QString &name)__
Sets the color scheme, default is white on black.

__void setEnvironment(const QStringList &environment)__
Sets environment variables.

__void setFlowControlEnabled(bool enabled)__
Sets whether flow control is enabled.

__void setFlowControlWarningEnabled(bool enabled)__
Sets whether the flow control warning box should be shown when the flow control stop key (Ctrl+S) is pressed.

__void setHistorySize(int lines)__
History size for scrolling.

__void setKeyBindings(const QString &kb)__
Set named key binding for given widget.

__void setKeyboardCursorShape(QTermWidget::KeyboardCursorShape shape)__
Sets the shape of the keyboard cursor. This is the cursor drawn at the position in the terminal where keyboard input will appear.

__void setScrollBarPosition(QTermWidget::ScrollBarPosition pos)__
Sets presence and position of scrollbar.

__void setShellProgram(const QString &program)__
Sets the shell program, default is /bin/bash.

__void setTerminalFont(QFont &font)__
Sets terminal font. Default is application font with family Monospace, size 10. Beware of a performance penalty and display/alignment issues when using a proportional font.

__void setTerminalSizeHint(bool enabled)__
Exposes TerminalDisplay::TerminalSizeHint.

__void setTextCodec(QTextCodec *codec)__
Sets text codec, default is UTF-8.

__void startShellProgram()__
Starts shell program if it was not started in constructor.

__void startTerminalTeletype()__
Starts terminal teletype as is and redirect data for external recipient. It can be used for display and control a remote terminal.

__void zoomIn()__
Zooms in on the text.

__void zoomOut()__
Zooms out in on the text.