MauiKit Terminal
ScreenWindow.cpp
92 Screen::fillWithDefaultChar(std::span(_windowBuffer).subspan(_windowBufferSize - charsToFill), charsToFill);
Command
This enum describes commands which are associated with particular key sequences.
Definition KeyboardTranslator.h:94
@ ScrollPageDownCommand
Scroll the terminal display down one page.
Definition KeyboardTranslator.h:102
@ ScrollDownToBottomCommand
Scroll the terminal display down to the end of history.
Definition KeyboardTranslator.h:112
@ ScrollUpToTopCommand
Scroll the terminal display up to the start of history.
Definition KeyboardTranslator.h:110
@ ScrollLineDownCommand
Scroll the terminal display down one line.
Definition KeyboardTranslator.h:106
void setSelectionStart(int column, int line, bool columnMode)
Sets the start of the selection to the given line and column within the window.
Definition ScreenWindow.cpp:131
void setSelectionEnd(int column, int line)
Sets the end of the selection to the given line and column within the window.
Definition ScreenWindow.cpp:139
void getSelectionEnd(int &column, int &line)
Retrieves the end of the selection within the window.
Definition ScreenWindow.cpp:126
RelativeScrollMode
Describes the units which scrollBy() moves the window by.
Definition ScreenWindow.h:173
@ ScrollPages
Scroll the window down by a given number of pages, where one page is windowLines() lines.
Definition ScreenWindow.h:180
void setTrackOutput(bool trackOutput)
Specifies whether the window should automatically move to the bottom of the screen when new output is...
Definition ScreenWindow.cpp:230
QRect scrollRegion() const
Returns the area of the window which was last scrolled, this is usually the whole window area.
Definition ScreenWindow.cpp:250
int currentLine() const
Returns the index of the line which is currently at the top of this window.
Definition ScreenWindow.cpp:194
bool isSelected(int column, int line)
Returns true if the character at line , column is part of the selection.
Definition ScreenWindow.cpp:147
int lineCount() const
Returns the total number of lines in the screen.
Definition ScreenWindow.cpp:174
void getSelectionStart(int &column, int &line)
Retrieves the start of the selection within the window.
Definition ScreenWindow.cpp:121
int columnCount() const
Returns the total number of columns in the screen.
Definition ScreenWindow.cpp:179
QString selectedText(bool preserveLineBreaks) const
Returns the text which is currently selected.
Definition ScreenWindow.cpp:116
int windowColumns() const
Returns the number of columns in the window.
Definition ScreenWindow.cpp:169
void selectionChanged()
Emitted when the selection is changed.
bool trackOutput() const
Returns whether the window automatically moves to the bottom of the screen as new output is added.
Definition ScreenWindow.cpp:235
ScreenWindow(QObject *parent=nullptr)
Constructs a new screen window with the given parent.
Definition ScreenWindow.cpp:28
void setScreen(Screen *screen)
Sets the screen which this window looks onto.
Definition ScreenWindow.cpp:41
void notifyOutputChanged()
Notifies the window that the contents of the associated terminal screen have changed.
Definition ScreenWindow.cpp:260
QPoint cursorPosition() const
Returns the position of the cursor within the window.
Definition ScreenWindow.cpp:184
void scrollBy(RelativeScrollMode mode, int amount)
Scrolls the window relative to its current position on the screen.
Definition ScreenWindow.cpp:199
int scrollCount() const
Returns the number of lines which the region of the window specified by scrollRegion() has been scrol...
Definition ScreenWindow.cpp:240
void scrolled(int line)
Emitted when the screen window is scrolled to a different position.
void scrollTo(int line)
Scrolls the window so that line is at the top of the window.
Definition ScreenWindow.cpp:213
void resetScrollCount()
Resets the count of scrolled lines returned by scrollCount()
Definition ScreenWindow.cpp:245
std::span< Character > getImage()
Returns the image of characters which are currently visible through this window onto the screen.
Definition ScreenWindow.cpp:53
Screen * screen() const
Returns the screen which this window looks onto.
Definition ScreenWindow.cpp:48
QVector< LineProperty > getLineProperties()
Returns the line attributes associated with the lines of characters which are currently visible throu...
Definition ScreenWindow.cpp:106
void outputChanged()
Emitted when the contents of the associated terminal screen (see screen()) changes.
void setWindowLines(int lines)
Sets the number of lines in the window.
Definition ScreenWindow.cpp:159
void getImage(std::span< Character > dest, int size, int startLine, int endLine) const
Returns the current screen image.
Definition Screen.cpp:475
void setSelectionEnd(const int column, const int line)
Sets the end of the current selection.
Definition Screen.cpp:1061
static void fillWithDefaultChar(std::span< Character > dest, int count)
Fills the buffer dest with count instances of the default (ie.
Definition Screen.cpp:1329
void getSelectionStart(int &column, int &line) const
Retrieves the start of the selection or the cursor position if there is no selection.
Definition Screen.cpp:1029
void getSelectionEnd(int &column, int &line) const
Retrieves the end of the selection or the cursor position if there is no selection.
Definition Screen.cpp:1039
int getCursorX() const
Returns the column which the cursor is positioned at.
Definition Screen.cpp:823
QRect lastScrolledRegion() const
Returns the region of the image which was last scrolled.
Definition Screen.cpp:746
int scrolledLines() const
Returns the number of lines that the image has been scrolled up or down by, since the last call to re...
Definition Screen.cpp:720
void setSelectionStart(const int column, const int line, const bool blockSelectionMode)
Sets the start of the selection.
Definition Screen.cpp:1049
bool isSelected(const int column, const int line) const
Returns true if the character at (column, line) is part of the current selection.
Definition Screen.cpp:1092
QVector< LineProperty > getLineProperties(int startLine, int endLine) const
Returns the additional attributes associated with lines in the image.
Definition Screen.cpp:508
int droppedLines() const
Returns the number of lines of output which have been dropped from the history since the last call to...
Definition Screen.cpp:724
void update(Part *part, const QByteArray &data, qint64 dataSize)
void resize(qsizetype size)
qsizetype size() const const
Q_EMITQ_EMIT
void setX(int x)
void setY(int y)
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Aug 30 2024 11:51:42 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Aug 30 2024 11:51:42 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.