MauiKit Terminal
TerminalDisplay.h
80 * @brief A widget which displays output from a terminal emulation and sends input keypresses and mouse activity to the terminal.
82 * When the terminal emulation receives new output from the program running in the terminal, it will update the display by calling updateImage().
84 * This class is exposed to the QML engine as `QMLTermWidget` and forms part of the `Terminal` control implementation.
86 * @note This class is not part of any public API, and its usage is restricted via the QML exposed type `QMLTermWidget`
135 Q_PROPERTY(int scrollbarCurrentValue READ getScrollbarValue WRITE setScrollbarValue NOTIFY scrollbarParamsChanged)
160 Q_PROPERTY(bool fullCursorHeight READ fullCursorHeight WRITE setFullCursorHeight NOTIFY fullCursorHeightChanged)
165 Q_PROPERTY(bool blinkingCursor READ blinkingCursor WRITE setBlinkingCursor NOTIFY blinkingCursorStateChanged)
175 Q_PROPERTY(QStringList availableColorSchemes READ availableColorSchemes NOTIFY availableColorSchemesChanged)
185 Q_PROPERTY(qreal backgroundOpacity READ backgroundOpacity WRITE setBackgroundOpacity NOTIFY backgroundOpacityChanged)
190 Q_PROPERTY(CustomColorScheme* customColorScheme READ customColorScheme CONSTANT FINAL)
255 * Depending on the type of the hotspots created by the filter ( returned by Filter::Hotspot::type() )
315 };
587 /** Returns the terminal screen section which is displayed in this widget. See setScreenWindow() */
672 * The user interaction needed to create selections will also change, and the user will be required
677 * @param usesMouse Set to true if the program running in the terminal is interested in mouse events
715 void simulateKeyPress(int key, int modifiers, bool pressed, quint32 nativeScanCode, const QString &text);
743 * @param button The mouse button (0 for left button, 1 for middle button, 2 for right button, 3 for release)
764 * When the shortcut is overridden, the key sequence will be sent to the terminal emulation instead
894 void drawTextFragment(QPainter &painter, const QRect &rect, const QString &text, const Character *style);
899 void drawBackground(QPainter &painter, const QRect &rect, const QColor &color, bool useOpacitySetting);
901 void drawCursor(QPainter &painter, const QRect &rect, const QColor &foregroundColor, const QColor &backgroundColor, bool &invertColors);
903 void drawCharacters(QPainter &painter, const QRect &rect, const QString &text, const Character *style, bool invertCharacterColor);
905 void drawLineCharString(QPainter &painter, int x, int y, QStringView str, const Character *attributes) const;
A single character in the terminal which consists of a unicode character value, foreground and backgr...
Definition Character.h:63
KeyboardCursorShape
This enum describes the available shapes for the keyboard cursor.
Definition Emulation.h:128
A chain which allows a group of filters to be processed as one.
Definition Filter.h:320
Provides a window onto a section of a terminal screen.
Definition ScreenWindow.h:52
A widget which displays output from a terminal emulation and sends input keypresses and mouse activit...
Definition TerminalDisplay.h:89
static bool antialias()
Returns true if anti-aliasing of text in the terminal is enabled.
Definition TerminalDisplay.h:506
Q_INVOKABLE int fontHeight()
Returns the height of the characters in the font used to draw the text in the display.
Definition TerminalDisplay.h:401
void keyPressedSignal(QKeyEvent *e, bool fromPaste)
Emitted when the user presses a key whilst the terminal widget has focus.
QFont getVTFont()
Returns the font used to draw characters in the display.
Definition TerminalDisplay.h:484
bool blinkingCursor()
Returns true if the cursor is set to blink or false otherwise.
Definition TerminalDisplay.h:287
int lines()
Returns the number of lines of text which can be displayed in the widget.
Definition TerminalDisplay.h:382
void setTerminalSizeHint(bool on)
Sets whether or not the current height and width of the terminal in lines and columns is displayed wh...
Definition TerminalDisplay.h:538
void setTerminalSizeStartup(bool on)
Sets whether the terminal size display is shown briefly after the widget is first shown.
Definition TerminalDisplay.h:557
bool getBoldIntense()
Returns true if characters with intense colors are rendered in bold.
Definition TerminalDisplay.h:528
void configureRequest(const QPoint &position)
Emitted when the user right clicks on the display, or right-clicks with the Shift key held down if us...
int bellMode()
Returns the type of effect used to alert the user when a 'bell' occurs in the terminal session.
Definition TerminalDisplay.h:457
bool isBidiEnabled()
Returns the status of the BiDi rendering in this widget.
Definition TerminalDisplay.h:573
QString wordCharacters()
Returns the characters which are considered part of a word for the purpose of selecting words in the ...
Definition TerminalDisplay.h:438
void setTripleClickMode(TripleClickMode mode)
Sets how the text is selected when the user triple clicks within the display.
Definition TerminalDisplay.h:317
static void setAntialias(bool antialias)
Specified whether anti-aliasing of text in the terminal display is enabled or not.
Definition TerminalDisplay.h:499
BellMode
This enum describes the different types of sounds and visual effects which can be used to alert the u...
Definition TerminalDisplay.h:467
ScrollBarPosition
This enum describes the location where the scroll bar is positioned in the display widget.
Definition TerminalDisplay.h:223
bool terminalSizeHint()
Returns whether or not the current height and width of the terminal in lines and columns is displayed...
Definition TerminalDisplay.h:547
void mouseSignal(int button, int column, int line, int eventType)
A mouse event occurred.
void overrideShortcutCheck(QKeyEvent *keyEvent, bool &override)
When a shortcut which is also a valid terminal key sequence is pressed while the terminal widget has ...
TripleClickMode
This enum describes the methods for selecting text when the user triple-clicks within the display.
Definition TerminalDisplay.h:310
bool flowControlWarningEnabled() const
Returns true if the flow control warning box is enabled.
Definition TerminalDisplay.h:651
void setDrawLineChars(bool drawLineChars)
Specify whether line chars should be drawn by ourselves or left to underlying font rendering librarie...
Definition TerminalDisplay.h:515
void setBidiEnabled(bool set)
Sets the status of the BiDi rendering inside the terminal display.
Definition TerminalDisplay.h:566
int columns()
Returns the number of characters of text which can be displayed on each line in the widget.
Definition TerminalDisplay.h:393
Q_SCRIPTABLE Q_NOREPLY void start()
void update(Part *part, const QByteArray &data, qint64 dataSize)
const QList< QKeySequence > & pasteSelection()
ColorRole
InputMethodQuery
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 29 2024 11:55:13 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 29 2024 11:55:13 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.