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

#include "TerminalView.h"

Inheritance diagram for TerminalView:

[legend]

Collaboration diagram for TerminalView:

[legend]

Classes
struct	_dragInfo

struct	InputMethodData

Public Types
enum	BellMode { SystemBeepBell =0 , NotifyBell =1 , VisualBell =2 , NoBell =3 }
	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. More...

enum	KeyboardCursorShape { BlockCursor , UnderlineCursor , IBeamCursor }
	This enum describes the available shapes for the keyboard cursor. More...

enum	ScrollBarPosition { NoScrollBar =0 , ScrollBarLeft =1 , ScrollBarRight =2 }
	This enum describes the location where the scroll bar is positioned in the display widget. More...

enum	TripleClickMode { SelectWholeLine , SelectForwardsFromCursor }
	This enum describes the methods for selecting text when the user triple-clicks within the display. More...

Public Slots
bool	bracketedPasteMode () const

void	copyClipboard (bool extra_interrupt)
	Copies the selected text to the clipboard. More...

void	outputSuspended (bool suspended)
	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) More...

void	pasteClipboard ()
	Pastes the content of the clipboard into the display. More...

void	pasteSelection ()
	Pastes the content of the selection into the display. More...

void	processFilters ()
	Updates the filters in the display's filter chain. More...

void	selectAll ()
	selects all content More...

void	setBracketedPasteMode (bool bracketedPasteMode)

void	setUsesMouse (bool usesMouse)
	Sets whether the program whoose output is being displayed in the view is interested in mouse events. More...

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

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

bool	usesMouse () const
	See setUsesMouse() More...

Signals
void	changedContentSizeSignal (int height, int width)

void	changedFontMetricSignal (int height, int width)

void	configureRequest (TerminalView *, int state, const QPoint &position)
	Emitted when the user right clicks on the display, or right-clicks with the Shift key held down if usesMouse() is true. More...

void	interrupt_signal (void)

void	isBusySelecting (bool)

void	keyPressedSignal (QKeyEvent *e)
	Emitted when the user presses a key whilst the terminal widget has focus. More...

void	mouseSignal (int button, int column, int line, int eventType)
	A mouse event occurred. More...

void	sendStringToEmu (const char *)

void	set_global_shortcuts_signal (bool)
	Emitted when focus changes. More...

void	tripleClicked (const QString &text)

Public Member Functions
	TerminalView (QWidget *parent=nullptr)
	Constructs a new terminal display widget with the specified parent. More...

virtual	~TerminalView ()

int	bellMode ()
	Returns the type of effect used to alert the user when a 'bell' occurs in the terminal session. More...

bool	blinkingCursor ()
	Returns true if the cursor is set to blink or false otherwise. More...

bool	bracketedPasteModeIsDisabled () const

void	bracketText (QString &text)
	change and wrap text corresponding to paste mode More...

const ColorEntry *	colorTable () const
	Returns the terminal color palette used by the display. More...

int	columns ()
	Returns the number of characters of text which can be displayed on each line in the widget. More...

bool	ctrlDrag ()

void	disableBracketedPasteMode (bool disable)

void	emitSelection (bool useXselection, bool appendReturn)

QList< QAction * >	filterActions (const QPoint &position)
	Returns a list of menu actions created by the filters for the content at the given `position`. More...

FilterChain *	filterChain () const
	Returns the display's filter chain. More...

int	fontHeight ()
	Returns the height of the characters in the font used to draw the text in the display. More...

int	fontWidth ()
	Returns the width of the characters in the display. More...

QFont	getVTFont ()
	Returns the font used to draw characters in the display. More...

QColor	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. More...

KeyboardCursorShape	keyboardCursorShape () const
	Returns the shape of the keyboard cursor. More...

int	lines ()
	Returns the number of lines of text which can be displayed in the widget. More...

uint	lineSpacing () const

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

ScreenWindow *	screenWindow () const
	Returns the terminal screen section which is displayed in this widget. More...

QString	selectedText ()

void	setBellMode (int mode)
	Sets the type of effect used to alert the user when a 'bell' occurs in the terminal session. More...

void	setBlinkingCursor (bool blink)
	Specifies whether or not the cursor blinks. More...

void	setBlinkingCursorState (bool blink)

void	setColorTable (const ColorEntry table[])
	Sets the terminal color palette used by the display. More...

void	setCtrlDrag (bool enable)

void	setFixedSize (int cols, int lins)

virtual void	setFont (const QFont &)
	Reimplemented. More...

void	setKeyboardCursorColor (bool useForegroundColor, const QColor &color)
	Sets the color used to draw the keyboard cursor. More...

void	setKeyboardCursorShape (KeyboardCursorShape shape)
	Sets the shape of the keyboard cursor. More...

void	setLineSpacing (uint)

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

void	setReadOnly (bool readonly)
	Specified whether terminal widget should be at read-only mode Defaults to false. More...

void	setScreenWindow (ScreenWindow *window)
	Sets the terminal screen section which is displayed in this widget. More...

void	setScroll (int cursor, int lines)
	Sets the current position and range of the display's scroll bar. More...

void	setScrollBarPosition (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. More...

void	setSelection (const QString &t)

void	setSize (int cols, int lins)

void	setTerminalSizeHint (bool on)
	Sets whether or not the current height and width of the terminal in lines and columns is displayed whilst the widget is being resized. More...

void	setTerminalSizeStartup (bool on)
	Sets whether the terminal size display is shown briefly after the widget is first shown. More...

void	setTripleClickMode (TripleClickMode mode)
	Sets how the text is selected when the user triple clicks within the display. More...

void	setVTFont (const QFont &font)
	Sets the font used to draw the display. More...

void	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. More...

QSize	sizeHint () const

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

TripleClickMode	tripleClickMode ()
	See setTripleClickSelectionMode() More...

void	visibility_changed (bool visible)
	Is called, when the terminal's visibility has changed in order to stop orstart timers etc. More...

QString	wordCharacters ()
	Returns the characters which are considered part of a word for the purpose of selecting words in the display with the mouse. More...

Static Public Member Functions
static bool	antialias ()
	Returns true if anti-aliasing of text in the terminal is enabled. More...

static void	setAntialias (bool antialias)
	Specified whether anti-aliasing of text in the terminal display is enabled or not. More...

Protected Types
enum	DragState { diNone , diPending , diDragging }

Protected Slots
void	blinkCursorEvent ()

void	blinkEvent ()

void	enableBell ()

void	scrollBarPositionChanged (int value)

Protected Member Functions
virtual int	charClass (quint16) const

void	clearImage ()

void	doDrag ()

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual void	extendSelection (const QPoint &pos)

void	focusInEvent (QFocusEvent *focusEvent)

virtual bool	focusNextPrevChild (bool next)

void	focusOutEvent (QFocusEvent *focusEvent)

virtual void	fontChange (const QFont &font)

virtual void	hideEvent (QHideEvent *)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	mouseDoubleClickEvent (QMouseEvent *ev)

virtual void	mouseMoveEvent (QMouseEvent *)

virtual void	mousePressEvent (QMouseEvent *)

virtual void	mouseReleaseEvent (QMouseEvent *)

void	mouseTripleClickEvent (QMouseEvent *ev)

virtual void	paintEvent (QPaintEvent *)

virtual void	resizeEvent (QResizeEvent *)

virtual void	showEvent (QShowEvent *)

virtual void	wheelEvent (QWheelEvent *)

Protected Attributes
struct TerminalView::_dragInfo	dragInfo

Private Slots
void	swapColorTable ()

void	tripleClickTimeout ()

Private Member Functions
void	calcGeometry ()

QPoint	cursorPosition () const

void	drawBackground (QPainter &painter, const QRect &rect, const QColor &color)

void	drawCharacters (QPainter &painter, const QRect &rect, const QString &text, const Character *style, bool invertCharacterColor)

void	drawContents (QPainter &paint, const QRect &rect)

void	drawCursor (QPainter &painter, const QRect &rect, const QColor &foregroundColor, const QColor &backgroundColor, bool &invertColors)

void	drawInputMethodPreeditString (QPainter &painter, const QRect &rect)

void	drawTextFragment (QPainter &painter, const QRect &rect, const QString &text, const Character *style)

void	getCharacterPosition (const QPoint &widgetPoint, int &line, int &column) const

QRegion	hotSpotRegion () const

QRect	imageToWidget (const QRect &imageArea) const

void	makeImage ()

void	paintFilters (QPainter &painter)

QRect	preeditRect () const

void	propagateSize ()

void	scrollImage (int lines, const QRect &region)

void	showResizeNotification ()

void	updateImageSize ()

Private Attributes
int	_actSel

bool	_allowBell

int	_bellMode

QRgb	_blendColor

QTimer *	_blinkCursorTimer

bool	_blinking

QTimer *	_blinkTimer

bool	_bracketedPasteMode

QClipboard *	_clipboard

bool	_colorsInverted

ColorEntry	_colorTable [TABLE_COLORS]

int	_columns

bool	_columnSelectionMode

int	_contentHeight

int	_contentWidth

bool	_ctrlDrag

bool	_cursorBlinking

QColor	_cursorColor

KeyboardCursorShape	_cursorShape

bool	_disabledBracketedPasteMode

int	_dndFileCount

QString	_dropText

TerminalImageFilterChain *	_filterChain

bool	_fixedFont

bool	_flowControlWarningEnabled

int	_fontAscent

double	_fontHeight

double	_fontWidth

QGridLayout *	_gridLayout

bool	_hasBlinker

bool	_hasBlinkingCursor

Character *	_image

int	_imageSize

InputMethodData	_inputMethodData

QPoint	_iPntSel

bool	_isFixedSize

int	_leftMargin

QVector< LineProperty >	_lineProperties

int	_lines

bool	_lineSelectionMode

uint	_lineSpacing

bool	_mouseMarks

QRect	_mouseOverHotspotArea

QLabel *	_outputSuspendedLabel

QPoint	_pntSel

bool	_possibleTripleClick

bool	_preserveLineBreaks

QTimer *	_process_filter_timer

uint	_randomSeed

bool	_readonly

QTimer *	_resizeTimer

QLabel *	_resizeWidget

bool	_resizing

QPointer< ScreenWindow >	_screenWindow

QScrollBar *	_scrollBar

ScrollBarPosition	_scrollbarLocation

QSize	_size

bool	_terminalSizeHint

bool	_terminalSizeStartup

int	_topMargin

TripleClickMode	_tripleClickMode

QPoint	_tripleSelBegin

int	_usedColumns

int	_usedLines

QString	_wordCharacters

bool	_wordSelectionMode

Static Private Attributes
static bool	_antialiasText = true

static const int	BLINK_DELAY = 500

static const int	DEFAULT_LEFT_MARGIN = 2

static const int	DEFAULT_TOP_MARGIN = 2

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().

TODO More documentation

Definition at line 63 of file TerminalView.h.

Member Enumeration Documentation

◆ BellMode

enum TerminalView::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 296 of file TerminalView.h.

◆ DragState

enum TerminalView::DragState

protected

Enumerator
diNone
diPending
diDragging

Definition at line 532 of file TerminalView.h.

◆ KeyboardCursorShape

enum TerminalView::KeyboardCursorShape

This enum describes the available shapes for the keyboard cursor.

See setKeyboardCursorShape()

Enumerator
BlockCursor	A rectangular block which covers the entire area of the cursor character.
UnderlineCursor	A single flat line which occupies the space at the bottom of the cursor character's area.
IBeamCursor	An cursor shaped like the capital letter 'I', similar to the IBeam cursor used in Qt/KDE text editors.

Definition at line 170 of file TerminalView.h.

◆ ScrollBarPosition

enum TerminalView::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 91 of file TerminalView.h.

◆ TripleClickMode

enum TerminalView::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 146 of file TerminalView.h.

Constructor & Destructor Documentation

◆ TerminalView()

TerminalView::TerminalView ( QWidget * parent = nullptr )

Constructs a new terminal display widget with the specified parent.

Definition at line 238 of file TerminalView.cpp.

References _blinkCursorTimer, _blinkTimer, _gridLayout, _leftMargin, _process_filter_timer, _scrollBar, _topMargin, base_color_table, blinkCursorEvent(), blinkEvent(), DEFAULT_LEFT_MARGIN, DEFAULT_TOP_MARGIN, diNone, dragInfo, processFilters(), scrollBarPositionChanged(), set_global_shortcuts_signal(), setBracketedPasteMode(), setColorTable(), setScroll(), setUsesMouse(), and TerminalView::_dragInfo::state.

◆ ~TerminalView()

TerminalView::~TerminalView ( )

virtual

Definition at line 345 of file TerminalView.cpp.

References _filterChain, _gridLayout, _image, and _outputSuspendedLabel.

Member Function Documentation

◆ antialias()

static bool TerminalView::antialias ( )

inlinestatic

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

Definition at line 346 of file TerminalView.h.

References _antialiasText.

Referenced by setAntialias().

◆ bellMode()

int TerminalView::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 289 of file TerminalView.h.

References _bellMode.

◆ blinkCursorEvent

void TerminalView::blinkCursorEvent ( )

protectedslot

Definition at line 1298 of file TerminalView.cpp.

References _cursorBlinking, _hasBlinkingCursor, cursorPosition(), and imageToWidget().

Referenced by TerminalView(), keyPressEvent(), and setBlinkingCursorState().

◆ blinkEvent

void TerminalView::blinkEvent ( )

protectedslot

Definition at line 1276 of file TerminalView.cpp.

References _blinking.

Referenced by TerminalView().

◆ blinkingCursor()

bool TerminalView::blinkingCursor ( )

inline

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

Definition at line 134 of file TerminalView.h.

References _hasBlinkingCursor.

◆ bracketedPasteMode

bool TerminalView::bracketedPasteMode ( ) const

slot

Definition at line 2196 of file TerminalView.cpp.

References _bracketedPasteMode.

Referenced by emitSelection().

◆ bracketedPasteModeIsDisabled()

bool TerminalView::bracketedPasteModeIsDisabled ( ) const

inline

Definition at line 386 of file TerminalView.h.

References _disabledBracketedPasteMode.

◆ bracketText()

void TerminalView::bracketText ( QString & text )

change and wrap text corresponding to paste mode

Definition at line 2237 of file TerminalView.cpp.

Referenced by emitSelection().

◆ calcGeometry()

void TerminalView::calcGeometry ( )

private

Definition at line 2451 of file TerminalView.cpp.

References _columns, _contentHeight, _contentWidth, _fontHeight, _fontWidth, _isFixedSize, _leftMargin, _lines, _scrollBar, _scrollbarLocation, _topMargin, _usedColumns, _usedLines, DEFAULT_LEFT_MARGIN, DEFAULT_TOP_MARGIN, NoScrollBar, ScrollBarLeft, and ScrollBarRight.

Referenced by makeImage().

◆ changedContentSizeSignal

void TerminalView::changedContentSizeSignal	(	int	height,
		int	width
	)

signal

Referenced by hideEvent(), showEvent(), and updateImageSize().

◆ changedFontMetricSignal

void TerminalView::changedFontMetricSignal	(	int	height,
		int	width
	)

signal

Referenced by fontChange().

◆ charClass()

int TerminalView::charClass ( quint16 ch ) const

protectedvirtual

Definition at line 2165 of file TerminalView.cpp.

References _wordCharacters.

Referenced by extendSelection(), mouseDoubleClickEvent(), and mouseTripleClickEvent().

◆ clearImage()

void TerminalView::clearImage ( )

protected

Definition at line 2437 of file TerminalView.cpp.

References _image, _imageSize, Character::backgroundColor, Character::character, COLOR_SPACE_DEFAULT, DEFAULT_BACK_COLOR, DEFAULT_FORE_COLOR, DEFAULT_RENDITION, Character::foregroundColor, and Character::rendition.

Referenced by makeImage().

◆ colorTable()

const ColorEntry * TerminalView::colorTable ( ) const

Returns the terminal color palette used by the display.

Definition at line 113 of file TerminalView.cpp.

References _colorTable.

Referenced by paintFilters(), QUnixTerminalImpl::setBackgroundColor(), and QUnixTerminalImpl::setForegroundColor().

◆ columns()

int TerminalView::columns ( void )

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 237 of file TerminalView.h.

References _columns.

Referenced by setSize(), updateImage(), updateImageSize(), and TerminalModel::updateTerminalSize().

◆ configureRequest

void TerminalView::configureRequest	(	TerminalView *	,
		int	state,
		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.

Referenced by mousePressEvent().

◆ copyClipboard

void TerminalView::copyClipboard ( bool extra_interrupt )

slot

Copies the selected text to the clipboard.

Definition at line 2248 of file TerminalView.cpp.

References _preserveLineBreaks, _screenWindow, and interrupt_signal().

Referenced by QUnixTerminalImpl::copyClipboard().

◆ ctrlDrag()

bool TerminalView::ctrlDrag ( )

inline

Definition at line 140 of file TerminalView.h.

References _ctrlDrag.

◆ cursorPosition()

QPoint TerminalView::cursorPosition ( ) const

private

Definition at line 1007 of file TerminalView.cpp.

References _screenWindow.

Referenced by blinkCursorEvent(), drawInputMethodPreeditString(), and preeditRect().

◆ disableBracketedPasteMode()

void TerminalView::disableBracketedPasteMode ( bool disable )

inline

Definition at line 385 of file TerminalView.h.

References _disabledBracketedPasteMode.

◆ doDrag()

void TerminalView::doDrag ( )

protected

Definition at line 2611 of file TerminalView.cpp.

References diDragging, dragInfo, TerminalView::_dragInfo::dragObject, and TerminalView::_dragInfo::state.

Referenced by mouseMoveEvent().

◆ dragEnterEvent()

void TerminalView::dragEnterEvent ( QDragEnterEvent * event )

protectedvirtual

Definition at line 2556 of file TerminalView.cpp.

◆ drawBackground()

void TerminalView::drawBackground	(	QPainter &	painter,
		const QRect &	rect,
		const QColor &	color
	)

private

Definition at line 434 of file TerminalView.cpp.

References _scrollBar.

Referenced by drawInputMethodPreeditString(), drawTextFragment(), and paintEvent().

◆ drawCharacters()

void TerminalView::drawCharacters	(	QPainter &	painter,
		const QRect &	rect,
		const QString &	text,
		const Character *	style,
		bool	invertCharacterColor
	)

private

Definition at line 508 of file TerminalView.cpp.

References _blinking, _colorTable, Character::backgroundColor, CharacterColor::color(), Character::foregroundColor, Character::isBold(), RE_BLINK, RE_BOLD, RE_UNDERLINE, and Character::rendition.

Referenced by drawInputMethodPreeditString(), and drawTextFragment().

◆ drawContents()

void TerminalView::drawContents	(	QPainter &	paint,
		const QRect &	rect
	)

private

Definition at line 1139 of file TerminalView.cpp.

References _fixedFont, _fontHeight, _fontWidth, _image, _imageSize, _leftMargin, _lineProperties, _topMargin, _usedColumns, _usedLines, Character::backgroundColor, Character::character, drawTextFragment(), Character::foregroundColor, ExtendedCharTable::instance, len, LINE_DOUBLEHEIGHT, LINE_DOUBLEWIDTH, loc, ExtendedCharTable::lookupExtendedChar(), RE_EXTENDED_CHAR, Character::rendition, and x.

Referenced by paintEvent().

◆ drawCursor()

void TerminalView::drawCursor	(	QPainter &	painter,
		const QRect &	rect,
		const QColor &	foregroundColor,
		const QColor &	backgroundColor,
		bool &	invertColors
	)

private

Definition at line 455 of file TerminalView.cpp.

References _cursorBlinking, _cursorColor, _cursorShape, _fontHeight, _lineSpacing, BlockCursor, IBeamCursor, and UnderlineCursor.

Referenced by drawInputMethodPreeditString(), and drawTextFragment().

◆ drawInputMethodPreeditString()

void TerminalView::drawInputMethodPreeditString	(	QPainter &	painter,
		const QRect &	rect
	)

private

Definition at line 1028 of file TerminalView.cpp.

References _colorTable, _image, _inputMethodData, ColorEntry::color, cursorPosition(), DEFAULT_BACK_COLOR, DEFAULT_FORE_COLOR, drawBackground(), drawCharacters(), drawCursor(), loc, TerminalView::InputMethodData::preeditString, and TerminalView::InputMethodData::previousPreeditRect.

Referenced by paintEvent().

◆ drawTextFragment()

void TerminalView::drawTextFragment	(	QPainter &	painter,
		const QRect &	rect,
		const QString &	text,
		const Character *	style
	)

private

Definition at line 549 of file TerminalView.cpp.

References _colorTable, Character::backgroundColor, CharacterColor::color(), drawBackground(), drawCharacters(), drawCursor(), Character::foregroundColor, RE_CURSOR, and Character::rendition.

Referenced by drawContents().

◆ dropEvent()

void TerminalView::dropEvent ( QDropEvent * event )

protectedvirtual

Definition at line 2562 of file TerminalView.cpp.

References sendStringToEmu().

◆ emitSelection()

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

Definition at line 2210 of file TerminalView.cpp.

References text::text(), _disabledBracketedPasteMode, _screenWindow, bracketedPasteMode(), bracketText(), and keyPressedSignal().

Referenced by mousePressEvent(), pasteClipboard(), and pasteSelection().

◆ enableBell

void TerminalView::enableBell ( )

protectedslot

Definition at line 2423 of file TerminalView.cpp.

References _allowBell.

◆ extendSelection()

void TerminalView::extendSelection ( const QPoint & pos )

protectedvirtual

Definition at line 1667 of file TerminalView.cpp.

References _actSel, _columnSelectionMode, _fontHeight, _fontWidth, _image, _imageSize, _iPntSel, _leftMargin, _lineProperties, _lineSelectionMode, _pntSel, _screenWindow, _scrollBar, _topMargin, _tripleSelBegin, _usedColumns, _usedLines, _wordSelectionMode, charClass(), getCharacterPosition(), octave::left, LINE_WRAPPED, loc, and yMouseScroll.

Referenced by mouseMoveEvent().

◆ filterActions()

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

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

Definition at line 1552 of file TerminalView.cpp.

References _filterChain, Filter::HotSpot::actions(), getCharacterPosition(), and FilterChain::hotSpotAt().

Referenced by QUnixTerminalImpl::get_hotspot_actions().

◆ filterChain()

FilterChain * TerminalView::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 1047 of file TerminalView.cpp.

References _filterChain.

Referenced by QUnixTerminalImpl::initialize().

◆ focusInEvent()

void TerminalView::focusInEvent ( QFocusEvent * focusEvent )

protected

Definition at line 984 of file TerminalView.cpp.

References set_global_shortcuts_signal(), setBlinkingCursorState(), and updateImage().

◆ focusNextPrevChild()

bool TerminalView::focusNextPrevChild ( bool next )

protectedvirtual

Definition at line 2156 of file TerminalView.cpp.

References octave::next.

◆ focusOutEvent()

void TerminalView::focusOutEvent ( QFocusEvent * focusEvent )

protected

Definition at line 996 of file TerminalView.cpp.

References _cursorBlinking, set_global_shortcuts_signal(), and setBlinkingCursorState().

◆ fontChange()

void TerminalView::fontChange ( const QFont & font )

protectedvirtual

Definition at line 161 of file TerminalView.cpp.

References _fixedFont, _fontAscent, _fontHeight, _fontWidth, _lineSpacing, changedFontMetricSignal(), propagateSize(), octave::qt_fontmetrics_horizontal_advance(), REPCHAR, and strlen().

Referenced by setVTFont().

◆ fontHeight()

int TerminalView::fontHeight ( )

inline

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

Definition at line 242 of file TerminalView.h.

References _fontHeight.

◆ fontWidth()

int TerminalView::fontWidth ( )

inline

Returns the width of the characters in the display.

This assumes the use of a fixed-width font.

Definition at line 247 of file TerminalView.h.

References _fontWidth.

◆ getCharacterPosition()

void TerminalView::getCharacterPosition	(	const QPoint &	widgetPoint,
		int &	line,
		int &	column
	)		const

private

Definition at line 1933 of file TerminalView.cpp.

References _fontHeight, _fontWidth, _leftMargin, _topMargin, _usedColumns, and _usedLines.

Referenced by extendSelection(), filterActions(), mouseDoubleClickEvent(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), mouseTripleClickEvent(), paintFilters(), and wheelEvent().

◆ getVTFont()

QFont TerminalView::getVTFont ( )

inline

Returns the font used to draw characters in the display.

Definition at line 323 of file TerminalView.h.

◆ hideEvent()

void TerminalView::hideEvent ( QHideEvent * )

protectedvirtual

Definition at line 1390 of file TerminalView.cpp.

References _contentHeight, _contentWidth, and changedContentSizeSignal().

◆ hotSpotRegion()

QRegion TerminalView::hotSpotRegion ( ) const

private

Definition at line 689 of file TerminalView.cpp.

References _filterChain, Filter::HotSpot::endColumn(), Filter::HotSpot::endLine(), FilterChain::hotSpots(), imageToWidget(), Filter::HotSpot::startColumn(), and Filter::HotSpot::startLine().

Referenced by processFilters().

◆ imageToWidget()

QRect TerminalView::imageToWidget ( const QRect & imageArea ) const

private

Definition at line 1286 of file TerminalView.cpp.

References _fontHeight, _fontWidth, _leftMargin, and _topMargin.

Referenced by blinkCursorEvent(), hotSpotRegion(), and inputMethodQuery().

◆ inputMethodEvent()

void TerminalView::inputMethodEvent ( QInputMethodEvent * event )

protectedvirtual

Definition at line 2371 of file TerminalView.cpp.

References _inputMethodData, keyPressedSignal(), preeditRect(), TerminalView::InputMethodData::preeditString, and TerminalView::InputMethodData::previousPreeditRect.

◆ inputMethodQuery()

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

protectedvirtual

Definition at line 2381 of file TerminalView.cpp.

References _image, _lineProperties, _screenWindow, _usedColumns, PlainTextDecoder::begin(), PlainTextDecoder::decodeLine(), PlainTextDecoder::end(), imageToWidget(), and loc.

◆ interrupt_signal

void TerminalView::interrupt_signal ( void )

signal

Referenced by copyClipboard().

◆ isBusySelecting

void TerminalView::isBusySelecting ( bool )

signal

Referenced by mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), and mouseTripleClickEvent().

◆ keyboardCursorColor()

QColor TerminalView::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 429 of file TerminalView.cpp.

References _cursorColor.

◆ keyboardCursorShape()

TerminalView::KeyboardCursorShape TerminalView::keyboardCursorShape ( ) const

Returns the shape of the keyboard cursor.

See setKeyboardCursorShape()

Definition at line 414 of file TerminalView.cpp.

References _cursorShape.

◆ keyPressedSignal

void TerminalView::keyPressedSignal ( QKeyEvent * e )

signal

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

Referenced by emitSelection(), inputMethodEvent(), and keyPressEvent().

◆ keyPressEvent()

void TerminalView::keyPressEvent ( QKeyEvent * event )

protectedvirtual

Definition at line 2298 of file TerminalView.cpp.

References _actSel, _blinkCursorTimer, _cursorBlinking, _hasBlinkingCursor, _readonly, _screenWindow, BLINK_DELAY, blinkCursorEvent(), keyPressedSignal(), ScreenWindow::ScrollLines, ScreenWindow::ScrollPages, updateImage(), and updateLineProperties().

◆ lines()

int TerminalView::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 229 of file TerminalView.h.

References _lines.

Referenced by scrollImage(), setSize(), updateImage(), updateImageSize(), and TerminalModel::updateTerminalSize().

◆ lineSpacing()

uint TerminalView::lineSpacing ( ) const

Definition at line 2666 of file TerminalView.cpp.

References _lineSpacing.

◆ makeImage()

void TerminalView::makeImage ( )

private

Definition at line 2488 of file TerminalView.cpp.

References _columns, _image, _imageSize, _lines, _usedColumns, _usedLines, calcGeometry(), and clearImage().

Referenced by setFixedSize(), and updateImageSize().

◆ mouseDoubleClickEvent()

void TerminalView::mouseDoubleClickEvent ( QMouseEvent * ev )

protectedvirtual

Definition at line 1964 of file TerminalView.cpp.

References _actSel, _image, _iPntSel, _lineProperties, _mouseMarks, _possibleTripleClick, _preserveLineBreaks, _screenWindow, _scrollBar, _usedColumns, _usedLines, _wordSelectionMode, charClass(), getCharacterPosition(), LINE_WRAPPED, loc, mouseSignal(), setSelection(), tripleClickTimeout(), and x.

◆ mouseMoveEvent()

void TerminalView::mouseMoveEvent ( QMouseEvent * ev )

protectedvirtual

◆ mousePressEvent()

void TerminalView::mousePressEvent ( QMouseEvent * ev )

protectedvirtual

◆ mouseReleaseEvent()

void TerminalView::mouseReleaseEvent ( QMouseEvent * ev )

protectedvirtual

Definition at line 1880 of file TerminalView.cpp.

References _actSel, _mouseMarks, _preserveLineBreaks, _screenWindow, _scrollBar, diNone, diPending, dragInfo, getCharacterPosition(), isBusySelecting(), mouseSignal(), setSelection(), and TerminalView::_dragInfo::state.

◆ mouseSignal

void TerminalView::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

Referenced by mouseDoubleClickEvent(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), and wheelEvent().

◆ mouseTripleClickEvent()

void TerminalView::mouseTripleClickEvent ( QMouseEvent * ev )

protected

Definition at line 2094 of file TerminalView.cpp.

References _actSel, _columns, _image, _iPntSel, _lineProperties, _lines, _lineSelectionMode, _preserveLineBreaks, _screenWindow, _scrollBar, _tripleClickMode, _tripleSelBegin, _wordSelectionMode, charClass(), getCharacterPosition(), isBusySelecting(), LINE_WRAPPED, loc, SelectForwardsFromCursor, SelectWholeLine, setSelection(), tripleClicked(), and x.

Referenced by mousePressEvent().

◆ outputSuspended

void TerminalView::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 2622 of file TerminalView.cpp.

References _gridLayout, and _outputSuspendedLabel.

◆ paintEvent()

void TerminalView::paintEvent ( QPaintEvent * pe )

protectedvirtual

Definition at line 961 of file TerminalView.cpp.

References drawBackground(), drawContents(), drawInputMethodPreeditString(), paintFilters(), preeditRect(), and updateImage().

◆ paintFilters()

void TerminalView::paintFilters ( QPainter & painter )

private

Definition at line 1052 of file TerminalView.cpp.

References _columns, _filterChain, _fontHeight, _fontWidth, _image, CharacterColor::color(), colorTable(), Filter::HotSpot::endColumn(), Filter::HotSpot::endLine(), Filter::ErrorLink, Character::foregroundColor, getCharacterPosition(), FilterChain::hotSpots(), Filter::Link, loc, Filter::Marker, r, Filter::HotSpot::startColumn(), Filter::HotSpot::startLine(), and Filter::HotSpot::type().

Referenced by paintEvent().

◆ pasteClipboard

void TerminalView::pasteClipboard ( void )

slot

Pastes the content of the clipboard into the display.

Definition at line 2264 of file TerminalView.cpp.

References emitSelection().

Referenced by QUnixTerminalImpl::pasteClipboard().

◆ pasteSelection

void TerminalView::pasteSelection ( )

slot

Pastes the content of the selection into the display.

Definition at line 2286 of file TerminalView.cpp.

References emitSelection().

◆ preeditRect()

QRect TerminalView::preeditRect ( ) const

private

Definition at line 1015 of file TerminalView.cpp.

References _fontHeight, _fontWidth, _inputMethodData, _leftMargin, _topMargin, cursorPosition(), TerminalView::InputMethodData::preeditString, string_width(), and x.

Referenced by inputMethodEvent(), and paintEvent().

◆ processFilters

void TerminalView::processFilters ( )

slot

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 705 of file TerminalView.cpp.

References _filterChain, _screenWindow, hotSpotRegion(), FilterChain::process(), and TerminalImageFilterChain::setImage().

Referenced by TerminalView().

◆ propagateSize()

void TerminalView::propagateSize ( )

private

Definition at line 1321 of file TerminalView.cpp.

References _columns, _image, _isFixedSize, _lines, setSize(), sizeHint(), and updateImageSize().

Referenced by fontChange(), and setScrollBarPosition().

◆ randomSeed()

uint TerminalView::randomSeed ( ) const

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

Definition at line 577 of file TerminalView.cpp.

References _randomSeed.

Referenced by setRandomSeed().

◆ resizeEvent()

void TerminalView::resizeEvent ( QResizeEvent * )

protectedvirtual

Definition at line 1316 of file TerminalView.cpp.

References updateImageSize().

◆ screenWindow()

ScreenWindow * TerminalView::screenWindow ( ) const

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

See setScreenWindow()

Definition at line 90 of file TerminalView.cpp.

References _screenWindow.

◆ scrollBarPositionChanged

void TerminalView::scrollBarPositionChanged ( int value )

protectedslot

Definition at line 1401 of file TerminalView.cpp.

References _screenWindow, _scrollBar, and updateImage().

Referenced by TerminalView(), and setScroll().

◆ scrollImage()

void TerminalView::scrollImage	(	int	lines,
		const QRect &	region
	)

private

Definition at line 612 of file TerminalView.cpp.

References _columns, _fontHeight, _fontWidth, _image, _imageSize, _leftMargin, _lines, _outputSuspendedLabel, _topMargin, _usedColumns, abs(), and lines().

Referenced by updateImage().

◆ selectAll

void TerminalView::selectAll ( void )

slot

selects all content

Definition at line 2272 of file TerminalView.cpp.

References _screenWindow.

Referenced by QUnixTerminalImpl::selectAll().

◆ selectedText()

QString TerminalView::selectedText ( )

Definition at line 2677 of file TerminalView.cpp.

References _preserveLineBreaks, and _screenWindow.

Referenced by QUnixTerminalImpl::selectedText().

◆ sendStringToEmu

void TerminalView::sendStringToEmu ( const char * )

signal

Referenced by dropEvent().

◆ set_global_shortcuts_signal

void TerminalView::set_global_shortcuts_signal ( bool )

signal

Emitted when focus changes.

Referenced by TerminalView(), focusInEvent(), and focusOutEvent().

◆ setAntialias()

static void TerminalView::setAntialias ( bool antialias )

inlinestatic

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

Defaults to enabled.

Definition at line 342 of file TerminalView.h.

References _antialiasText, and antialias().

◆ setBellMode()

void TerminalView::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 2418 of file TerminalView.cpp.

References _bellMode.

Referenced by QUnixTerminalImpl::initialize().

◆ setBlinkingCursor()

void TerminalView::setBlinkingCursor ( bool blink )

Specifies whether or not the cursor blinks.

Definition at line 941 of file TerminalView.cpp.

References _hasBlinkingCursor, and setBlinkingCursorState().

Referenced by QUnixTerminalImpl::initialize(), and QUnixTerminalImpl::setCursorType().

◆ setBlinkingCursorState()

void TerminalView::setBlinkingCursorState ( bool blink )

Definition at line 948 of file TerminalView.cpp.

References _blinkCursorTimer, _cursorBlinking, BLINK_DELAY, and blinkCursorEvent().

Referenced by focusInEvent(), focusOutEvent(), and setBlinkingCursor().

◆ setBracketedPasteMode

void TerminalView::setBracketedPasteMode ( bool bracketedPasteMode )

slot

Definition at line 2192 of file TerminalView.cpp.

References _bracketedPasteMode.

Referenced by TerminalView(), and TerminalModel::addView().

◆ setColorTable()

void TerminalView::setColorTable ( const ColorEntry table[] )

Sets the terminal color palette used by the display.

Definition at line 118 of file TerminalView.cpp.

References _colorTable, _scrollBar, DEFAULT_BACK_COLOR, and TABLE_COLORS.

Referenced by TerminalView(), QUnixTerminalImpl::setBackgroundColor(), and QUnixTerminalImpl::setForegroundColor().

◆ setCtrlDrag()

void TerminalView::setCtrlDrag ( bool enable )

inline

Definition at line 139 of file TerminalView.h.

References _ctrlDrag.

◆ setFixedSize()

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

Definition at line 2525 of file TerminalView.cpp.

References _columns, _image, _isFixedSize, _lines, _size, _usedColumns, _usedLines, makeImage(), and setSize().

◆ setFont()

void TerminalView::setFont ( const QFont & )

virtual

Reimplemented.

Has no effect. Use setVTFont() to change the font used to draw characters in the display.

Definition at line 227 of file TerminalView.cpp.

◆ setKeyboardCursorColor()

void TerminalView::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 418 of file TerminalView.cpp.

References _cursorColor.

Referenced by QUnixTerminalImpl::setCursorColor().

◆ setKeyboardCursorShape()

void TerminalView::setKeyboardCursorShape ( 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 410 of file TerminalView.cpp.

References _cursorShape.

Referenced by QUnixTerminalImpl::initialize(), and QUnixTerminalImpl::setCursorType().

◆ setLineSpacing()

void TerminalView::setLineSpacing ( uint i )

Definition at line 2671 of file TerminalView.cpp.

References _lineSpacing, and setVTFont().

◆ setRandomSeed()

void TerminalView::setRandomSeed ( uint seed )

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

Definition at line 576 of file TerminalView.cpp.

References _randomSeed, and randomSeed().

◆ setReadOnly()

void TerminalView::setReadOnly ( bool readonly )

inline

Specified whether terminal widget should be at read-only mode Defaults to false.

Definition at line 336 of file TerminalView.h.

References _readonly.

◆ setScreenWindow()

void TerminalView::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 94 of file TerminalView.cpp.

References _lines, _screenWindow, ScreenWindow::setWindowLines(), updateImage(), and updateLineProperties().

Referenced by TerminalModel::addView().

◆ setScroll()

void TerminalView::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 1418 of file TerminalView.cpp.

References _lines, _scrollBar, and scrollBarPositionChanged().

Referenced by TerminalView(), and updateImage().

◆ setScrollBarPosition()

void TerminalView::setScrollBarPosition ( 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 1441 of file TerminalView.cpp.

References _leftMargin, _scrollBar, _scrollbarLocation, _topMargin, NoScrollBar, and propagateSize().

Referenced by QUnixTerminalImpl::initialize().

◆ setSelection()

void TerminalView::setSelection ( const QString & t )

Definition at line 2243 of file TerminalView.cpp.

Referenced by mouseDoubleClickEvent(), mouseReleaseEvent(), and mouseTripleClickEvent().

◆ setSize()

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

Definition at line 2508 of file TerminalView.cpp.

References _fontHeight, _fontWidth, _size, columns(), and lines().

Referenced by QUnixTerminalImpl::initialize(), propagateSize(), setFixedSize(), and QUnixTerminalImpl::setSize().

◆ setTerminalSizeHint()

void TerminalView::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 353 of file TerminalView.h.

References _terminalSizeHint.

Referenced by QUnixTerminalImpl::initialize().

◆ setTerminalSizeStartup()

void TerminalView::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 366 of file TerminalView.h.

References _terminalSizeStartup.

Referenced by QUnixTerminalImpl::initialize().

◆ setTripleClickMode()

void TerminalView::setTripleClickMode ( TripleClickMode mode )

inline

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

Definition at line 154 of file TerminalView.h.

References _tripleClickMode.

Referenced by QUnixTerminalImpl::initialize().

◆ setUsesMouse

void TerminalView::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 2182 of file TerminalView.cpp.

References _mouseMarks.

Referenced by TerminalView(), TerminalModel::addView(), and mouseMoveEvent().

◆ setVTFont()

void TerminalView::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 198 of file TerminalView.cpp.

References _antialiasText, f, and fontChange().

Referenced by setLineSpacing(), and QUnixTerminalImpl::setTerminalFont().

◆ setWordCharacters()

void TerminalView::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 2177 of file TerminalView.cpp.

References _wordCharacters.

◆ showEvent()

void TerminalView::showEvent ( QShowEvent * )

protectedvirtual

Definition at line 1386 of file TerminalView.cpp.

References _contentHeight, _contentWidth, and changedContentSizeSignal().

◆ showResizeNotification()

void TerminalView::showResizeNotification ( )

private

Definition at line 910 of file TerminalView.cpp.

References _columns, _lines, _resizeTimer, _resizeWidget, _terminalSizeHint, _terminalSizeStartup, and octave::qt_fontmetrics_horizontal_advance().

Referenced by updateImageSize().

◆ sizeHint()

QSize TerminalView::sizeHint ( ) const

Definition at line 2544 of file TerminalView.cpp.

References _size.

Referenced by propagateSize().

◆ swapColorTable

void TerminalView::swapColorTable ( )

privateslot

Definition at line 2428 of file TerminalView.cpp.

References _colorsInverted, and _colorTable.

◆ terminalSizeHint()

bool TerminalView::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 359 of file TerminalView.h.

References _terminalSizeHint.

◆ tripleClicked

void TerminalView::tripleClicked ( const QString & text )

signal

Referenced by mouseTripleClickEvent().

◆ tripleClickMode()

TripleClickMode TerminalView::tripleClickMode ( )

inline

See setTripleClickSelectionMode()

Definition at line 156 of file TerminalView.h.

References _tripleClickMode.

◆ tripleClickTimeout

void TerminalView::tripleClickTimeout ( )

privateslot

Definition at line 2089 of file TerminalView.cpp.

References _possibleTripleClick.

Referenced by mouseDoubleClickEvent().

◆ updateImage

void TerminalView::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 728 of file TerminalView.cpp.

References _blinking, _blinkTimer, _clipboard, _columns, _fixedFont, _fontHeight, _fontWidth, _hasBlinker, _image, _inputMethodData, _leftMargin, _lineProperties, _lines, _resizing, _screenWindow, _topMargin, _usedColumns, _usedLines, Character::backgroundColor, BLINK_DELAY, Character::character, columns(), Character::foregroundColor, len, LINE_DOUBLEHEIGHT, lines(), TerminalView::InputMethodData::previousPreeditRect, RE_BLINK, Character::rendition, scrollImage(), setScroll(), updateImageSize(), updateLineProperties(), and x.

Referenced by focusInEvent(), keyPressEvent(), paintEvent(), QUnixTerminalImpl::resizeEvent(), scrollBarPositionChanged(), setScreenWindow(), and QUnixTerminalImpl::showEvent().

◆ updateImageSize()

void TerminalView::updateImageSize ( )

private

Definition at line 1335 of file TerminalView.cpp.

References _columns, _contentHeight, _contentWidth, _image, _lines, _resizing, _screenWindow, changedContentSizeSignal(), columns(), lines(), makeImage(), and showResizeNotification().

Referenced by propagateSize(), resizeEvent(), and updateImage().

◆ updateLineProperties

void TerminalView::updateLineProperties ( )

slot

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

Definition at line 1956 of file TerminalView.cpp.

References _lineProperties, and _screenWindow.

Referenced by keyPressEvent(), setScreenWindow(), and updateImage().

◆ usesMouse

bool TerminalView::usesMouse ( ) const

slot

See setUsesMouse()

Definition at line 2187 of file TerminalView.cpp.

References _mouseMarks.

◆ visibility_changed()

void TerminalView::visibility_changed ( bool visible )

Is called, when the terminal's visibility has changed in order to stop orstart timers etc.

Definition at line 2684 of file TerminalView.cpp.

References _process_filter_timer.

Referenced by QUnixTerminalImpl::handle_visibility_changed().

◆ wheelEvent()

void TerminalView::wheelEvent ( QWheelEvent * ev )

protectedvirtual

Definition at line 2054 of file TerminalView.cpp.

References _mouseMarks, _scrollBar, getCharacterPosition(), and mouseSignal().

◆ wordCharacters()

QString TerminalView::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 273 of file TerminalView.h.

References _wordCharacters.

Member Data Documentation

◆ _actSel

int TerminalView::_actSel

private

Definition at line 681 of file TerminalView.h.

Referenced by extendSelection(), keyPressEvent(), mouseDoubleClickEvent(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), and mouseTripleClickEvent().

◆ _allowBell

bool TerminalView::_allowBell

private

Definition at line 634 of file TerminalView.h.

Referenced by enableBell().

◆ _antialiasText

bool TerminalView::_antialiasText = true

staticprivate

Definition at line 748 of file TerminalView.h.

Referenced by antialias(), setAntialias(), and setVTFont().

◆ _bellMode

int TerminalView::_bellMode

private

Definition at line 691 of file TerminalView.h.

Referenced by bellMode(), and setBellMode().

◆ _blendColor

QRgb TerminalView::_blendColor

private

Definition at line 727 of file TerminalView.h.

◆ _blinkCursorTimer

QTimer* TerminalView::_blinkCursorTimer

private

Definition at line 701 of file TerminalView.h.

Referenced by TerminalView(), keyPressEvent(), and setBlinkingCursorState().

◆ _blinking

bool TerminalView::_blinking

private

Definition at line 693 of file TerminalView.h.

Referenced by blinkEvent(), drawCharacters(), and updateImage().

◆ _blinkTimer

QTimer* TerminalView::_blinkTimer

private

Definition at line 700 of file TerminalView.h.

Referenced by TerminalView(), and updateImage().

◆ _bracketedPasteMode

bool TerminalView::_bracketedPasteMode

private

Definition at line 675 of file TerminalView.h.

Referenced by bracketedPasteMode(), and setBracketedPasteMode().

◆ _clipboard

QClipboard* TerminalView::_clipboard

private

Definition at line 687 of file TerminalView.h.

Referenced by updateImage().

◆ _colorsInverted

bool TerminalView::_colorsInverted

private

Definition at line 723 of file TerminalView.h.

Referenced by swapColorTable().

◆ _colorTable

ColorEntry TerminalView::_colorTable[TABLE_COLORS]

private

Definition at line 668 of file TerminalView.h.

Referenced by colorTable(), drawCharacters(), drawInputMethodPreeditString(), drawTextFragment(), setColorTable(), and swapColorTable().

◆ _columns

int TerminalView::_columns

private

Definition at line 650 of file TerminalView.h.

Referenced by calcGeometry(), columns(), makeImage(), mouseTripleClickEvent(), paintFilters(), propagateSize(), scrollImage(), setFixedSize(), showResizeNotification(), updateImage(), and updateImageSize().

◆ _columnSelectionMode

bool TerminalView::_columnSelectionMode

private

Definition at line 685 of file TerminalView.h.

Referenced by extendSelection(), and mousePressEvent().

◆ _contentHeight

int TerminalView::_contentHeight

private

Definition at line 660 of file TerminalView.h.

Referenced by calcGeometry(), hideEvent(), showEvent(), and updateImageSize().

◆ _contentWidth

int TerminalView::_contentWidth

private

Definition at line 661 of file TerminalView.h.

Referenced by calcGeometry(), hideEvent(), showEvent(), and updateImageSize().

◆ _ctrlDrag

bool TerminalView::_ctrlDrag

private

Definition at line 697 of file TerminalView.h.

Referenced by ctrlDrag(), mousePressEvent(), and setCtrlDrag().

◆ _cursorBlinking

bool TerminalView::_cursorBlinking

private

Definition at line 695 of file TerminalView.h.

Referenced by blinkCursorEvent(), drawCursor(), focusOutEvent(), keyPressEvent(), and setBlinkingCursorState().

◆ _cursorColor

QColor TerminalView::_cursorColor

private

Definition at line 738 of file TerminalView.h.

Referenced by drawCursor(), keyboardCursorColor(), and setKeyboardCursorColor().

◆ _cursorShape

KeyboardCursorShape TerminalView::_cursorShape

private

Definition at line 734 of file TerminalView.h.

Referenced by drawCursor(), keyboardCursorShape(), and setKeyboardCursorShape().

◆ _disabledBracketedPasteMode

bool TerminalView::_disabledBracketedPasteMode

private

Definition at line 676 of file TerminalView.h.

Referenced by bracketedPasteModeIsDisabled(), disableBracketedPasteMode(), and emitSelection().

◆ _dndFileCount

int TerminalView::_dndFileCount

private

Definition at line 706 of file TerminalView.h.

◆ _dropText

QString TerminalView::_dropText

private

Definition at line 705 of file TerminalView.h.

◆ _filterChain

TerminalImageFilterChain* TerminalView::_filterChain

private

Definition at line 731 of file TerminalView.h.

Referenced by ~TerminalView(), filterActions(), filterChain(), hotSpotRegion(), mouseMoveEvent(), mousePressEvent(), paintFilters(), and processFilters().

◆ _fixedFont

bool TerminalView::_fixedFont

private

Definition at line 638 of file TerminalView.h.

Referenced by drawContents(), fontChange(), and updateImage().

◆ _flowControlWarningEnabled

bool TerminalView::_flowControlWarningEnabled

private

Definition at line 715 of file TerminalView.h.

◆ _fontAscent

int TerminalView::_fontAscent

private

Definition at line 644 of file TerminalView.h.

Referenced by fontChange().

◆ _fontHeight

double TerminalView::_fontHeight

private

Definition at line 640 of file TerminalView.h.

Referenced by calcGeometry(), drawContents(), drawCursor(), extendSelection(), fontChange(), fontHeight(), getCharacterPosition(), imageToWidget(), mouseMoveEvent(), paintFilters(), preeditRect(), scrollImage(), setSize(), and updateImage().

◆ _fontWidth

double TerminalView::_fontWidth

private

Definition at line 641 of file TerminalView.h.

Referenced by calcGeometry(), drawContents(), extendSelection(), fontChange(), fontWidth(), getCharacterPosition(), imageToWidget(), mouseMoveEvent(), paintFilters(), preeditRect(), scrollImage(), setSize(), and updateImage().

◆ _gridLayout

QGridLayout* TerminalView::_gridLayout

private

Definition at line 636 of file TerminalView.h.

Referenced by TerminalView(), ~TerminalView(), and outputSuspended().

◆ _hasBlinker

bool TerminalView::_hasBlinker

private

Definition at line 694 of file TerminalView.h.

Referenced by updateImage().

◆ _hasBlinkingCursor

bool TerminalView::_hasBlinkingCursor

private

Definition at line 696 of file TerminalView.h.

Referenced by blinkCursorEvent(), blinkingCursor(), keyPressEvent(), and setBlinkingCursor().

◆ _image

Character* TerminalView::_image

private

Definition at line 662 of file TerminalView.h.

Referenced by ~TerminalView(), clearImage(), drawContents(), drawInputMethodPreeditString(), extendSelection(), inputMethodQuery(), makeImage(), mouseDoubleClickEvent(), mouseTripleClickEvent(), paintFilters(), propagateSize(), scrollImage(), setFixedSize(), updateImage(), and updateImageSize().

◆ _imageSize

int TerminalView::_imageSize

private

Definition at line 665 of file TerminalView.h.

Referenced by clearImage(), drawContents(), extendSelection(), makeImage(), and scrollImage().

◆ _inputMethodData

InputMethodData TerminalView::_inputMethodData

private

Definition at line 746 of file TerminalView.h.

Referenced by drawInputMethodPreeditString(), inputMethodEvent(), preeditRect(), and updateImage().

◆ _iPntSel

QPoint TerminalView::_iPntSel

private

Definition at line 678 of file TerminalView.h.

Referenced by extendSelection(), mouseDoubleClickEvent(), mousePressEvent(), and mouseTripleClickEvent().

◆ _isFixedSize

bool TerminalView::_isFixedSize

private

Definition at line 699 of file TerminalView.h.

Referenced by calcGeometry(), propagateSize(), and setFixedSize().

◆ _leftMargin

int TerminalView::_leftMargin

private

Definition at line 646 of file TerminalView.h.

Referenced by TerminalView(), calcGeometry(), drawContents(), extendSelection(), getCharacterPosition(), imageToWidget(), preeditRect(), scrollImage(), setScrollBarPosition(), and updateImage().

◆ _lineProperties

QVector<LineProperty> TerminalView::_lineProperties

private

Definition at line 666 of file TerminalView.h.

Referenced by drawContents(), extendSelection(), inputMethodQuery(), mouseDoubleClickEvent(), mouseTripleClickEvent(), updateImage(), and updateLineProperties().

◆ _lines

int TerminalView::_lines

private

Definition at line 649 of file TerminalView.h.

Referenced by calcGeometry(), lines(), makeImage(), mouseTripleClickEvent(), propagateSize(), scrollImage(), setFixedSize(), setScreenWindow(), setScroll(), showResizeNotification(), updateImage(), and updateImageSize().

◆ _lineSelectionMode

bool TerminalView::_lineSelectionMode

private

Definition at line 683 of file TerminalView.h.

Referenced by extendSelection(), mousePressEvent(), and mouseTripleClickEvent().

◆ _lineSpacing

uint TerminalView::_lineSpacing

private

Definition at line 721 of file TerminalView.h.

Referenced by drawCursor(), fontChange(), lineSpacing(), and setLineSpacing().

◆ _mouseMarks

bool TerminalView::_mouseMarks

private

Definition at line 674 of file TerminalView.h.

Referenced by mouseDoubleClickEvent(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), setUsesMouse(), usesMouse(), and wheelEvent().

◆ _mouseOverHotspotArea

QRect TerminalView::_mouseOverHotspotArea

private

Definition at line 732 of file TerminalView.h.

Referenced by mouseMoveEvent().

◆ _outputSuspendedLabel

QLabel* TerminalView::_outputSuspendedLabel

private

Definition at line 719 of file TerminalView.h.

Referenced by ~TerminalView(), outputSuspended(), and scrollImage().

◆ _pntSel

QPoint TerminalView::_pntSel

private

Definition at line 679 of file TerminalView.h.

Referenced by extendSelection(), and mousePressEvent().

◆ _possibleTripleClick

bool TerminalView::_possibleTripleClick

private

Definition at line 708 of file TerminalView.h.

Referenced by mouseDoubleClickEvent(), mousePressEvent(), and tripleClickTimeout().

◆ _preserveLineBreaks

bool TerminalView::_preserveLineBreaks

private

Definition at line 684 of file TerminalView.h.

Referenced by copyClipboard(), mouseDoubleClickEvent(), mousePressEvent(), mouseReleaseEvent(), mouseTripleClickEvent(), and selectedText().

◆ _process_filter_timer

QTimer* TerminalView::_process_filter_timer

private

Definition at line 702 of file TerminalView.h.

Referenced by TerminalView(), and visibility_changed().

◆ _randomSeed

uint TerminalView::_randomSeed

private

Definition at line 669 of file TerminalView.h.

Referenced by randomSeed(), and setRandomSeed().

◆ _readonly

bool TerminalView::_readonly

private

Definition at line 755 of file TerminalView.h.

Referenced by keyPressEvent(), and setReadOnly().

◆ _resizeTimer

QTimer* TerminalView::_resizeTimer

private

Definition at line 713 of file TerminalView.h.

Referenced by showResizeNotification().

◆ _resizeWidget

QLabel* TerminalView::_resizeWidget

private

Definition at line 712 of file TerminalView.h.

Referenced by showResizeNotification().

◆ _resizing

bool TerminalView::_resizing

private

Definition at line 671 of file TerminalView.h.

Referenced by updateImage(), and updateImageSize().

◆ _screenWindow

QPointer<ScreenWindow> TerminalView::_screenWindow

private

◆ _scrollBar

QScrollBar* TerminalView::_scrollBar

private

Definition at line 688 of file TerminalView.h.

Referenced by TerminalView(), calcGeometry(), drawBackground(), extendSelection(), mouseDoubleClickEvent(), mouseMoveEvent(), mousePressEvent(), mouseReleaseEvent(), mouseTripleClickEvent(), scrollBarPositionChanged(), setColorTable(), setScroll(), setScrollBarPosition(), and wheelEvent().

◆ _scrollbarLocation

ScrollBarPosition TerminalView::_scrollbarLocation

private

Definition at line 689 of file TerminalView.h.

Referenced by calcGeometry(), and setScrollBarPosition().

◆ _size

QSize TerminalView::_size

private

Definition at line 725 of file TerminalView.h.

Referenced by setFixedSize(), setSize(), and sizeHint().

◆ _terminalSizeHint

bool TerminalView::_terminalSizeHint

private

Definition at line 672 of file TerminalView.h.

Referenced by setTerminalSizeHint(), showResizeNotification(), and terminalSizeHint().

◆ _terminalSizeStartup

bool TerminalView::_terminalSizeStartup

private

Definition at line 673 of file TerminalView.h.

Referenced by setTerminalSizeStartup(), and showResizeNotification().

◆ _topMargin

int TerminalView::_topMargin

private

Definition at line 647 of file TerminalView.h.

Referenced by TerminalView(), calcGeometry(), drawContents(), extendSelection(), getCharacterPosition(), imageToWidget(), preeditRect(), scrollImage(), setScrollBarPosition(), and updateImage().

◆ _tripleClickMode

TripleClickMode TerminalView::_tripleClickMode

private

Definition at line 698 of file TerminalView.h.

Referenced by mouseTripleClickEvent(), setTripleClickMode(), and tripleClickMode().

◆ _tripleSelBegin

QPoint TerminalView::_tripleSelBegin

private

Definition at line 680 of file TerminalView.h.

Referenced by extendSelection(), and mouseTripleClickEvent().

◆ _usedColumns

int TerminalView::_usedColumns

private

Definition at line 656 of file TerminalView.h.

Referenced by calcGeometry(), drawContents(), extendSelection(), getCharacterPosition(), inputMethodQuery(), makeImage(), mouseDoubleClickEvent(), scrollImage(), setFixedSize(), and updateImage().

◆ _usedLines

int TerminalView::_usedLines

private

Definition at line 652 of file TerminalView.h.

Referenced by calcGeometry(), drawContents(), extendSelection(), getCharacterPosition(), makeImage(), mouseDoubleClickEvent(), setFixedSize(), and updateImage().

◆ _wordCharacters

QString TerminalView::_wordCharacters

private

Definition at line 690 of file TerminalView.h.

Referenced by charClass(), setWordCharacters(), and wordCharacters().

◆ _wordSelectionMode

bool TerminalView::_wordSelectionMode

private

Definition at line 682 of file TerminalView.h.

Referenced by extendSelection(), mouseDoubleClickEvent(), mousePressEvent(), and mouseTripleClickEvent().

◆ BLINK_DELAY

const int TerminalView::BLINK_DELAY = 500

staticprivate

Definition at line 751 of file TerminalView.h.

Referenced by keyPressEvent(), setBlinkingCursorState(), and updateImage().

◆ DEFAULT_LEFT_MARGIN

const int TerminalView::DEFAULT_LEFT_MARGIN = 2

staticprivate

Definition at line 752 of file TerminalView.h.

Referenced by TerminalView(), and calcGeometry().

◆ DEFAULT_TOP_MARGIN

const int TerminalView::DEFAULT_TOP_MARGIN = 2

staticprivate

Definition at line 753 of file TerminalView.h.

Referenced by TerminalView(), and calcGeometry().

◆ dragInfo

struct TerminalView::_dragInfo TerminalView::dragInfo

protected

Referenced by TerminalView(), doDrag(), mouseMoveEvent(), mousePressEvent(), and mouseReleaseEvent().

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

libgui/qterminal/libqterminal/unix/TerminalView.h
libgui/qterminal/libqterminal/unix/TerminalView.cpp

Classes

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Types

Protected Slots

Protected Member Functions

Protected Attributes

Private Slots

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ BellMode

◆ DragState

◆ KeyboardCursorShape

◆ ScrollBarPosition

◆ TripleClickMode

Constructor & Destructor Documentation

◆ TerminalView()

◆ ~TerminalView()

Member Function Documentation

◆ antialias()

◆ bellMode()

◆ blinkCursorEvent

◆ blinkEvent

◆ blinkingCursor()

◆ bracketedPasteMode

◆ bracketedPasteModeIsDisabled()

◆ bracketText()

◆ calcGeometry()

◆ changedContentSizeSignal

◆ changedFontMetricSignal

◆ charClass()

◆ clearImage()

◆ colorTable()

◆ columns()

◆ configureRequest

◆ copyClipboard

◆ ctrlDrag()

◆ cursorPosition()

◆ disableBracketedPasteMode()

◆ doDrag()

◆ dragEnterEvent()

◆ drawBackground()

◆ drawCharacters()

◆ drawContents()

◆ drawCursor()

◆ drawInputMethodPreeditString()

◆ drawTextFragment()

◆ dropEvent()

◆ emitSelection()

◆ enableBell

◆ extendSelection()

◆ filterActions()

◆ filterChain()

◆ focusInEvent()

◆ focusNextPrevChild()

◆ focusOutEvent()

◆ fontChange()

◆ fontHeight()

◆ fontWidth()

◆ getCharacterPosition()

◆ getVTFont()

◆ hideEvent()

◆ hotSpotRegion()

◆ imageToWidget()

◆ inputMethodEvent()

◆ inputMethodQuery()

◆ interrupt_signal

◆ isBusySelecting

◆ keyboardCursorColor()

◆ keyboardCursorShape()

◆ keyPressedSignal

◆ keyPressEvent()

◆ lines()

◆ lineSpacing()