#include <TerminalDisplay.h>

Inheritance diagram for Konsole::TerminalDisplay:

[legend]

Public Types
enum	BellMode { SystemBeepBell = 0 , NotifyBell = 1 , VisualBell = 2 , NoBell = 3 }

enum	ScrollBarPosition { NoScrollBar = 0 , ScrollBarLeft = 1 , ScrollBarRight = 2 }

enum	TripleClickMode { SelectWholeLine , SelectForwardsFromCursor }

Public Types inherited from QQuickPaintedItem
enum	PerformanceHint

enum	RenderTarget

Public Types inherited from QQuickItem
enum	Flag

enum	ItemChange

enum	TransformOrigin

Properties
bool	antialiasText

QStringList	availableColorSchemes

QColor	backgroundColor

qreal	backgroundOpacity

bool	blinkingCursor

QString	colorScheme

int	columns

CustomColorScheme *	customColorScheme

bool	enableBold

QFont	font

QSize	fontMetrics

QColor	foregroundColor

bool	fullCursorHeight

bool	isTextSelected

int	lines

int	lineSpacing

bool	readOnly

int	scrollbarCurrentValue

int	scrollbarMaximum

int	scrollbarMinimum

KSession *	session

QSize	terminalSize

bool	terminalUsesMouse

Properties inherited from QQuickPaintedItem
	contentsScale

	contentsSize

	fillColor

	renderTarget

	textureSize

Properties inherited from QQuickItem
	activeFocus

	activeFocusOnTab

	antialiasing

	baselineOffset

	childrenRect

	clip

	containmentMask

	enabled

	focus

	height

	implicitHeight

	implicitWidth

	opacity

	parent

	rotation

	scale

	smooth

	state

	transformOrigin

	visible

	width

	x

	y

	z

Properties inherited from QObject
	objectName

Signals
void	availableColorSchemesChanged ()

void	backgroundColorChanged ()

void	backgroundOpacityChanged ()

void	blinkingCursorStateChanged ()

void	boldIntenseChanged ()

void	changedContentSizeSignal (int height, int width)

void	changedFontMetricSignal (qreal height, qreal width)

void	colorSchemeChanged ()

void	configureRequest (const QPoint &position)

void	copyAvailable (bool available)

void	foregroundColorChanged ()

void	fullCursorHeightChanged ()

void	imagePainted ()

void	isBusySelecting (bool busy)

void	isTextSelectedChanged ()

void	keyPressedSignal (QKeyEvent *e, bool fromPaste)

void	lineSpacingChanged ()

void	mouseSignal (int button, int column, int line, int eventType)

void	notifyBell (const QString &bell)

void	overrideShortcutCheck (QKeyEvent *keyEvent, bool &override)

void	readOnlyChanged ()

void	scrollbarParamsChanged (int value)

void	scrollbarValueChanged ()

void	sendStringToEmu (const char *)

void	sessionChanged ()

void	sizeChanged ()

void	termGetFocus ()

void	termLostFocus ()

void	usesMouseChanged ()

void	vtFontChanged ()

Public Slots
QStringList	availableColorSchemes ()

QColor	backgroundColor () const

qreal	backgroundOpacity () const

void	bell (const QString &message)

bool	bracketedPasteMode () const

QString	colorScheme () const

void	copyClipboard ()

void	findNext (const QString &regexp)

void	findPrevious (const QString &regexp)

bool	flowControlWarningEnabled () const

QColor	foregroundColor () const

void	matchFound (int startColumn, int startLine, int endColumn, int endLine)

void	noMatchFound ()

void	outputSuspended (bool suspended)

void	pasteClipboard ()

void	pasteSelection ()

QString	selectedText () const

void	selectionChanged ()

void	setBackgroundColor (const QColor &color)

void	setBackgroundOpacity (qreal backgroundOpacity)

void	setBracketedPasteMode (bool bracketedPasteMode)

void	setColorScheme (const QString &name)

void	setFlowControlWarningEnabled (bool enabled)

void	setForegroundColor (const QColor &color)

void	setUsesMouse (bool usesMouse)

void	simulateKeyPress (int key, int modifiers, bool pressed, quint32 nativeScanCode, const QString &text)

void	simulateKeySequence (const QKeySequence &sequence)

void	simulateMouseDoubleClick (int x, int y, int button, int buttons, int modifiers)

void	simulateMouseMove (int x, int y, int button, int buttons, int modifiers)

void	simulateMousePress (int x, int y, int button, int buttons, int modifiers)

void	simulateMouseRelease (int x, int y, int button, int buttons, int modifiers)

void	simulateWheel (int x, int y, int buttons, int modifiers, QPoint angleDelta)

void	updateFilters ()

void	updateImage ()

void	updateLineProperties ()

bool	usesMouse () const

Public Member Functions
	TerminalDisplay (QQuickItem *parent=nullptr)

int	bellMode ()

bool	blinkingCursor ()

bool	bracketedPasteModeIsDisabled () const

void	bracketText (QString &text) const

std::span< const ColorEntry >	colorTable () const

int	columns ()

bool	ctrlDrag ()

CustomColorScheme *	customColorScheme () const

void	disableBracketedPasteMode (bool disable)

void	emitSelection (bool useXselection, bool appendReturn)

QList< QAction * >	filterActions (const QPoint &position)

FilterChain *	filterChain () const

Q_INVOKABLE int	fontHeight ()

int	fontWidth ()

bool	fullCursorHeight () const

bool	getBoldIntense ()

CharPos	getCharacterPosition (const QPointF &widgetPoint) const

QFont	getVTFont ()

bool	isBidiEnabled ()

bool	isTextSelected () const

QColor	keyboardCursorColor () const

Emulation::KeyboardCursorShape	keyboardCursorShape () const

int	lines ()

uint	lineSpacing () const

int	margin () const

int	motionAfterPasting ()

void	processFilters ()

uint	randomSeed () const

bool	readOnly () const

ScreenWindow *	screenWindow () const

void	scrollToEnd ()

void	setBellMode (int mode)

void	setBidiEnabled (bool set)

void	setBlinkingCursor (bool blink)

void	setBlinkingTextEnabled (bool blink)

void	setBoldIntense (bool value)

void	setColorTable (std::array< ColorEntry, TABLE_COLORS > &&table)

void	setConfirmMultilinePaste (bool confirmMultilinePaste)

void	setCtrlDrag (bool enable)

void	setDrawLineChars (bool drawLineChars)

void	setFixedSize (int cols, int lins)

void	setKeyboardCursorColor (bool useForegroundColor, const QColor &color)

void	setKeyboardCursorShape (Emulation::KeyboardCursorShape shape)

void	setLineSpacing (uint)

void	setMargin (int)

void	setMotionAfterPasting (MotionAfterPasting action)

void	setRandomSeed (uint seed)

void	setReadOnly (bool newReadOnly)

void	setScreenWindow (ScreenWindow *window)

void	setScroll (int cursor, int lines)

void	setScrollBarPosition (QTermWidget::ScrollBarPosition position)

void	setSelection (const QString &t)

void	setSize (int cols, int lins)

void	setTerminalSizeHint (bool on)

void	setTerminalSizeStartup (bool on)

void	setTrimPastedTrailingNewlines (bool trimPastedTrailingNewlines)

void	setTripleClickMode (TripleClickMode mode)

void	setVTFont (const QFont &font)

void	setWordCharacters (const QString &wc)

QSize	sizeHint () const

bool	terminalSizeHint ()

TripleClickMode	tripleClickMode ()

QString	wordCharacters ()

Public Member Functions inherited from QQuickPaintedItem
	QQuickPaintedItem (QQuickItem *parent)

bool	antialiasing () const const

QRectF	contentsBoundingRect () const const

qreal	contentsScale () const const

void	contentsScaleChanged ()

QSize	contentsSize () const const

void	contentsSizeChanged ()

QColor	fillColor () const const

void	fillColorChanged ()

virtual bool	isTextureProvider () const const override

bool	mipmap () const const

bool	opaquePainting () const const

PerformanceHints	performanceHints () const const

RenderTarget	renderTarget () const const

void	renderTargetChanged ()

void	resetContentsSize ()

void	setAntialiasing (bool enable)

void	setContentsScale (qreal)

void	setContentsSize (const QSize &)

void	setFillColor (const QColor &)

void	setMipmap (bool enable)

void	setOpaquePainting (bool opaque)

void	setPerformanceHint (PerformanceHint hint, bool enabled)

void	setPerformanceHints (PerformanceHints hints)

void	setRenderTarget (RenderTarget target)

void	setTextureSize (const QSize &size)

virtual QSGTextureProvider *	textureProvider () const const override

QSize	textureSize () const const

void	textureSizeChanged ()

void	update (const QRect &rect)

Public Member Functions inherited from QQuickItem
	QQuickItem (QQuickItem *parent)

Qt::MouseButtons	acceptedMouseButtons () const const

bool	acceptHoverEvents () const const

bool	acceptTouchEvents () const const

void	activeFocusChanged (bool)

bool	activeFocusOnTab () const const

void	activeFocusOnTabChanged (bool)

bool	antialiasing () const const

void	antialiasingChanged (bool)

qreal	baselineOffset () const const

void	baselineOffsetChanged (qreal)

QBindable< qreal >	bindableHeight ()

QBindable< qreal >	bindableWidth ()

QBindable< qreal >	bindableX ()

QBindable< qreal >	bindableY ()

virtual QRectF	boundingRect () const const

QQuickItem *	childAt (qreal x, qreal y) const const

QList< QQuickItem * >	childItems () const const

QRectF	childrenRect ()

void	childrenRectChanged (const QRectF &)

bool	clip () const const

void	clipChanged (bool)

virtual QRectF	clipRect () const const

QObject *	containmentMask () const const

void	containmentMaskChanged ()

virtual bool	contains (const QPointF &point) const const

QCursor	cursor () const const

void	dumpItemTree () const const

void	enabledChanged ()

void	ensurePolished ()

bool	filtersChildMouseEvents () const const

Flags	flags () const const

void	focusChanged (bool)

void	forceActiveFocus ()

void	forceActiveFocus (Qt::FocusReason reason)

void	grabMouse ()

QSharedPointer< QQuickItemGrabResult >	grabToImage (const QSize &targetSize)

void	grabTouchPoints (const QList< int > &ids)

bool	hasActiveFocus () const const

bool	hasFocus () const const

qreal	height () const const

void	heightChanged ()

qreal	implicitHeight () const const

void	implicitHeightChanged ()

qreal	implicitWidth () const const

void	implicitWidthChanged ()

bool	isAncestorOf (const QQuickItem *child) const const

bool	isEnabled () const const

bool	isFocusScope () const const

bool	isVisible () const const

bool	keepMouseGrab () const const

bool	keepTouchGrab () const const

QPointF	mapFromGlobal (const QPointF &point) const const

QPointF	mapFromItem (const QQuickItem *item, const QPointF &point) const const

QPointF	mapFromScene (const QPointF &point) const const

QRectF	mapRectFromItem (const QQuickItem *item, const QRectF &rect) const const

QRectF	mapRectFromScene (const QRectF &rect) const const

QRectF	mapRectToItem (const QQuickItem *item, const QRectF &rect) const const

QRectF	mapRectToScene (const QRectF &rect) const const

QPointF	mapToGlobal (const QPointF &point) const const

QPointF	mapToItem (const QQuickItem *item, const QPointF &point) const const

QPointF	mapToScene (const QPointF &point) const const

QQuickItem *	nextItemInFocusChain (bool forward)

qreal	opacity () const const

void	opacityChanged ()

void	parentChanged (QQuickItem *)

QQuickItem *	parentItem () const const

void	polish ()

void	resetAntialiasing ()

void	resetHeight ()

void	resetWidth ()

qreal	rotation () const const

void	rotationChanged ()

qreal	scale () const const

void	scaleChanged ()

QQuickItem *	scopedFocusItem () const const

void	setAcceptedMouseButtons (Qt::MouseButtons buttons)

void	setAcceptHoverEvents (bool enabled)

void	setAcceptTouchEvents (bool enabled)

void	setActiveFocusOnTab (bool)

void	setAntialiasing (bool)

void	setBaselineOffset (qreal)

void	setClip (bool)

void	setContainmentMask (QObject *mask)

void	setCursor (const QCursor &cursor)

void	setEnabled (bool)

void	setFiltersChildMouseEvents (bool filter)

void	setFlag (Flag flag, bool enabled)

void	setFlags (Flags flags)

void	setFocus (bool focus, Qt::FocusReason reason)

void	setFocus (bool)

void	setHeight (qreal)

void	setImplicitHeight (qreal)

void	setImplicitWidth (qreal)

void	setKeepMouseGrab (bool keep)

void	setKeepTouchGrab (bool keep)

void	setOpacity (qreal)

void	setParentItem (QQuickItem *parent)

void	setRotation (qreal)

void	setScale (qreal)

void	setSize (const QSizeF &size)

void	setSmooth (bool)

void	setState (const QString &)

void	setTransformOrigin (TransformOrigin)

void	setVisible (bool)

void	setWidth (qreal)

void	setX (qreal)

void	setY (qreal)

void	setZ (qreal)

QSizeF	size () const const

bool	smooth () const const

void	smoothChanged (bool)

void	stackAfter (const QQuickItem *sibling)

void	stackBefore (const QQuickItem *sibling)

QString	state () const const

void	stateChanged (const QString &)

TransformOrigin	transformOrigin () const const

void	transformOriginChanged (TransformOrigin)

void	ungrabMouse ()

void	ungrabTouchPoints ()

void	unsetCursor ()

void	update ()

QQuickItem *	viewportItem () const const

void	visibleChanged ()

qreal	width () const const

void	widthChanged ()

QQuickWindow *	window () const const

void	windowChanged (QQuickWindow *window)

qreal	x () const const

void	xChanged ()

qreal	y () const const

void	yChanged ()

qreal	z () const const

void	zChanged ()

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Static Public Member Functions
static bool	antialias ()

static void	setAntialias (bool antialias)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Static Public Attributes
static bool	HAVE_TRANSPARENCY

Protected Types
enum	DragState { diNone , diPending , diDragging }

Protected Slots
void	blinkCursorEvent ()

void	blinkEvent ()

void	enableBell ()

void	scrollBarPositionChanged (int value)

Protected Member Functions
QChar	charClass (QChar ch) const

void	clearImage ()

void	doDrag ()

void	dragEnterEvent (QDragEnterEvent *event) override

void	dropEvent (QDropEvent *event) override

bool	event (QEvent *) override

virtual void	extendSelection (const QPoint &pos)

void	focusInEvent (QFocusEvent *event) override

bool	focusNextPrevChild (bool next)

void	focusOutEvent (QFocusEvent *event) override

virtual void	fontChange (const QFont &font)

void	geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override

void	hideEvent (QHideEvent *)

void	inputMethodEvent (QInputMethodEvent *event) override

void	inputMethodQuery (QInputMethodQueryEvent *event)

QVariant	inputMethodQuery (Qt::InputMethodQuery query) const override

void	itemChange (ItemChange change, const ItemChangeData &value) override

void	keyPressEvent (QKeyEvent *event) override

constexpr int	loc (int x, int y) const

void	mouseDoubleClickEvent (QMouseEvent *ev) override

void	mouseMoveEvent (QMouseEvent *) override

void	mousePressEvent (QMouseEvent *) override

void	mouseReleaseEvent (QMouseEvent *) override

void	mouseTripleClickEvent (QMouseEvent *ev)

void	paint (QPainter *painter) override

void	resizeEvent (QResizeEvent *)

void	showEvent (QShowEvent *)

void	wheelEvent (QWheelEvent *) override

Protected Member Functions inherited from QQuickPaintedItem
virtual void	releaseResources () override

virtual QSGNode *	updatePaintNode (QSGNode oldNode, UpdatePaintNodeData data) override

Protected Member Functions inherited from QQuickItem
virtual bool	childMouseEventFilter (QQuickItem item, QEvent event)

virtual void	classBegin () override

virtual void	componentComplete () override

virtual void	dragLeaveEvent (QDragLeaveEvent *event)

virtual void	dragMoveEvent (QDragMoveEvent *event)

bool	heightValid () const const

virtual void	hoverEnterEvent (QHoverEvent *event)

virtual void	hoverLeaveEvent (QHoverEvent *event)

virtual void	hoverMoveEvent (QHoverEvent *event)

bool	isComponentComplete () const const

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	mouseUngrabEvent ()

virtual void	touchEvent (QTouchEvent *event)

virtual void	touchUngrabEvent ()

void	updateInputMethod (Qt::InputMethodQueries queries)

virtual void	updatePolish ()

bool	widthValid () const const

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
struct Konsole::TerminalDisplay::_dragInfo	dragInfo

Additional Inherited Members
Public Attributes inherited from QQuickPaintedItem
	FastFBOResizing

	FramebufferObject

	Image

	InvertedYFramebufferObject

typedef	PerformanceHints

Public Attributes inherited from QQuickItem
	Bottom

	BottomLeft

	BottomRight

	Center

typedef	Flags

	ItemAcceptsDrops

	ItemAcceptsInputMethod

	ItemActiveFocusHasChanged

	ItemAntialiasingHasChanged

	ItemChildAddedChange

	ItemChildRemovedChange

	ItemClipsChildrenToShape

	ItemDevicePixelRatioHasChanged

	ItemEnabledHasChanged

	ItemHasContents

	ItemIsFocusScope

	ItemIsViewport

	ItemObservesViewport

	ItemOpacityHasChanged

	ItemParentHasChanged

	ItemRotationHasChanged

	ItemSceneChange

	ItemVisibleHasChanged

	Left

	Right

	Top

	TopLeft

	TopRight

Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

A widget which displays output from a terminal emulation and sends input keypresses and mouse activity to the terminal.

When the terminal emulation receives new output from the program running in the terminal, it will update the display by calling updateImage().

This class is exposed to the QML engine as QMLTermWidget and forms part of the Terminal control implementation.

Note: This class is not part of any public API, and its usage is restricted via the QML exposed type QMLTermWidget

Definition at line 88 of file TerminalDisplay.h.

Member Enumeration Documentation

◆ BellMode

enum Konsole::TerminalDisplay::BellMode

This enum describes the different types of sounds and visual effects which can be used to alert the user when a 'bell' occurs in the terminal session.

Enumerator
SystemBeepBell	A system beep.
NotifyBell	KDE notification. This may play a sound, show a passive popup or perform some other action depending on the user's settings.
VisualBell	A silent, visual bell (eg. inverting the display's colors briefly)
NoBell	No bell effects.

Definition at line 470 of file TerminalDisplay.h.

◆ DragState

enum Konsole::TerminalDisplay::DragState

protected

Definition at line 828 of file TerminalDisplay.h.

◆ ScrollBarPosition

enum Konsole::TerminalDisplay::ScrollBarPosition

This enum describes the location where the scroll bar is positioned in the display widget.

Enumerator
NoScrollBar	Do not show the scroll bar.
ScrollBarLeft	Show the scroll bar on the left side of the display.
ScrollBarRight	Show the scroll bar on the right side of the display.

Definition at line 226 of file TerminalDisplay.h.

◆ TripleClickMode

enum Konsole::TerminalDisplay::TripleClickMode

This enum describes the methods for selecting text when the user triple-clicks within the display.

Enumerator
SelectWholeLine	Select the whole line underneath the cursor.
SelectForwardsFromCursor	Select from the current cursor position to the end of the line.

Definition at line 313 of file TerminalDisplay.h.

Property Documentation

◆ antialiasText

bool Konsole::TerminalDisplay::antialiasText

readwrite

Definition at line 170 of file TerminalDisplay.h.

◆ availableColorSchemes

QStringList TerminalDisplay::availableColorSchemes

read

Definition at line 175 of file TerminalDisplay.h.

◆ backgroundColor

QColor Konsole::TerminalDisplay::backgroundColor

read

Definition at line 198 of file TerminalDisplay.h.

◆ backgroundOpacity

qreal Konsole::TerminalDisplay::backgroundOpacity

readwrite

Definition at line 185 of file TerminalDisplay.h.

◆ blinkingCursor

bool Konsole::TerminalDisplay::blinkingCursor

readwrite

Definition at line 165 of file TerminalDisplay.h.

◆ colorScheme

QString Konsole::TerminalDisplay::colorScheme

readwrite

Definition at line 105 of file TerminalDisplay.h.

◆ columns

int Konsole::TerminalDisplay::columns

read

Definition at line 130 of file TerminalDisplay.h.

◆ customColorScheme

CustomColorScheme* Konsole::TerminalDisplay::customColorScheme

read

Access to the CustomColorScheme object, which allows to modify manually the colors.

Definition at line 190 of file TerminalDisplay.h.

◆ enableBold

bool Konsole::TerminalDisplay::enableBold

readwrite

Definition at line 155 of file TerminalDisplay.h.

◆ font

QFont Konsole::TerminalDisplay::font

readwrite

Definition at line 100 of file TerminalDisplay.h.

◆ fontMetrics

QSize Konsole::TerminalDisplay::fontMetrics

read

Size of the current font being used.

Definition at line 150 of file TerminalDisplay.h.

◆ foregroundColor

QColor Konsole::TerminalDisplay::foregroundColor

read

Definition at line 197 of file TerminalDisplay.h.

◆ fullCursorHeight

bool Konsole::TerminalDisplay::fullCursorHeight

readwrite

Definition at line 160 of file TerminalDisplay.h.

◆ isTextSelected

bool Konsole::TerminalDisplay::isTextSelected

read

Definition at line 180 of file TerminalDisplay.h.

◆ lines

int Konsole::TerminalDisplay::lines

read

Definition at line 125 of file TerminalDisplay.h.

◆ lineSpacing

int Konsole::TerminalDisplay::lineSpacing

readwrite

Definition at line 115 of file TerminalDisplay.h.

◆ readOnly

bool Konsole::TerminalDisplay::readOnly

readwrite

A read only mode prevents the user from sending keyevents.

Definition at line 195 of file TerminalDisplay.h.

◆ scrollbarCurrentValue

int Konsole::TerminalDisplay::scrollbarCurrentValue

readwrite

Definition at line 135 of file TerminalDisplay.h.

◆ scrollbarMaximum

int Konsole::TerminalDisplay::scrollbarMaximum

read

Definition at line 140 of file TerminalDisplay.h.

◆ scrollbarMinimum

int Konsole::TerminalDisplay::scrollbarMinimum

read

Definition at line 145 of file TerminalDisplay.h.

◆ session

KSession * Konsole::TerminalDisplay::session

readwrite

Register the session to handle.

Definition at line 95 of file TerminalDisplay.h.

◆ terminalSize

QSize Konsole::TerminalDisplay::terminalSize

read

Definition at line 110 of file TerminalDisplay.h.

◆ terminalUsesMouse

bool Konsole::TerminalDisplay::terminalUsesMouse

read

Definition at line 120 of file TerminalDisplay.h.

Constructor & Destructor Documentation

◆ TerminalDisplay()

TerminalDisplay::TerminalDisplay ( QQuickItem * parent = nullptr )

Constructs a new terminal display widget with the specified parent.

Definition at line 276 of file TerminalDisplay.cpp.

◆ ~TerminalDisplay()

TerminalDisplay::~TerminalDisplay ( )

override

Definition at line 403 of file TerminalDisplay.cpp.

Member Function Documentation

◆ antialias()

static bool Konsole::TerminalDisplay::antialias ( )

inlinestatic

Returns true if anti-aliasing of text in the terminal is enabled.

Definition at line 509 of file TerminalDisplay.h.

◆ backgroundColor

QColor TerminalDisplay::backgroundColor ( ) const

slot

Definition at line 140 of file TerminalDisplay.cpp.

◆ backgroundOpacity

qreal TerminalDisplay::backgroundOpacity ( ) const

slot

Definition at line 3274 of file TerminalDisplay.cpp.

◆ bell

void TerminalDisplay::bell ( const QString & message )

slot

Shows a notification that a bell event has occurred in the terminal.

TODO: More documentation here

Definition at line 2760 of file TerminalDisplay.cpp.

◆ bellMode()

int Konsole::TerminalDisplay::bellMode ( )

inline

Returns the type of effect used to alert the user when a 'bell' occurs in the terminal session.

See setBellMode()

Definition at line 460 of file TerminalDisplay.h.

◆ blinkCursorEvent

void TerminalDisplay::blinkCursorEvent ( )

protectedslot

Definition at line 1554 of file TerminalDisplay.cpp.

◆ blinkEvent

void TerminalDisplay::blinkEvent ( )

protectedslot

Definition at line 1524 of file TerminalDisplay.cpp.

◆ blinkingCursor()

bool Konsole::TerminalDisplay::blinkingCursor ( )

inline

Returns true if the cursor is set to blink or false otherwise.

Definition at line 290 of file TerminalDisplay.h.

◆ bracketedPasteMode

bool TerminalDisplay::bracketedPasteMode ( ) const

slot

Definition at line 2382 of file TerminalDisplay.cpp.

◆ bracketedPasteModeIsDisabled()

bool Konsole::TerminalDisplay::bracketedPasteModeIsDisabled ( ) const

inline

Definition at line 609 of file TerminalDisplay.h.

◆ bracketText()

void TerminalDisplay::bracketText ( QString & text ) const

change and wrap text corresponding to paste mode

Definition at line 2468 of file TerminalDisplay.cpp.

◆ charClass()

QChar TerminalDisplay::charClass ( QChar ch ) const

protected

Definition at line 2349 of file TerminalDisplay.cpp.

◆ clearImage()

void TerminalDisplay::clearImage ( )

protected

Definition at line 2797 of file TerminalDisplay.cpp.

◆ colorScheme

QString TerminalDisplay::colorScheme ( ) const

slot

Definition at line 3140 of file TerminalDisplay.cpp.

◆ colorTable()

std::span< const ColorEntry > TerminalDisplay::colorTable ( ) const

Returns the terminal color palette used by the display.

Definition at line 113 of file TerminalDisplay.cpp.

◆ columns()

int Konsole::TerminalDisplay::columns ( )

inline

Returns the number of characters of text which can be displayed on each line in the widget.

This will depend upon the width of the widget and the current font. See fontWidth()

Definition at line 396 of file TerminalDisplay.h.

◆ configureRequest

void Konsole::TerminalDisplay::configureRequest ( const QPoint & position )

signal

Emitted when the user right clicks on the display, or right-clicks with the Shift key held down if usesMouse() is true.

This can be used to display a context menu.

◆ copyClipboard

void TerminalDisplay::copyClipboard ( )

slot

Copies the selected text to the clipboard.

Definition at line 2485 of file TerminalDisplay.cpp.

◆ ctrlDrag()

bool Konsole::TerminalDisplay::ctrlDrag ( )

inline

Definition at line 304 of file TerminalDisplay.h.

◆ customColorScheme()

CustomColorScheme * TerminalDisplay::customColorScheme ( ) const

Definition at line 3279 of file TerminalDisplay.cpp.

◆ disableBracketedPasteMode()

void Konsole::TerminalDisplay::disableBracketedPasteMode ( bool disable )

inline

Definition at line 605 of file TerminalDisplay.h.

◆ doDrag()

void TerminalDisplay::doDrag ( )

protected

Definition at line 2951 of file TerminalDisplay.cpp.

◆ dragEnterEvent()

void TerminalDisplay::dragEnterEvent ( QDragEnterEvent * event )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 2907 of file TerminalDisplay.cpp.

◆ dropEvent()

void TerminalDisplay::dropEvent ( QDropEvent * event )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 2915 of file TerminalDisplay.cpp.

◆ emitSelection()

void TerminalDisplay::emitSelection	(	bool	useXselection,
		bool	appendReturn )

Definition at line 2395 of file TerminalDisplay.cpp.

◆ enableBell

void TerminalDisplay::enableBell ( )

protectedslot

Definition at line 2755 of file TerminalDisplay.cpp.

◆ event()

bool TerminalDisplay::event ( QEvent * event )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 2729 of file TerminalDisplay.cpp.

◆ extendSelection()

void TerminalDisplay::extendSelection ( const QPoint & pos )

protectedvirtual

Definition at line 1887 of file TerminalDisplay.cpp.

◆ filterActions()

QList< QAction * > TerminalDisplay::filterActions ( const QPoint & position )

Returns a list of menu actions created by the filters for the content at the given position.

Definition at line 1771 of file TerminalDisplay.cpp.

◆ filterChain()

FilterChain * TerminalDisplay::filterChain ( ) const

Returns the display's filter chain.

When the image for the display is updated, the text is passed through each filter in the chain. Each filter can define hotspots which correspond to certain strings (such as URLs or particular words). Depending on the type of the hotspots created by the filter ( returned by Filter::Hotspot::type() ) the view will draw visual cues such as underlines on mouse-over for links or translucent rectangles for markers.

To add a new filter to the view, call: viewWidget->filterChain()->addFilter( filterObject );

Definition at line 1268 of file TerminalDisplay.cpp.

◆ findNext

void TerminalDisplay::findNext ( const QString & regexp )

slot

Definition at line 3313 of file TerminalDisplay.cpp.

◆ findPrevious

void TerminalDisplay::findPrevious ( const QString & regexp )

slot

Definition at line 3326 of file TerminalDisplay.cpp.

◆ flowControlWarningEnabled

bool Konsole::TerminalDisplay::flowControlWarningEnabled ( ) const

inlineslot

Returns true if the flow control warning box is enabled.

See outputSuspended() and setFlowControlWarningEnabled()

Definition at line 654 of file TerminalDisplay.h.

◆ focusInEvent()

void TerminalDisplay::focusInEvent ( QFocusEvent * event )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 1208 of file TerminalDisplay.cpp.

◆ focusNextPrevChild()

bool TerminalDisplay::focusNextPrevChild ( bool next )

protected

Definition at line 2340 of file TerminalDisplay.cpp.

◆ focusOutEvent()

void TerminalDisplay::focusOutEvent ( QFocusEvent * event )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 1193 of file TerminalDisplay.cpp.

◆ fontChange()

void TerminalDisplay::fontChange ( const QFont & font )

protectedvirtual

Definition at line 191 of file TerminalDisplay.cpp.

◆ fontHeight()

Q_INVOKABLE int Konsole::TerminalDisplay::fontHeight ( )

inline

Returns the height of the characters in the font used to draw the text in the display.

Definition at line 404 of file TerminalDisplay.h.

◆ fontWidth()

int Konsole::TerminalDisplay::fontWidth ( )

inline

Returns the width of the characters in the display.

This assumes the use of a fixed-width font.

Definition at line 412 of file TerminalDisplay.h.

◆ foregroundColor

QColor TerminalDisplay::foregroundColor ( ) const

slot

Definition at line 152 of file TerminalDisplay.cpp.

◆ fullCursorHeight()

bool TerminalDisplay::fullCursorHeight ( ) const

Definition at line 3252 of file TerminalDisplay.cpp.

◆ geometryChange()

void TerminalDisplay::geometryChange	(	const QRectF &	newGeometry,
		const QRectF &	oldGeometry )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 2997 of file TerminalDisplay.cpp.

◆ getBoldIntense()

bool Konsole::TerminalDisplay::getBoldIntense ( )

inline

Returns true if characters with intense colors are rendered in bold.

Definition at line 531 of file TerminalDisplay.h.

◆ getCharacterPosition()

CharPos TerminalDisplay::getCharacterPosition ( const QPointF & widgetPoint ) const

Definition at line 2119 of file TerminalDisplay.cpp.

◆ getVTFont()

QFont Konsole::TerminalDisplay::getVTFont ( )

inline

Returns the font used to draw characters in the display.

Definition at line 487 of file TerminalDisplay.h.

◆ hideEvent()

void TerminalDisplay::hideEvent ( QHideEvent * )

protected

Definition at line 1623 of file TerminalDisplay.cpp.

◆ inputMethodEvent()

void TerminalDisplay::inputMethodEvent ( QInputMethodEvent * event )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 2632 of file TerminalDisplay.cpp.

◆ inputMethodQuery() [1/2]

void TerminalDisplay::inputMethodQuery ( QInputMethodQueryEvent * event )

protected

Definition at line 2643 of file TerminalDisplay.cpp.

◆ inputMethodQuery() [2/2]

QVariant TerminalDisplay::inputMethodQuery ( Qt::InputMethodQuery query ) const

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 2650 of file TerminalDisplay.cpp.

◆ isBidiEnabled()

bool Konsole::TerminalDisplay::isBidiEnabled ( )

inline

Returns the status of the BiDi rendering in this widget.

Definition at line 576 of file TerminalDisplay.h.

◆ isTextSelected()

bool TerminalDisplay::isTextSelected ( ) const

Definition at line 3297 of file TerminalDisplay.cpp.

◆ itemChange()

void TerminalDisplay::itemChange	(	ItemChange	change,
		const ItemChangeData &	value )

overrideprotectedvirtual

Reimplemented from QQuickPaintedItem.

Definition at line 3257 of file TerminalDisplay.cpp.

◆ keyboardCursorColor()

QColor TerminalDisplay::keyboardCursorColor ( ) const

Returns the color of the keyboard cursor, or an invalid color if the keyboard cursor color is set to change according to the foreground color of the character underneath it.

Definition at line 661 of file TerminalDisplay.cpp.

◆ keyboardCursorShape()

Emulation::KeyboardCursorShape TerminalDisplay::keyboardCursorShape ( ) const

Returns the shape of the keyboard cursor.

See setKeyboardCursorShape()

Definition at line 645 of file TerminalDisplay.cpp.

◆ keyPressedSignal

void Konsole::TerminalDisplay::keyPressedSignal	(	QKeyEvent *	e,
		bool	fromPaste )

signal

Emitted when the user presses a key whilst the terminal widget has focus.

◆ keyPressEvent()

void TerminalDisplay::keyPressEvent ( QKeyEvent * event )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 2541 of file TerminalDisplay.cpp.

◆ lines()

int Konsole::TerminalDisplay::lines ( )

inline

Returns the number of lines of text which can be displayed in the widget.

This will depend upon the height of the widget and the current font. See fontHeight()

Definition at line 385 of file TerminalDisplay.h.

◆ lineSpacing()

uint TerminalDisplay::lineSpacing ( ) const

Definition at line 2967 of file TerminalDisplay.cpp.

◆ loc()

int Konsole::TerminalDisplay::loc	(	int	x,
		int	y ) const

inlineconstexprprotected

Definition at line 862 of file TerminalDisplay.h.

◆ margin()

int TerminalDisplay::margin ( ) const

Definition at line 2981 of file TerminalDisplay.cpp.

◆ matchFound

void TerminalDisplay::matchFound	(	int	startColumn,
		int	startLine,
		int	endColumn,
		int	endLine )

slot

Definition at line 3330 of file TerminalDisplay.cpp.

◆ motionAfterPasting()

int TerminalDisplay::motionAfterPasting ( )

Definition at line 2536 of file TerminalDisplay.cpp.

◆ mouseDoubleClickEvent()

void TerminalDisplay::mouseDoubleClickEvent ( QMouseEvent * ev )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 2168 of file TerminalDisplay.cpp.

◆ mouseMoveEvent()

void TerminalDisplay::mouseMoveEvent ( QMouseEvent * ev )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 1780 of file TerminalDisplay.cpp.

◆ mousePressEvent()

void TerminalDisplay::mousePressEvent ( QMouseEvent * ev )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 1700 of file TerminalDisplay.cpp.

◆ mouseReleaseEvent()

void TerminalDisplay::mouseReleaseEvent ( QMouseEvent * ev )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 2084 of file TerminalDisplay.cpp.

◆ mouseSignal

void Konsole::TerminalDisplay::mouseSignal	(	int	button,
		int	column,
		int	line,
		int	eventType )

signal

A mouse event occurred.

Parameters

button	The mouse button (0 for left button, 1 for middle button, 2 for right button, 3 for release)
column	The character column where the event occurred
line	The character row where the event occurred
eventType	The type of event. 0 for a mouse press / release or 1 for mouse motion

◆ mouseTripleClickEvent()

void TerminalDisplay::mouseTripleClickEvent ( QMouseEvent * ev )

protected

Definition at line 2289 of file TerminalDisplay.cpp.

◆ noMatchFound

void TerminalDisplay::noMatchFound ( )

slot

Definition at line 3341 of file TerminalDisplay.cpp.

◆ outputSuspended

void TerminalDisplay::outputSuspended ( bool suspended )

slot

Causes the widget to display or hide a message informing the user that terminal output has been suspended (by using the flow control key combination Ctrl+S)

Parameters

suspended True if terminal output has been suspended and the warning message should be shown or false to indicate that terminal output has been resumed and that the warning message should disappear.

Definition at line 2962 of file TerminalDisplay.cpp.

◆ overrideShortcutCheck

void Konsole::TerminalDisplay::overrideShortcutCheck	(	QKeyEvent *	keyEvent,
		bool &	override )

signal

When a shortcut which is also a valid terminal key sequence is pressed while the terminal widget has focus, this signal is emitted to allow the host to decide whether the shortcut should be overridden.

When the shortcut is overridden, the key sequence will be sent to the terminal emulation instead and the action associated with the shortcut will not be triggered.

override is set to false by default and the shortcut will be triggered as normal.

◆ paint()

void TerminalDisplay::paint ( QPainter * painter )

overrideprotectedvirtual

Implements QQuickPaintedItem.

Definition at line 1221 of file TerminalDisplay.cpp.

◆ pasteClipboard

void TerminalDisplay::pasteClipboard ( )

slot

Pastes the content of the clipboard into the display.

Definition at line 2495 of file TerminalDisplay.cpp.

◆ pasteSelection

void TerminalDisplay::pasteSelection ( )

slot

Pastes the content of the selection into the display.

Definition at line 2500 of file TerminalDisplay.cpp.

◆ processFilters()

void TerminalDisplay::processFilters ( )

Updates the filters in the display's filter chain.

This will cause the hotspots to be updated to match the current image.

WARNING: This function can be expensive depending on the image size and number of filters in the filterChain()

TODO - This API does not really allow efficient usage. Revise it so that the processing can be done in a better way.

eg:

Area of interest may be known ( eg. mouse cursor hovering over an area )

Definition at line 963 of file TerminalDisplay.cpp.

◆ randomSeed()

uint TerminalDisplay::randomSeed ( ) const

Returns the seed used to generate random colors for the display (in color schemes that support them).

Definition at line 826 of file TerminalDisplay.cpp.

◆ readOnly()

bool TerminalDisplay::readOnly ( ) const

Definition at line 3284 of file TerminalDisplay.cpp.

◆ resizeEvent()

void TerminalDisplay::resizeEvent ( QResizeEvent * )

protected

Definition at line 1566 of file TerminalDisplay.cpp.

◆ screenWindow()

ScreenWindow * TerminalDisplay::screenWindow ( ) const

Returns the terminal screen section which is displayed in this widget.

See setScreenWindow()

Definition at line 91 of file TerminalDisplay.cpp.

◆ scrollBarPositionChanged

void TerminalDisplay::scrollBarPositionChanged ( int value )

protectedslot

Definition at line 1634 of file TerminalDisplay.cpp.

◆ scrollToEnd()

void TerminalDisplay::scrollToEnd ( )

Scroll to the bottom of the terminal (reset scrolling).

Definition at line 1673 of file TerminalDisplay.cpp.

◆ selectedText

QString TerminalDisplay::selectedText ( ) const

slot

Definition at line 3305 of file TerminalDisplay.cpp.

◆ selectionChanged

void TerminalDisplay::selectionChanged ( )

slot

Definition at line 2783 of file TerminalDisplay.cpp.

◆ setAntialias()

static void Konsole::TerminalDisplay::setAntialias ( bool antialias )

inlinestatic

Specified whether anti-aliasing of text in the terminal display is enabled or not.

Defaults to enabled.

Definition at line 502 of file TerminalDisplay.h.

◆ setBackgroundColor

void TerminalDisplay::setBackgroundColor ( const QColor & color )

slot

Sets the background of the display to the specified color.

See also: setColorTable(), setForegroundColor()

Definition at line 118 of file TerminalDisplay.cpp.

◆ setBackgroundOpacity

void TerminalDisplay::setBackgroundOpacity ( qreal backgroundOpacity )

slot

Sets the backgroundOpacity of the terminal display.

Definition at line 666 of file TerminalDisplay.cpp.

◆ setBellMode()

void TerminalDisplay::setBellMode ( int mode )

Sets the type of effect used to alert the user when a 'bell' occurs in the terminal session.

The terminal session can trigger the bell effect by calling bell() with the alert message.

Definition at line 2750 of file TerminalDisplay.cpp.

◆ setBidiEnabled()

void Konsole::TerminalDisplay::setBidiEnabled ( bool set )

inline

Sets the status of the BiDi rendering inside the terminal display.

Defaults to disabled.

Definition at line 569 of file TerminalDisplay.h.

◆ setBlinkingCursor()

void TerminalDisplay::setBlinkingCursor ( bool blink )

Specifies whether or not the cursor blinks.

Definition at line 1161 of file TerminalDisplay.cpp.

◆ setBlinkingTextEnabled()

void TerminalDisplay::setBlinkingTextEnabled ( bool blink )

Specifies whether or not text can blink.

Definition at line 1180 of file TerminalDisplay.cpp.

◆ setBoldIntense()

void TerminalDisplay::setBoldIntense ( bool value )

Specifies whether characters with intense colors should be rendered as bold.

Defaults to true.

Definition at line 261 of file TerminalDisplay.cpp.

◆ setBracketedPasteMode

void TerminalDisplay::setBracketedPasteMode ( bool bracketedPasteMode )

slot

Definition at line 2378 of file TerminalDisplay.cpp.

◆ setColorScheme

void TerminalDisplay::setColorScheme ( const QString & name )

slot

Definition at line 3077 of file TerminalDisplay.cpp.

◆ setColorTable()

void TerminalDisplay::setColorTable ( std::array< ColorEntry, TABLE_COLORS > && table )

Sets the terminal color palette used by the display.

Definition at line 157 of file TerminalDisplay.cpp.

◆ setConfirmMultilinePaste()

void TerminalDisplay::setConfirmMultilinePaste ( bool confirmMultilinePaste )

Definition at line 2505 of file TerminalDisplay.cpp.

◆ setCtrlDrag()

void Konsole::TerminalDisplay::setCtrlDrag ( bool enable )

inline

Definition at line 300 of file TerminalDisplay.h.

◆ setDrawLineChars()

void Konsole::TerminalDisplay::setDrawLineChars ( bool drawLineChars )

inline

Specify whether line chars should be drawn by ourselves or left to underlying font rendering libraries.

Definition at line 518 of file TerminalDisplay.h.

◆ setFixedSize()

void TerminalDisplay::setFixedSize	(	int	cols,
		int	lins )

Definition at line 2878 of file TerminalDisplay.cpp.

◆ setFlowControlWarningEnabled

void TerminalDisplay::setFlowControlWarningEnabled ( bool enabled )

slot

Changes whether the flow control warning box should be shown when the flow control stop key (Ctrl+S) are pressed.

Definition at line 2521 of file TerminalDisplay.cpp.

◆ setForegroundColor

void TerminalDisplay::setForegroundColor ( const QColor & color )

slot

Sets the text of the display to the specified color.

See also: setColorTable(), setBackgroundColor()

Definition at line 145 of file TerminalDisplay.cpp.

◆ setKeyboardCursorColor()

void TerminalDisplay::setKeyboardCursorColor	(	bool	useForegroundColor,
		const QColor &	color )

Sets the color used to draw the keyboard cursor.

The keyboard cursor defaults to using the foreground color of the character underneath it.

Parameters

useForegroundColor	If true, the cursor color will change to match the foreground color of the character underneath it as it is moved, in this case, the `color` parameter is ignored and the color of the character under the cursor is inverted to ensure that it is still readable.
color	The color to use to draw the cursor. This is only taken into account if `useForegroundColor` is false.

Definition at line 650 of file TerminalDisplay.cpp.

◆ setKeyboardCursorShape()

void TerminalDisplay::setKeyboardCursorShape ( Emulation::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.

In addition the terminal display widget also has a cursor for the mouse pointer, which can be set using the QWidget::setCursor() method.

Defaults to BlockCursor

Definition at line 635 of file TerminalDisplay.cpp.

◆ setLineSpacing()

void TerminalDisplay::setLineSpacing ( uint i )

Definition at line 2972 of file TerminalDisplay.cpp.

◆ setMargin()

void TerminalDisplay::setMargin ( int i )

Definition at line 2986 of file TerminalDisplay.cpp.

◆ setMotionAfterPasting()

void TerminalDisplay::setMotionAfterPasting ( MotionAfterPasting action )

Definition at line 2531 of file TerminalDisplay.cpp.

◆ setRandomSeed()

void TerminalDisplay::setRandomSeed ( uint seed )

Sets the seed used to generate random colors for the display (in color schemes that support them).

Definition at line 822 of file TerminalDisplay.cpp.

◆ setReadOnly()

void TerminalDisplay::setReadOnly ( bool newReadOnly )

Definition at line 3289 of file TerminalDisplay.cpp.

◆ setScreenWindow()

void TerminalDisplay::setScreenWindow ( ScreenWindow * window )

Sets the terminal screen section which is displayed in this widget.

When updateImage() is called, the display fetches the latest character image from the the associated terminal screen window.

In terms of the model-view paradigm, the ScreenWindow is the model which is rendered by the TerminalDisplay.

Definition at line 95 of file TerminalDisplay.cpp.

◆ setScroll()

void TerminalDisplay::setScroll	(	int	cursor,
		int	lines )

Sets the current position and range of the display's scroll bar.

Parameters

cursor	The position of the scroll bar's thumb.
lines	The maximum value of the scroll bar.

Definition at line 1654 of file TerminalDisplay.cpp.

◆ setScrollBarPosition()

void TerminalDisplay::setScrollBarPosition ( QTermWidget::ScrollBarPosition position )

Specifies whether the terminal display has a vertical scroll bar, and if so whether it is shown on the left or right side of the display.

Definition at line 1683 of file TerminalDisplay.cpp.

◆ setSelection()

void TerminalDisplay::setSelection ( const QString & t )

Definition at line 2476 of file TerminalDisplay.cpp.

◆ setSize()

void TerminalDisplay::setSize	(	int	cols,
		int	lins )

Definition at line 2862 of file TerminalDisplay.cpp.

◆ setTerminalSizeHint()

void Konsole::TerminalDisplay::setTerminalSizeHint ( bool on )

inline

Sets whether or not the current height and width of the terminal in lines and columns is displayed whilst the widget is being resized.

Definition at line 541 of file TerminalDisplay.h.

◆ setTerminalSizeStartup()

void Konsole::TerminalDisplay::setTerminalSizeStartup ( bool on )

inline

Sets whether the terminal size display is shown briefly after the widget is first shown.

See setTerminalSizeHint() , isTerminalSizeHint()

Definition at line 560 of file TerminalDisplay.h.

◆ setTrimPastedTrailingNewlines()

void TerminalDisplay::setTrimPastedTrailingNewlines ( bool trimPastedTrailingNewlines )

Definition at line 2510 of file TerminalDisplay.cpp.

◆ setTripleClickMode()

void Konsole::TerminalDisplay::setTripleClickMode ( TripleClickMode mode )

inline

Sets how the text is selected when the user triple clicks within the display.

Definition at line 320 of file TerminalDisplay.h.

◆ setUsesMouse

void TerminalDisplay::setUsesMouse ( bool usesMouse )

slot

Sets whether the program whoose output is being displayed in the view is interested in mouse events.

If this is set to true, mouse signals will be emitted by the view when the user clicks, drags or otherwise moves the mouse inside the view. The user interaction needed to create selections will also change, and the user will be required to hold down the shift key to create a selection or perform other mouse activities inside the view area - since the program running in the terminal is being allowed to handle normal mouse events itself.

Parameters

usesMouse Set to true if the program running in the terminal is interested in mouse events or false otherwise.

Definition at line 2365 of file TerminalDisplay.cpp.

◆ setVTFont()

void TerminalDisplay::setVTFont ( const QFont & font )

Sets the font used to draw the display.

Has no effect if font is larger than the size of the display itself.

Definition at line 238 of file TerminalDisplay.cpp.

◆ setWordCharacters()

void TerminalDisplay::setWordCharacters ( const QString & wc )

Sets which characters, in addition to letters and numbers, are regarded as being part of a word for the purposes of selecting words in the display by double clicking on them.

The word boundaries occur at the first and last characters which are either a letter, number, or a character in wc

Parameters

wc	An array of characters which are to be considered parts of a word ( in addition to letters and numbers ).

Definition at line 2360 of file TerminalDisplay.cpp.

◆ showEvent()

void TerminalDisplay::showEvent ( QShowEvent * )

protected

Definition at line 1619 of file TerminalDisplay.cpp.

◆ simulateKeyPress

void TerminalDisplay::simulateKeyPress	(	int	key,
		int	modifiers,
		bool	pressed,
		quint32	nativeScanCode,
		const QString &	text )

slot

Definition at line 3145 of file TerminalDisplay.cpp.

◆ simulateKeySequence

void TerminalDisplay::simulateKeySequence ( const QKeySequence & sequence )

slot

Definition at line 3153 of file TerminalDisplay.cpp.

◆ simulateMouseDoubleClick

void TerminalDisplay::simulateMouseDoubleClick	(	int	x,
		int	y,
		int	button,
		int	buttons,
		int	modifiers )

slot

Definition at line 3200 of file TerminalDisplay.cpp.

◆ simulateMouseMove

void TerminalDisplay::simulateMouseMove	(	int	x,
		int	y,
		int	button,
		int	buttons,
		int	modifiers )

slot

Definition at line 3182 of file TerminalDisplay.cpp.

◆ simulateMousePress

void TerminalDisplay::simulateMousePress	(	int	x,
		int	y,
		int	button,
		int	buttons,
		int	modifiers )

slot

Definition at line 3188 of file TerminalDisplay.cpp.

◆ simulateMouseRelease

void TerminalDisplay::simulateMouseRelease	(	int	x,
		int	y,
		int	button,
		int	buttons,
		int	modifiers )

slot

Definition at line 3194 of file TerminalDisplay.cpp.

◆ simulateWheel

void TerminalDisplay::simulateWheel	(	int	x,
		int	y,
		int	buttons,
		int	modifiers,
		QPoint	angleDelta )

slot

Definition at line 3168 of file TerminalDisplay.cpp.

◆ sizeHint()

QSize TerminalDisplay::sizeHint ( ) const

Definition at line 2896 of file TerminalDisplay.cpp.

◆ terminalSizeHint()

bool Konsole::TerminalDisplay::terminalSizeHint ( )

inline

Returns whether or not the current height and width of the terminal in lines and columns is displayed whilst the widget is being resized.

Definition at line 550 of file TerminalDisplay.h.

◆ tripleClickMode()

TripleClickMode Konsole::TerminalDisplay::tripleClickMode ( )

inline

See setTripleClickSelectionMode()

Definition at line 325 of file TerminalDisplay.h.

◆ updateFilters

void TerminalDisplay::updateFilters ( )

slot

Essentially calles processFilters().

Definition at line 2152 of file TerminalDisplay.cpp.

◆ updateImage

void TerminalDisplay::updateImage ( )

slot

Causes the terminal display to fetch the latest character image from the associated terminal screen ( see setScreenWindow() ) and redraw the display.

Definition at line 983 of file TerminalDisplay.cpp.

◆ updateLineProperties

void TerminalDisplay::updateLineProperties ( )

slot

Causes the terminal display to fetch the latest line status flags from the associated terminal screen ( see setScreenWindow() ).

Definition at line 2160 of file TerminalDisplay.cpp.

◆ usesMouse

bool TerminalDisplay::usesMouse ( ) const

slot

See setUsesMouse()

Definition at line 2373 of file TerminalDisplay.cpp.

◆ wheelEvent()

void TerminalDisplay::wheelEvent ( QWheelEvent * ev )

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 2245 of file TerminalDisplay.cpp.

◆ wordCharacters()

QString Konsole::TerminalDisplay::wordCharacters ( )

inline

Returns the characters which are considered part of a word for the purpose of selecting words in the display with the mouse.

See also: setWordCharacters()

Definition at line 441 of file TerminalDisplay.h.

Member Data Documentation

◆ HAVE_TRANSPARENCY

bool Konsole::TerminalDisplay::HAVE_TRANSPARENCY

static

Definition at line 593 of file TerminalDisplay.h.

The documentation for this class was generated from the following files:

Class Picker

Quick Links

About MauiKit Terminal

Konsole::TerminalDisplay

Public Types

Properties

Signals

Public Slots

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ BellMode

◆ DragState

◆ ScrollBarPosition

◆ TripleClickMode

Property Documentation

◆ antialiasText

◆ availableColorSchemes

◆ backgroundColor

◆ backgroundOpacity

◆ blinkingCursor

◆ colorScheme

◆ columns

◆ customColorScheme

◆ enableBold

◆ font

◆ fontMetrics

◆ foregroundColor

◆ fullCursorHeight

◆ isTextSelected

◆ lines

◆ lineSpacing

◆ readOnly

◆ scrollbarCurrentValue

◆ scrollbarMaximum

◆ scrollbarMinimum

◆ session

◆ terminalSize

◆ terminalUsesMouse

Constructor & Destructor Documentation

◆ TerminalDisplay()

◆ ~TerminalDisplay()

Member Function Documentation

◆ antialias()

◆ backgroundColor

◆ backgroundOpacity

◆ bell

◆ bellMode()

◆ blinkCursorEvent

◆ blinkEvent

◆ blinkingCursor()

◆ bracketedPasteMode

◆ bracketedPasteModeIsDisabled()

◆ bracketText()

◆ charClass()

◆ clearImage()

◆ colorScheme

◆ colorTable()

◆ columns()

◆ configureRequest

◆ copyClipboard

◆ ctrlDrag()

◆ customColorScheme()

◆ disableBracketedPasteMode()

◆ doDrag()

◆ dragEnterEvent()

◆ dropEvent()

◆ emitSelection()

◆ enableBell

◆ event()

◆ extendSelection()

◆ filterActions()

◆ filterChain()