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

Konsole

Konsole::ScreenWindow

Konsole::ScreenWindow Class Reference

Provides a window onto a section of a terminal screen. More...

#include <ScreenWindow.h>

Inheritance diagram for Konsole::ScreenWindow:

Inheritance graph
[legend]

List of all members.


Public Types

enum  RelativeScrollMode { ScrollLines, ScrollPages }

Public Slots

void notifyOutputChanged ()

Signals

void outputChanged ()
void scrolled (int line)
void selectionChanged ()

Public Member Functions

bool atEndOfOutput () const
void clearSelection ()
int columnCount () const
int currentLine () const
QPoint cursorPosition () const
Character * getImage ()
QVector< LineProperty > getLineProperties ()
void getSelectionEnd (int &column, int &line)
void getSelectionStart (int &column, int &line)
bool isSelected (int column, int line)
int lineCount () const
void resetScrollCount ()
Screen * screen () const
 ScreenWindow (QObject *parent=0)
void scrollBy (RelativeScrollMode mode, int amount)
int scrollCount () const
QRect scrollRegion () const
void scrollTo (int line)
QString selectedText (bool preserveLineBreaks) const
void setScreen (Screen *screen)
void setSelectionEnd (int column, int line)
void setSelectionStart (int column, int line, bool columnMode)
void setTrackOutput (bool trackOutput)
void setWindowLines (int lines)
bool trackOutput () const
int windowColumns () const
int windowLines () const
virtual ~ScreenWindow ()

Detailed Description

Provides a window onto a section of a terminal screen.

A terminal widget can then render the contents of the window and use the window to change the terminal screen's selection in response to mouse or keyboard input.

A new ScreenWindow for a terminal session can be created by calling Emulation::createWindow()

Use the scrollTo() method to scroll the window up and down on the screen. Use the getImage() method to retrieve the character image which is currently visible in the window.

setTrackOutput() controls whether the window moves to the bottom of the associated screen when new lines are added to it.

Whenever the output from the underlying screen is changed, the notifyOutputChanged() slot should be called. This in turn will update the window's position and emit the outputChanged() signal if necessary.

Definition at line 53 of file ScreenWindow.h.


Member Enumeration Documentation

enum Konsole::ScreenWindow::RelativeScrollMode

Describes the units which scrollBy() moves the window by.

Enumerator:
ScrollLines  Scroll the window down by a given number of lines.

ScrollPages  Scroll the window down by a given number of pages, where one page is windowLines() lines.

Definition at line 175 of file ScreenWindow.h.


Constructor & Destructor Documentation

ScreenWindow::ScreenWindow ( QObject *  parent = 0  ) 

Constructs a new screen window with the given parent.

A screen must be specified by calling setScreen() before calling getImage() or getLineProperties().

You should not call this constructor directly, instead use the Emulation::createWindow() method to create a window on the emulation which you wish to view. This allows the emulation to notify the window when the associated screen has changed and synchronize selection updates between all views on a session.

Definition at line 31 of file ScreenWindow.cpp.

ScreenWindow::~ScreenWindow (  )  [virtual]

Definition at line 42 of file ScreenWindow.cpp.


Member Function Documentation

bool ScreenWindow::atEndOfOutput (  )  const

Convenience method.

Returns true if the window is currently at the bottom of the screen.

Definition at line 213 of file ScreenWindow.cpp.

void ScreenWindow::clearSelection (  ) 

Clears the current selection.

Definition at line 154 of file ScreenWindow.cpp.

int ScreenWindow::columnCount (  )  const

Returns the total number of columns in the screen.

Definition at line 181 of file ScreenWindow.cpp.

int ScreenWindow::currentLine (  )  const

Returns the index of the line which is currently at the top of this window.

Definition at line 196 of file ScreenWindow.cpp.

QPoint ScreenWindow::cursorPosition (  )  const

Returns the position of the cursor within the window.

Definition at line 186 of file ScreenWindow.cpp.

Character * ScreenWindow::getImage (  ) 

Returns the image of characters which are currently visible through this window onto the screen.

The returned buffer is managed by the ScreenWindow instance and does not need to be deleted by the caller.

Definition at line 58 of file ScreenWindow.cpp.

QVector< LineProperty > ScreenWindow::getLineProperties (  ) 

Returns the line attributes associated with the lines of characters which are currently visible through this window.

Definition at line 108 of file ScreenWindow.cpp.

void ScreenWindow::getSelectionEnd ( int &  column,
int &  line 
)

Retrieves the end of the selection within the window.

Definition at line 128 of file ScreenWindow.cpp.

void ScreenWindow::getSelectionStart ( int &  column,
int &  line 
)

Retrieves the start of the selection within the window.

Definition at line 123 of file ScreenWindow.cpp.

bool ScreenWindow::isSelected ( int  column,
int  line 
)

Returns true if the character at line , column is part of the selection.

Definition at line 149 of file ScreenWindow.cpp.

int ScreenWindow::lineCount (  )  const

Returns the total number of lines in the screen.

Definition at line 176 of file ScreenWindow.cpp.

void ScreenWindow::notifyOutputChanged (  )  [slot]

Notifies the window that the contents of the associated terminal screen have changed.

This moves the window to the bottom of the screen if trackOutput() is true and causes the outputChanged() signal to be emitted.

Definition at line 265 of file ScreenWindow.cpp.

void Konsole::ScreenWindow::outputChanged (  )  [signal]

Emitted when the contents of the associated terminal screen (see screen()) changes.

void ScreenWindow::resetScrollCount (  ) 

Resets the count of scrolled lines returned by scrollCount().

Definition at line 250 of file ScreenWindow.cpp.

Screen * ScreenWindow::screen (  )  const

Returns the screen which this window looks onto.

Definition at line 53 of file ScreenWindow.cpp.

void ScreenWindow::scrollBy ( RelativeScrollMode  mode,
int  amount 
)

Scrolls the window relative to its current position on the screen.

Parameters:
mode Specifies whether amount refers to the number of lines or the number of pages to scroll.
amount The number of lines or pages ( depending on mode ) to scroll by. If this number is positive, the view is scrolled down. If this number is negative, the view is scrolled up.

Definition at line 201 of file ScreenWindow.cpp.

int ScreenWindow::scrollCount (  )  const

Returns the number of lines which the region of the window specified by scrollRegion() has been scrolled by since the last call to resetScrollCount().

scrollRegion() is in most cases the whole window, but will be a smaller area in, for example, applications which provide split-screen facilities.

This is not guaranteed to be accurate, but allows views to optimise rendering by reducing the amount of costly text rendering that needs to be done when the output is scrolled.

Definition at line 245 of file ScreenWindow.cpp.

void Konsole::ScreenWindow::scrolled ( int  line  )  [signal]

Emitted when the screen window is scrolled to a different position.

Parameters:
line The line which is now at the top of the window.

QRect ScreenWindow::scrollRegion (  )  const

Returns the area of the window which was last scrolled, this is usually the whole window area.

Like scrollCount(), this is not guaranteed to be accurate, but allows views to optimise rendering.

Definition at line 255 of file ScreenWindow.cpp.

void ScreenWindow::scrollTo ( int  line  ) 

Scrolls the window so that line is at the top of the window.

Definition at line 218 of file ScreenWindow.cpp.

QString ScreenWindow::selectedText ( bool  preserveLineBreaks  )  const

Returns the text which is currently selected.

Parameters:
preserveLineBreaks See Screen::selectedText()

Definition at line 118 of file ScreenWindow.cpp.

void Konsole::ScreenWindow::selectionChanged (  )  [signal]

Emitted when the selection is changed.

void ScreenWindow::setScreen ( Screen *  screen  ) 

Sets the screen which this window looks onto.

Definition at line 46 of file ScreenWindow.cpp.

void ScreenWindow::setSelectionEnd ( int  column,
int  line 
)

Sets the end of the selection to the given line and column within the window.

Definition at line 141 of file ScreenWindow.cpp.

void ScreenWindow::setSelectionStart ( int  column,
int  line,
bool  columnMode 
)

Sets the start of the selection to the given line and column within the window.

Definition at line 133 of file ScreenWindow.cpp.

void ScreenWindow::setTrackOutput ( bool  trackOutput  ) 

Specifies whether the window should automatically move to the bottom of the screen when new output is added.

If this is set to true, the window will be moved to the bottom of the associated screen ( see screen() ) when the notifyOutputChanged() method is called.

Definition at line 235 of file ScreenWindow.cpp.

void ScreenWindow::setWindowLines ( int  lines  ) 

Sets the number of lines in the window.

Definition at line 161 of file ScreenWindow.cpp.

bool ScreenWindow::trackOutput (  )  const

Returns whether the window automatically moves to the bottom of the screen as new output is added.

See setTrackOutput()

Definition at line 240 of file ScreenWindow.cpp.

int ScreenWindow::windowColumns (  )  const

Returns the number of columns in the window.

Definition at line 171 of file ScreenWindow.cpp.

int ScreenWindow::windowLines (  )  const

Returns the number of lines in the window.

Definition at line 166 of file ScreenWindow.cpp.


The documentation for this class was generated from the following files:
  • ScreenWindow.h
  • ScreenWindow.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