• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

Konsole

Konsole::TerminalDisplay

Konsole::TerminalDisplay Class Reference

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

#include <TerminalDisplay.h>

Inheritance diagram for Konsole::TerminalDisplay:

Inheritance graph
[legend]

List of all members.


Classes

struct  _dragInfo

Public Types

enum  BellMode { SystemBeepBell = 0, NotifyBell = 1, VisualBell = 2, NoBell = 3 }
enum  KeyboardCursorShape { BlockCursor, UnderlineCursor, IBeamCursor }
enum  ScrollBarPosition { NoScrollBar = 0, ScrollBarLeft = 1, ScrollBarRight = 2 }
enum  TripleClickMode { SelectWholeLine, SelectForwardsFromCursor }

Public Slots

void bell (const QString &message)
void copyClipboard ()
bool flowControlWarningEnabled () const
void outputSuspended (bool suspended)
void pasteClipboard ()
void pasteSelection ()
void setBackgroundColor (const QColor &color)
void setFlowControlWarningEnabled (bool enabled)
void setForegroundColor (const QColor &color)
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 isBusySelecting (bool)
void keyPressedSignal (QKeyEvent *e)
void mouseSignal (int button, int column, int line, int eventType)
void overrideShortcutCheck (QKeyEvent *keyEvent, bool &override)
void sendStringToEmu (const char *)

Public Member Functions

int bellMode ()
bool blinkingCursor ()
const ColorEntry * colorTable () const
int columns ()
bool ctrlDrag ()
void emitSelection (bool useXselection, bool appendReturn)
QList< QAction * > filterActions (const QPoint &position)
FilterChain * filterChain () const
int fontHeight ()
int fontWidth ()
QFont getVTFont ()
bool isBidiEnabled ()
QColor keyboardCursorColor () const
KeyboardCursorShape keyboardCursorShape () const
int lines ()
uint lineSpacing () const
void processFilters ()
uint randomSeed () const
ScreenWindow * screenWindow () const
void setBellMode (int mode)
void setBidiEnabled (bool set)
void setBlinkingCursor (bool blink)
void setColorTable (const ColorEntry table[])
void setCtrlDrag (bool enable)
void setFixedSize (int cols, int lins)
virtual void setFont (const QFont &)
void setKeyboardCursorColor (bool useForegroundColor, const QColor &color)
void setKeyboardCursorShape (KeyboardCursorShape shape)
void setLineSpacing (uint)
void setOpacity (qreal opacity)
void setRandomSeed (uint seed)
void setScreenWindow (ScreenWindow *window)
void setScroll (int cursor, int lines)
void setScrollBarPosition (ScrollBarPosition position)
void setSelection (const QString &t)
void setSize (int cols, int lins)
void setTerminalSizeHint (bool on)
void setTerminalSizeStartup (bool on)
void setTripleClickMode (TripleClickMode mode)
void setVTFont (const QFont &font)
void setWordCharacters (const QString &wc)
QSize sizeHint () const
 TerminalDisplay (QWidget *parent=0)
bool terminalSizeHint ()
TripleClickMode tripleClickMode ()
QString wordCharacters ()
virtual ~TerminalDisplay ()

Static Public Member Functions

static bool antialias ()
static void setAntialias (bool antialias)
static void setTransparencyEnabled (bool enable)

Static Public Attributes

static bool HAVE_TRANSPARENCY = false

Protected Types

enum  DragState { diNone, diPending, diDragging }

Protected Slots

void blinkCursorEvent ()
void blinkEvent ()
void enableBell ()
void scrollBarPositionChanged (int value)

Protected Member Functions

QChar charClass (QChar ch) const
void clearImage ()
void doDrag ()
virtual void dragEnterEvent (QDragEnterEvent *event)
virtual void dropEvent (QDropEvent *event)
virtual bool event (QEvent *)
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 &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
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 66 of file TerminalDisplay.h.


Member Enumeration Documentation

enum Konsole::TerminalDisplay::BellMode

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

Enumerator:
SystemBeepBell  A system beep.

NotifyBell  KDE notification.

This may play a sound, show a passive popup or perform some other action depending on the user's settings.

VisualBell  A silent, visual bell (eg.

inverting the display's colors briefly)

NoBell  No bell effects.

Definition at line 313 of file TerminalDisplay.h.

enum Konsole::TerminalDisplay::DragState [protected]

Enumerator:
diNone 
diPending 
diDragging 

Definition at line 550 of file TerminalDisplay.h.

enum Konsole::TerminalDisplay::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 187 of file TerminalDisplay.h.

enum Konsole::TerminalDisplay::ScrollBarPosition

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

Enumerator:
NoScrollBar  Do not show the scroll bar.

ScrollBarLeft  Show the scroll bar on the left side of the display.

ScrollBarRight  Show the scroll bar on the right side of the display.

Definition at line 96 of file TerminalDisplay.h.

enum Konsole::TerminalDisplay::TripleClickMode

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

Enumerator:
SelectWholeLine  Select the whole line underneath the cursor.

SelectForwardsFromCursor  Select from the current cursor position to the end of the line.

Definition at line 166 of file TerminalDisplay.h.


Constructor & Destructor Documentation

TerminalDisplay::TerminalDisplay ( QWidget *  parent = 0  ) 

Constructs a new terminal display widget with the specified parent.

Definition at line 281 of file TerminalDisplay.cpp.

TerminalDisplay::~TerminalDisplay (  )  [virtual]

Definition at line 378 of file TerminalDisplay.cpp.


Member Function Documentation

static bool Konsole::TerminalDisplay::antialias (  )  [inline, static]

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

Definition at line 353 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 2606 of file TerminalDisplay.cpp.

int Konsole::TerminalDisplay::bellMode (  )  [inline]

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

See setBellMode()

Definition at line 306 of file TerminalDisplay.h.

void TerminalDisplay::blinkCursorEvent (  )  [protected, slot]

Definition at line 1501 of file TerminalDisplay.cpp.

void TerminalDisplay::blinkEvent (  )  [protected, slot]

Definition at line 1474 of file TerminalDisplay.cpp.

bool Konsole::TerminalDisplay::blinkingCursor (  )  [inline]

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

Definition at line 155 of file TerminalDisplay.h.

void Konsole::TerminalDisplay::changedContentSizeSignal ( int  height,
int  width 
) [signal]

void Konsole::TerminalDisplay::changedFontMetricSignal ( int  height,
int  width 
) [signal]

QChar TerminalDisplay::charClass ( QChar  ch  )  const [protected]

Definition at line 2337 of file TerminalDisplay.cpp.

void TerminalDisplay::clearImage (  )  [protected]

Definition at line 2643 of file TerminalDisplay.cpp.

const ColorEntry * TerminalDisplay::colorTable (  )  const

Returns the terminal color palette used by the display.

Definition at line 144 of file TerminalDisplay.cpp.

int Konsole::TerminalDisplay::columns (  )  [inline]

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

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

Definition at line 254 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::copyClipboard (  )  [slot]

Copies the selected text to the clipboard.

Definition at line 2395 of file TerminalDisplay.cpp.

bool Konsole::TerminalDisplay::ctrlDrag (  )  [inline]

Definition at line 160 of file TerminalDisplay.h.

void TerminalDisplay::doDrag (  )  [protected]

Definition at line 2805 of file TerminalDisplay.cpp.

void TerminalDisplay::dragEnterEvent ( QDragEnterEvent *  event  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 2761 of file TerminalDisplay.cpp.

void TerminalDisplay::dropEvent ( QDropEvent *  event  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 2767 of file TerminalDisplay.cpp.

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

Definition at line 2370 of file TerminalDisplay.cpp.

void TerminalDisplay::enableBell (  )  [protected, slot]

Definition at line 2601 of file TerminalDisplay.cpp.

bool TerminalDisplay::event ( QEvent *  event  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 2582 of file TerminalDisplay.cpp.

void TerminalDisplay::extendSelection ( const QPoint &  pos  )  [protected, virtual]

Definition at line 1835 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 1719 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 1240 of file TerminalDisplay.cpp.

bool Konsole::TerminalDisplay::flowControlWarningEnabled (  )  const [inline, slot]

Returns true if the flow control warning box is enabled.

See outputSuspended() and setFlowControlWarningEnabled()

Definition at line 434 of file TerminalDisplay.h.

void TerminalDisplay::focusInEvent ( QFocusEvent *  event  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 1174 of file TerminalDisplay.cpp.

bool TerminalDisplay::focusNextPrevChild ( bool  next  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 2328 of file TerminalDisplay.cpp.

void TerminalDisplay::focusOutEvent ( QFocusEvent *  event  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 1160 of file TerminalDisplay.cpp.

void TerminalDisplay::fontChange ( const QFont &  font  )  [protected, virtual]

Definition at line 209 of file TerminalDisplay.cpp.

int Konsole::TerminalDisplay::fontHeight (  )  [inline]

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

Definition at line 259 of file TerminalDisplay.h.

int Konsole::TerminalDisplay::fontWidth (  )  [inline]

Returns the width of the characters in the display.

This assumes the use of a fixed-width font.

Definition at line 264 of file TerminalDisplay.h.

QFont Konsole::TerminalDisplay::getVTFont (  )  [inline]

Returns the font used to draw characters in the display.

Definition at line 337 of file TerminalDisplay.h.

void TerminalDisplay::hideEvent ( QHideEvent *   )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 1577 of file TerminalDisplay.cpp.

void TerminalDisplay::inputMethodEvent ( QInputMethodEvent *  event  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 2488 of file TerminalDisplay.cpp.

QVariant TerminalDisplay::inputMethodQuery ( Qt::InputMethodQuery  query  )  const [protected, virtual]

Definition at line 2498 of file TerminalDisplay.cpp.

bool Konsole::TerminalDisplay::isBidiEnabled (  )  [inline]

Returns the status of the BiDi rendering in this widget.

Definition at line 383 of file TerminalDisplay.h.

void Konsole::TerminalDisplay::isBusySelecting ( bool   )  [signal]

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

TerminalDisplay::KeyboardCursorShape TerminalDisplay::keyboardCursorShape (  )  const

Returns the shape of the keyboard cursor.

See setKeyboardCursorShape()

Definition at line 537 of file TerminalDisplay.cpp.

void Konsole::TerminalDisplay::keyPressedSignal ( QKeyEvent *  e  )  [signal]

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

void TerminalDisplay::keyPressEvent ( QKeyEvent *  event  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 2430 of file TerminalDisplay.cpp.

int Konsole::TerminalDisplay::lines (  )  [inline]

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

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

Definition at line 246 of file TerminalDisplay.h.

uint TerminalDisplay::lineSpacing (  )  const

Definition at line 2856 of file TerminalDisplay.cpp.

void TerminalDisplay::mouseDoubleClickEvent ( QMouseEvent *  ev  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 2124 of file TerminalDisplay.cpp.

void TerminalDisplay::mouseMoveEvent ( QMouseEvent *  ev  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 1729 of file TerminalDisplay.cpp.

void TerminalDisplay::mousePressEvent ( QMouseEvent *  ev  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 1644 of file TerminalDisplay.cpp.

void TerminalDisplay::mouseReleaseEvent ( QMouseEvent *  ev  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 2043 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 *  ev  )  [protected]

Definition at line 2268 of file TerminalDisplay.cpp.

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 2816 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 *  pe  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 1186 of file TerminalDisplay.cpp.

void TerminalDisplay::pasteClipboard (  )  [slot]

Pastes the content of the clipboard into the display.

Definition at line 2404 of file TerminalDisplay.cpp.

void TerminalDisplay::pasteSelection (  )  [slot]

Pastes the content of the selection into the display.

Definition at line 2409 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 906 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 745 of file TerminalDisplay.cpp.

void TerminalDisplay::resizeEvent ( QResizeEvent *   )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 1513 of file TerminalDisplay.cpp.

ScreenWindow * TerminalDisplay::screenWindow (  )  const

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

See setScreenWindow()

Definition at line 119 of file TerminalDisplay.cpp.

void TerminalDisplay::scrollBarPositionChanged ( int  value  )  [protected, slot]

Definition at line 1588 of file TerminalDisplay.cpp.

void Konsole::TerminalDisplay::sendStringToEmu ( const char *   )  [signal]

static void Konsole::TerminalDisplay::setAntialias ( bool  antialias  )  [inline, static]

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

Defaults to enabled.

Definition at line 349 of file TerminalDisplay.h.

void TerminalDisplay::setBackgroundColor ( const QColor &  color  )  [slot]

Sets the background of the display to the specified color.

See also:
setColorTable(), setForegroundColor()

Definition at line 148 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 2596 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 379 of file TerminalDisplay.h.

void TerminalDisplay::setBlinkingCursor ( bool  blink  ) 

Specifies whether or not the cursor blinks.

Definition at line 1143 of file TerminalDisplay.cpp.

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

Sets the terminal color palette used by the display.

Definition at line 166 of file TerminalDisplay.cpp.

void Konsole::TerminalDisplay::setCtrlDrag ( bool  enable  )  [inline]

Definition at line 159 of file TerminalDisplay.h.

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

Reimplemented from QWidget.

Definition at line 2730 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 2420 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 270 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()

Definition at line 160 of file TerminalDisplay.cpp.

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

Sets the color used to draw the keyboard cursor.

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

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

Definition at line 541 of file TerminalDisplay.cpp.

void TerminalDisplay::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 533 of file TerminalDisplay.cpp.

void TerminalDisplay::setLineSpacing ( uint  i  ) 

Definition at line 2861 of file TerminalDisplay.cpp.

void TerminalDisplay::setOpacity ( qreal  opacity  ) 

Sets the opacity of the terminal display.

Definition at line 557 of file TerminalDisplay.cpp.

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 744 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 123 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 1605 of file TerminalDisplay.cpp.

void TerminalDisplay::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 1627 of file TerminalDisplay.cpp.

void TerminalDisplay::setSelection ( const QString &  t  ) 

Definition at line 2390 of file TerminalDisplay.cpp.

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

Definition at line 2713 of file TerminalDisplay.cpp.

void Konsole::TerminalDisplay::setTerminalSizeHint ( bool  on  )  [inline]

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

Definition at line 360 of file TerminalDisplay.h.

void Konsole::TerminalDisplay::setTerminalSizeStartup ( bool  on  )  [inline]

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

See setTerminalSizeHint() , isTerminalSizeHint()

Definition at line 373 of file TerminalDisplay.h.

static void Konsole::TerminalDisplay::setTransparencyEnabled ( bool  enable  )  [inline, static]

Definition at line 784 of file TerminalDisplay.h.

void Konsole::TerminalDisplay::setTripleClickMode ( TripleClickMode  mode  )  [inline]

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

Definition at line 174 of file TerminalDisplay.h.

void TerminalDisplay::setUsesMouse ( bool  usesMouse  )  [slot]

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

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

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

Definition at line 2352 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 242 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 2347 of file TerminalDisplay.cpp.

void TerminalDisplay::showEvent ( QShowEvent *   )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 1573 of file TerminalDisplay.cpp.

QSize TerminalDisplay::sizeHint (  )  const

Definition at line 2749 of file TerminalDisplay.cpp.

bool Konsole::TerminalDisplay::terminalSizeHint (  )  [inline]

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

Definition at line 366 of file TerminalDisplay.h.

TripleClickMode Konsole::TerminalDisplay::tripleClickMode (  )  [inline]

See setTripleClickSelectionMode().

Definition at line 176 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 929 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 2116 of file TerminalDisplay.cpp.

bool TerminalDisplay::usesMouse (  )  const [slot]

See setUsesMouse().

Definition at line 2357 of file TerminalDisplay.cpp.

void TerminalDisplay::wheelEvent ( QWheelEvent *  ev  )  [protected, virtual]

Reimplemented from QWidget.

Definition at line 2214 of file TerminalDisplay.cpp.

QString Konsole::TerminalDisplay::wordCharacters (  )  [inline]

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

See also:
setWordCharacters()

Definition at line 290 of file TerminalDisplay.h.


Member Data Documentation

struct Konsole::TerminalDisplay::_dragInfo Konsole::TerminalDisplay::dragInfo [protected]

bool TerminalDisplay::HAVE_TRANSPARENCY = false [static]

Definition at line 397 of file TerminalDisplay.h.


The documentation for this class was generated from the following files:
  • TerminalDisplay.h
  • TerminalDisplay.cpp

Konsole

Skip menu "Konsole"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

API Reference

Skip menu "API Reference"
  • Konsole
  • Libraries
  •   libkonq
Generated for API Reference by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal