KDE API ReferenceKonsole
#include <Pty.h>
Public Slots | |
| void | sendData (const char *buffer, int length) |
| void | setUtf8Mode (bool on) |
Signals | |
| void | receivedData (const char *buffer, int length) |
Public Member Functions | |
| Pty (QObject *parent=0) | |
| Pty (int ptyMasterFd, QObject *parent=0) | |
| ~Pty () | |
| void | closePty () |
| char | eraseChar () const |
| bool | flowControlEnabled () const |
| int | foregroundProcessGroup () const |
| void | setEraseChar (char eraseChar) |
| void | setFlowControlEnabled (bool on) |
| void | setInitialWorkingDirectory (const QString &dir) |
| void | setWindowSize (int columns, int lines) |
| void | setWriteable (bool writeable) |
| int | start (const QString &program, const QStringList &arguments, const QStringList &environment) |
| QSize | windowSize () const |
Protected Member Functions | |
| void | setupChildProcess () |
Detailed Description
The Pty class is used to start the terminal process, send data to it, receive data from it and manipulate various properties of the pseudo-teletype interface used to communicate with the process.
To use this class, construct an instance and connect to the sendData slot and receivedData signal to send data to or receive data from the process.
To start the terminal process, call the start() method with the program name and appropriate arguments.
Constructor & Destructor Documentation
|
explicit |
Constructs a new Pty.
Connect to the sendData() slot and receivedData() signal to prepare for sending and receiving data from the terminal process.
To start the terminal process, call the run() method with the name of the program to start and appropriate arguments.
|
explicit |
Member Function Documentation
| void Pty::closePty | ( | ) |
| bool Pty::flowControlEnabled | ( | ) | const |
| int Pty::foregroundProcessGroup | ( | ) | const |
Returns the process id of the teletype's current foreground process.
This is the process which is currently reading input sent to the terminal via. sendData()
If there is a problem reading the foreground process group, 0 will be returned.
|
signal |
Emitted when a new block of data is received from the teletype.
- Parameters
-
buffer Pointer to the data received. length Length of buffer
|
slot |
Sends data to the process currently controlling the teletype ( whose id is returned by foregroundProcessGroup() )
- Parameters
-
buffer Pointer to the data to send. length Length of buffer.
| void Pty::setEraseChar | ( | char | eraseChar | ) |
| void Pty::setFlowControlEnabled | ( | bool | on | ) |
Enables or disables Xon/Xoff flow control.
The flow control setting may be changed later by a terminal application, so flowControlEnabled() may not equal the value of on in the previous call to setFlowControlEnabled()
| void Pty::setInitialWorkingDirectory | ( | const QString & | dir | ) |
|
slot |
| void Pty::setWindowSize | ( | int | columns, |
| int | lines | ||
| ) |
| void Pty::setWriteable | ( | bool | writeable | ) |
| int Pty::start | ( | const QString & | program, |
| const QStringList & | arguments, | ||
| const QStringList & | environment | ||
| ) |
Starts the terminal process.
Returns 0 if the process was started successfully or non-zero otherwise.
- Parameters
-
program Path to the program to start arguments Arguments to pass to the program being started environment A list of key=value pairs which will be added to the environment for the new process. At the very least this should include an assignment for the TERM environment variable.
| QSize Pty::windowSize | ( | ) | const |
Returns the size of the window used by this teletype.
See setWindowSize()
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat May 9 2020 03:56:28 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.
