#include <TerminalDisplay.h>

Inheritance diagram for Konsole::TerminalDisplay:

Classes
struct	DragInfo

Public Slots
void	bell (const QString &message)

void	copyToClipboard ()

void	copyToX11Selection ()

bool	flowControlWarningEnabled () const

QColor	getBackgroundColor () const

void	outputSuspended (bool suspended)

void	pasteFromClipboard (bool appendEnter=false)

void	pasteFromX11Selection (bool appendEnter=false)

void	scrollScreenWindow (enum ScreenWindow::RelativeScrollMode mode, int amount)

void	setAutoCopySelectedText (bool enabled)

void	setBackgroundColor (const QColor &color)

void	setCenterContents (bool enable)

void	setFlowControlWarningEnabled (bool enabled)

void	setForegroundColor (const QColor &color)

void	setMargin (int margin)

void	setMiddleClickPasteMode (Enum::MiddleClickPasteModeEnum mode)

void	setUsesMouse (bool usesMouse)

void	updateImage ()

void	updateLineProperties ()

bool	usesMouse () const

Signals
void	changedContentSizeSignal (int height, int width)

void	changedFontMetricSignal (int height, int width)

void	configureRequest (const QPoint &position)

void	keyPressedSignal (QKeyEvent *event)

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

void	overrideShortcutCheck (QKeyEvent *keyEvent, bool &override)

void	sendStringToEmu (const char *)

Public Member Functions
	TerminalDisplay (QWidget *parent=0)

virtual	~TerminalDisplay ()

bool	antialias () const

int	bellMode () const

bool	blinkingCursorEnabled () const

const ColorEntry *	colorTable () const

int	columns () const

bool	ctrlRequiredForDrag () const

void	decreaseFontSize ()

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

FilterChain *	filterChain () const

int	fontHeight () const

int	fontWidth () const

bool	getBoldIntense () const

bool	getOpenLinksByDirectClick () const

bool	getUnderlineLinks () const

QFont	getVTFont ()

void	increaseFontSize ()

bool	isBidiEnabled () const

QColor	keyboardCursorColor () const

Enum::CursorShapeEnum	keyboardCursorShape () const

int	lines () const

uint	lineSpacing () const

bool	mouseWheelZoom ()

void	printContent (QPainter &painter, bool friendly)

void	processFilters ()

uint	randomSeed () const

ScreenWindow *	screenWindow () const

Enum::ScrollBarPositionEnum	scrollBarPosition () const

bool	scrollFullPage () const

SessionController *	sessionController ()

void	setAntialias (bool value)

void	setBellMode (int mode)

void	setBidiEnabled (bool set)

void	setBlinkingCursorEnabled (bool blink)

void	setBlinkingTextEnabled (bool blink)

void	setBoldIntense (bool value)

void	setColorTable (const ColorEntry table[])

void	setControlDrag (bool enable)

void	setFixedSize (int columns, int lines)

virtual void	setFont (const QFont &)

void	setKeyboardCursorColor (const QColor &color)

void	setKeyboardCursorShape (Enum::CursorShapeEnum shape)

void	setLineSpacing (uint)

void	setMouseWheelZoom (bool value)

void	setOpacity (qreal opacity)

void	setOpenLinksByDirectClick (bool value)

void	setRandomSeed (uint seed)

void	setScreenWindow (ScreenWindow *window)

void	setScroll (int cursor, int lines)

void	setScrollBarPosition (Enum::ScrollBarPositionEnum position)

void	setScrollFullPage (bool fullPage)

void	setSessionController (SessionController *controller)

void	setShowTerminalSizeHint (bool on)

void	setSize (int columns, int lines)

void	setTrimTrailingSpaces (bool enabled)

void	setTripleClickMode (Enum::TripleClickModeEnum mode)

void	setUnderlineLinks (bool value)

void	setVTFont (const QFont &font)

void	setWallpaper (ColorSchemeWallpaper::Ptr p)

void	setWordCharacters (const QString &wc)

bool	showTerminalSizeHint () const

QSize	sizeHint () const

bool	trimTrailingSpaces () const

Enum::TripleClickModeEnum	tripleClickMode () const

void	visualBell ()

QString	wordCharacters () const

Protected Types
enum	DragState { diNone, diPending, diDragging }

Protected Slots
void	blinkCursorEvent ()

void	blinkTextEvent ()

void	scrollBarPositionChanged (int value)

Protected Member Functions
QChar	charClass (const Character &ch) const

void	clearImage ()

virtual void	contextMenuEvent (QContextMenuEvent *event)

void	doDrag ()

virtual void	dragEnterEvent (QDragEnterEvent *event)

virtual void	dropEvent (QDropEvent *event)

virtual bool	event (QEvent *event)

virtual void	extendSelection (const QPoint &pos)

virtual void	focusInEvent (QFocusEvent *event)

virtual bool	focusNextPrevChild (bool next)

virtual void	focusOutEvent (QFocusEvent *event)

virtual void	fontChange (const QFont &)

virtual void	hideEvent (QHideEvent *event)

virtual void	inputMethodEvent (QInputMethodEvent *event)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

void	mouseTripleClickEvent (QMouseEvent *event)

virtual void	paintEvent (QPaintEvent *event)

virtual void	resizeEvent (QResizeEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	wheelEvent (QWheelEvent *event)

Protected Attributes
struct Konsole::TerminalDisplay::DragInfo	_dragInfo

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 TerminalDisplay.h.

Member Enumeration Documentation

enum Konsole::TerminalDisplay::DragState

protected

Enumerator
diNone
diPending
diDragging

Definition at line 639 of file TerminalDisplay.h.

Constructor & Destructor Documentation

TerminalDisplay::TerminalDisplay ( QWidget * parent = 0 )

explicit

Constructs a new terminal display widget with the specified parent.

Definition at line 294 of file TerminalDisplay.cpp.

TerminalDisplay::~TerminalDisplay ( )

virtual

Definition at line 409 of file TerminalDisplay.cpp.

Member Function Documentation

bool Konsole::TerminalDisplay::antialias ( ) const

inline

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

Definition at line 392 of file TerminalDisplay.h.

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 3028 of file TerminalDisplay.cpp.

int TerminalDisplay::bellMode ( ) const

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

See setBellMode()

Definition at line 3018 of file TerminalDisplay.cpp.

void TerminalDisplay::blinkCursorEvent ( )

protectedslot

Definition at line 1584 of file TerminalDisplay.cpp.

bool Konsole::TerminalDisplay::blinkingCursorEnabled ( ) const

inline

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

Definition at line 151 of file TerminalDisplay.h.

void TerminalDisplay::blinkTextEvent ( )

protectedslot

Definition at line 1573 of file TerminalDisplay.cpp.

void Konsole::TerminalDisplay::changedContentSizeSignal	(	int	height,
		int	width
	)

signal

void Konsole::TerminalDisplay::changedFontMetricSignal	(	int	height,
		int	width
	)

signal

QChar TerminalDisplay::charClass ( const Character & ch ) const

protected

Definition at line 2632 of file TerminalDisplay.cpp.

void TerminalDisplay::clearImage ( )

protected

Definition at line 1675 of file TerminalDisplay.cpp.

const ColorEntry * TerminalDisplay::colorTable ( ) const

Returns the terminal color palette used by the display.

Definition at line 124 of file TerminalDisplay.cpp.

int Konsole::TerminalDisplay::columns ( ) const

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 278 of file TerminalDisplay.h.

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.

void TerminalDisplay::contextMenuEvent ( QContextMenuEvent * event )

protectedvirtual

Definition at line 2999 of file TerminalDisplay.cpp.

void TerminalDisplay::copyToClipboard ( )

slot

Copies the selected text to the system clipboard.

Definition at line 2735 of file TerminalDisplay.cpp.

void TerminalDisplay::copyToX11Selection ( )

slot

Copies the selected text to the X11 Selection.

Definition at line 2720 of file TerminalDisplay.cpp.

bool Konsole::TerminalDisplay::ctrlRequiredForDrag ( ) const

inline

Definition at line 161 of file TerminalDisplay.h.

void TerminalDisplay::decreaseFontSize ( )

Decreases the font size.

Definition at line 246 of file TerminalDisplay.cpp.

void TerminalDisplay::doDrag ( )

protected

Definition at line 3186 of file TerminalDisplay.cpp.

void TerminalDisplay::dragEnterEvent ( QDragEnterEvent * event )

protectedvirtual

Definition at line 3081 of file TerminalDisplay.cpp.

void TerminalDisplay::dropEvent ( QDropEvent * event )

protectedvirtual

Definition at line 3093 of file TerminalDisplay.cpp.

bool TerminalDisplay::event ( QEvent * event )

protectedvirtual

Definition at line 2982 of file TerminalDisplay.cpp.

void TerminalDisplay::extendSelection ( const QPoint & pos )

protectedvirtual

Definition at line 2057 of file TerminalDisplay.cpp.

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 1934 of file TerminalDisplay.cpp.

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 1209 of file TerminalDisplay.cpp.

bool Konsole::TerminalDisplay::flowControlWarningEnabled ( ) const

inlineslot

Returns true if the flow control warning box is enabled.

See outputSuspended() and setFlowControlWarningEnabled()

Definition at line 504 of file TerminalDisplay.h.

void TerminalDisplay::focusInEvent ( QFocusEvent * event )

protectedvirtual

Definition at line 1562 of file TerminalDisplay.cpp.

bool TerminalDisplay::focusNextPrevChild ( bool next )

protectedvirtual

Definition at line 2622 of file TerminalDisplay.cpp.

void TerminalDisplay::focusOutEvent ( QFocusEvent * event )

protectedvirtual

Definition at line 1540 of file TerminalDisplay.cpp.

void TerminalDisplay::fontChange ( const QFont & )

protectedvirtual

Definition at line 174 of file TerminalDisplay.cpp.

int Konsole::TerminalDisplay::fontHeight ( ) const

inline

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

Definition at line 285 of file TerminalDisplay.h.

int Konsole::TerminalDisplay::fontWidth ( ) const

inline

Returns the width of the characters in the display.

This assumes the use of a fixed-width font.

Definition at line 292 of file TerminalDisplay.h.

QColor TerminalDisplay::getBackgroundColor ( ) const

slot

Gets the background of the display.

See also: setBackgroundColor(), setColorTable(), setForegroundColor()

Definition at line 141 of file TerminalDisplay.cpp.

bool Konsole::TerminalDisplay::getBoldIntense ( ) const

inline

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

Definition at line 406 of file TerminalDisplay.h.

bool Konsole::TerminalDisplay::getOpenLinksByDirectClick ( ) const

inline

Returns true if links and email addresses should be opened when clicked with the mouse.

Definition at line 200 of file TerminalDisplay.h.

bool Konsole::TerminalDisplay::getUnderlineLinks ( ) const

inline

Returns true if links and email addresses should be underlined when hovered by the mouse.

Definition at line 185 of file TerminalDisplay.h.

QFont Konsole::TerminalDisplay::getVTFont ( )

inline

Returns the font used to draw characters in the display.

Definition at line 366 of file TerminalDisplay.h.

void TerminalDisplay::hideEvent ( QHideEvent * event )

protectedvirtual

Definition at line 1763 of file TerminalDisplay.cpp.

void TerminalDisplay::increaseFontSize ( )

Increases the font size.

Definition at line 239 of file TerminalDisplay.cpp.

void TerminalDisplay::inputMethodEvent ( QInputMethodEvent * event )

protectedvirtual

Definition at line 2765 of file TerminalDisplay.cpp.

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

protectedvirtual

Definition at line 2778 of file TerminalDisplay.cpp.

bool Konsole::TerminalDisplay::isBidiEnabled ( ) const

inline

Returns the status of the BiDi rendering in this widget.

Definition at line 437 of file TerminalDisplay.h.

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 570 of file TerminalDisplay.cpp.

Enum::CursorShapeEnum TerminalDisplay::keyboardCursorShape ( ) const

Returns the shape of the keyboard cursor.

See setKeyboardCursorShape()

Definition at line 562 of file TerminalDisplay.cpp.

void Konsole::TerminalDisplay::keyPressedSignal ( QKeyEvent * event )

signal

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

void TerminalDisplay::keyPressEvent ( QKeyEvent * event )

protectedvirtual

Definition at line 2908 of file TerminalDisplay.cpp.

void TerminalDisplay::leaveEvent ( QEvent * event )

protectedvirtual

Definition at line 2048 of file TerminalDisplay.cpp.

int Konsole::TerminalDisplay::lines ( ) const

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 268 of file TerminalDisplay.h.

uint TerminalDisplay::lineSpacing ( ) const

Definition at line 255 of file TerminalDisplay.cpp.

void TerminalDisplay::mouseDoubleClickEvent ( QMouseEvent * event )

protectedvirtual

Definition at line 2341 of file TerminalDisplay.cpp.

void TerminalDisplay::mouseMoveEvent ( QMouseEvent * event )

protectedvirtual

Definition at line 1944 of file TerminalDisplay.cpp.

void TerminalDisplay::mousePressEvent ( QMouseEvent * event )

protectedvirtual

Definition at line 1856 of file TerminalDisplay.cpp.

void TerminalDisplay::mouseReleaseEvent ( QMouseEvent * event )

protectedvirtual

Definition at line 2248 of file TerminalDisplay.cpp.

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

void TerminalDisplay::mouseTripleClickEvent ( QMouseEvent * event )

protected

Definition at line 2567 of file TerminalDisplay.cpp.

bool Konsole::TerminalDisplay::mouseWheelZoom ( )

inline

Returns the whether zoom terminal on Ctrl+mousewheel is enabled.

See setMouseWheelZoom()

Definition at line 355 of file TerminalDisplay.h.

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 2861 of file TerminalDisplay.cpp.

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.

void TerminalDisplay::paintEvent ( QPaintEvent * event )

protectedvirtual

Definition at line 1166 of file TerminalDisplay.cpp.

void TerminalDisplay::pasteFromClipboard ( bool appendEnter = false )

slot

Pastes the content of the clipboard into the display.

Definition at line 2747 of file TerminalDisplay.cpp.

void TerminalDisplay::pasteFromX11Selection ( bool appendEnter = false )

slot

Pastes the content of the X11 selection into the display.

Definition at line 2753 of file TerminalDisplay.cpp.

void TerminalDisplay::printContent	(	QPainter &	painter,
		bool	friendly
	)

Definition at line 1180 of file TerminalDisplay.cpp.

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 939 of file TerminalDisplay.cpp.

uint TerminalDisplay::randomSeed ( ) const

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

Definition at line 804 of file TerminalDisplay.cpp.

void TerminalDisplay::resizeEvent ( QResizeEvent * event )

protectedvirtual

Definition at line 1604 of file TerminalDisplay.cpp.

ScreenWindow * TerminalDisplay::screenWindow ( ) const

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

See setScreenWindow()

Definition at line 103 of file TerminalDisplay.cpp.

Enum::ScrollBarPositionEnum Konsole::TerminalDisplay::scrollBarPosition ( ) const

inline

Definition at line 98 of file TerminalDisplay.h.

void TerminalDisplay::scrollBarPositionChanged ( int value )

protectedslot

Definition at line 1803 of file TerminalDisplay.cpp.

bool TerminalDisplay::scrollFullPage ( ) const

Definition at line 1846 of file TerminalDisplay.cpp.

void TerminalDisplay::scrollScreenWindow	(	enum ScreenWindow::RelativeScrollMode	mode,
		int	amount
	)

slot

Scrolls current ScreenWindow.

it's needed for proper handling scroll commands in the Vt102Emulation class

Definition at line 2899 of file TerminalDisplay.cpp.

void Konsole::TerminalDisplay::sendStringToEmu ( const char * )

signal

SessionController * TerminalDisplay::sessionController ( )

Definition at line 3201 of file TerminalDisplay.cpp.

void Konsole::TerminalDisplay::setAntialias ( bool value )

inline

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

Defaults to enabled.

Definition at line 386 of file TerminalDisplay.h.

void TerminalDisplay::setAutoCopySelectedText ( bool enabled )

slot

Definition at line 2710 of file TerminalDisplay.cpp.

void TerminalDisplay::setBackgroundColor ( const QColor & color )

slot

Sets the background of the display to the specified color.

See also: setColorTable(), getBackgroundColor(), setForegroundColor()

Definition at line 128 of file TerminalDisplay.cpp.

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 3013 of file TerminalDisplay.cpp.

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

inline

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

Defaults to disabled.

Definition at line 431 of file TerminalDisplay.h.

void TerminalDisplay::setBlinkingCursorEnabled ( bool blink )

Specifies whether or not the cursor can blink.

Definition at line 1510 of file TerminalDisplay.cpp.

void TerminalDisplay::setBlinkingTextEnabled ( bool blink )

Specifies whether or not text can blink.

Definition at line 1527 of file TerminalDisplay.cpp.

void Konsole::TerminalDisplay::setBoldIntense ( bool value )

inline

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

Defaults to true.

Definition at line 400 of file TerminalDisplay.h.

void TerminalDisplay::setCenterContents ( bool enable )

slot

Sets whether the contents are centered between the margins.

Definition at line 1774 of file TerminalDisplay.cpp.

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

Sets the terminal color palette used by the display.

Definition at line 152 of file TerminalDisplay.cpp.

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

inline

Definition at line 158 of file TerminalDisplay.h.

void TerminalDisplay::setFixedSize	(	int	columns,
		int	lines
	)

Definition at line 1731 of file TerminalDisplay.cpp.

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 2851 of file TerminalDisplay.cpp.

void TerminalDisplay::setFont ( const QFont & )

virtual

Reimplemented.

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

Definition at line 234 of file TerminalDisplay.cpp.

void TerminalDisplay::setForegroundColor ( const QColor & color )

slot

Sets the text of the display to the specified color.

See also: setColorTable(), setBackgroundColor(), getBackgroundColor()

Definition at line 146 of file TerminalDisplay.cpp.

void TerminalDisplay::setKeyboardCursorColor ( 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

color By default, the widget uses the color of the character under the cursor to draw the cursor, and inverts the color of that character to make sure it is still readable. If color is a valid QColor, the widget uses that color to draw the cursor. If color is not an valid QColor, the widget falls back to the default behavior.

Definition at line 566 of file TerminalDisplay.cpp.

void TerminalDisplay::setKeyboardCursorShape ( Enum::CursorShapeEnum 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 558 of file TerminalDisplay.cpp.

void TerminalDisplay::setLineSpacing ( uint i )

Definition at line 260 of file TerminalDisplay.cpp.

void TerminalDisplay::setMargin ( int margin )

slot

Sets the display's contents margins.

Definition at line 1768 of file TerminalDisplay.cpp.

void TerminalDisplay::setMiddleClickPasteMode ( Enum::MiddleClickPasteModeEnum mode )

slot

Definition at line 2715 of file TerminalDisplay.cpp.

void Konsole::TerminalDisplay::setMouseWheelZoom ( bool value )

inline

Specified whether zoom terminal on Ctrl+mousewheel is enabled or not.

Defaults to enabled.

Definition at line 347 of file TerminalDisplay.h.

void TerminalDisplay::setOpacity ( qreal opacity )

Sets the opacity of the terminal display.

Definition at line 575 of file TerminalDisplay.cpp.

void Konsole::TerminalDisplay::setOpenLinksByDirectClick ( bool value )

inline

Specifies whether links and email addresses should be opened when clicked with the mouse.

Defaults to false.

Definition at line 193 of file TerminalDisplay.h.

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 800 of file TerminalDisplay.cpp.

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 107 of file TerminalDisplay.cpp.

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 1820 of file TerminalDisplay.cpp.

void TerminalDisplay::setScrollBarPosition ( Enum::ScrollBarPositionEnum 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 1787 of file TerminalDisplay.cpp.

void TerminalDisplay::setScrollFullPage ( bool fullPage )

Definition at line 1841 of file TerminalDisplay.cpp.

void TerminalDisplay::setSessionController ( SessionController * controller )

Definition at line 3196 of file TerminalDisplay.cpp.

void Konsole::TerminalDisplay::setShowTerminalSizeHint ( 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 415 of file TerminalDisplay.h.

void TerminalDisplay::setSize	(	int	columns,
		int	lines
	)

Definition at line 1716 of file TerminalDisplay.cpp.

void Konsole::TerminalDisplay::setTrimTrailingSpaces ( bool enabled )

inline

Sets whether trailing spaces should be trimmed in selected text.

Definition at line 207 of file TerminalDisplay.h.

void Konsole::TerminalDisplay::setTripleClickMode ( Enum::TripleClickModeEnum mode )

inline

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

Definition at line 166 of file TerminalDisplay.h.

void Konsole::TerminalDisplay::setUnderlineLinks ( bool value )

inline

Specifies whether links and email addresses should be underlined when hovered by the mouse.

Defaults to true.

Definition at line 178 of file TerminalDisplay.h.

void TerminalDisplay::setUsesMouse ( bool usesMouse )

slot

Sets whether the program whose 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 2666 of file TerminalDisplay.cpp.

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 205 of file TerminalDisplay.cpp.

void TerminalDisplay::setWallpaper ( ColorSchemeWallpaper::Ptr p )

Sets the background picture.

Definition at line 594 of file TerminalDisplay.cpp.

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 2658 of file TerminalDisplay.cpp.

void TerminalDisplay::showEvent ( QShowEvent * event )

protectedvirtual

Definition at line 1759 of file TerminalDisplay.cpp.

bool Konsole::TerminalDisplay::showTerminalSizeHint ( ) const

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 423 of file TerminalDisplay.h.

QSize TerminalDisplay::sizeHint ( ) const

Definition at line 1749 of file TerminalDisplay.cpp.

bool Konsole::TerminalDisplay::trimTrailingSpaces ( ) const

inline

Returns true if trailing spaces should be trimmed in selected text.

Definition at line 214 of file TerminalDisplay.h.

Enum::TripleClickModeEnum Konsole::TerminalDisplay::tripleClickMode ( ) const

inline

See setTripleClickSelectionMode()

Definition at line 170 of file TerminalDisplay.h.

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 962 of file TerminalDisplay.cpp.

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 2312 of file TerminalDisplay.cpp.

bool TerminalDisplay::usesMouse ( ) const

slot

See setUsesMouse()

Definition at line 2671 of file TerminalDisplay.cpp.

void TerminalDisplay::visualBell ( )

Play a visual bell for prompt or warning.

Definition at line 3059 of file TerminalDisplay.cpp.

void TerminalDisplay::wheelEvent ( QWheelEvent * event )

protectedvirtual

Definition at line 2434 of file TerminalDisplay.cpp.

QString Konsole::TerminalDisplay::wordCharacters ( ) const

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 320 of file TerminalDisplay.h.

Member Data Documentation

struct Konsole::TerminalDisplay::DragInfo Konsole::TerminalDisplay::_dragInfo

protected

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

Konsole

Classes

Public Slots

Signals

Public Member Functions

Protected Types

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Konsole

applications API Reference

Search