Konsole
Konsole::Part Class Reference
A re-usable terminal emulator component using the KParts framework which can be used to embed terminal emulators into other applications. More...
#include <Part.h>

Public Slots | |
void | changeSessionSettings (const QString &text) |
void | openTeletype (int ptyMasterFd) |
void | showEditCurrentProfileDialog (QWidget *parent) |
void | showManageProfilesDialog (QWidget *parent) |
Signals | |
void | overrideShortcut (QKeyEvent *event, bool &override) |
Public Member Functions | |
Part (QWidget *parentWidget, QObject *parent=0) | |
virtual void | sendInput (const QString &text) |
virtual void | showShellInDir (const QString &dir) |
virtual void | startProgram (const QString &program, const QStringList &arguments) |
virtual | ~Part () |
Protected Member Functions | |
virtual bool | openFile () |
virtual bool | openUrl (const KUrl &url) |
Detailed Description
A re-usable terminal emulator component using the KParts framework which can be used to embed terminal emulators into other applications.Definition at line 59 of file Part.h.
Constructor & Destructor Documentation
Constructs a new Konsole part with the specified parent.
Member Function Documentation
void Part::changeSessionSettings | ( | const QString & | text | ) | [slot] |
Sends a profile change command to the active session.
This is equivalent to using the konsoleprofile tool within the session to change its settings. The text
string is a semi-colon separated list of property=value pairs, eg. "colors=Linux Colors"
See the documentation for konsoleprofile for information on the format of text
This is experimental API and not guaranteed to be present in later KDE 4 releases.
bool Part::openFile | ( | ) | [protected, virtual] |
void Part::openTeletype | ( | int | ptyMasterFd | ) | [slot] |
Connects to an existing pseudo-teletype.
See Session::openTeletype(). This must be called before the session is started by startProgram(), or showShellInDir()
- Parameters:
-
ptyMasterFd The file descriptor of the pseudo-teletype (pty) master
bool Part::openUrl | ( | const KUrl & | url | ) | [protected, virtual] |
void Konsole::Part::overrideShortcut | ( | QKeyEvent * | event, | |
bool & | override | |||
) | [signal] |
Emitted when the key sequence for a shortcut, which is also a valid terminal key sequence, is pressed while the terminal has focus.
By responding to this signal, the controlling application can choose whether to execute the action associated with the shortcut or ignore the shortcut and send the key sequence to the terminal application.
In the embedded terminal, shortcuts are overridden and sent to the terminal by default. Set override
to false to prevent this happening and allow the shortcut to be triggered normally.
overrideShortcut() is not called for shortcuts which are not valid terminal key sequences, eg. shortcuts with two or more modifiers.
- Parameters:
-
event Describes the keys that were pressed. override Set this to false to prevent the terminal display from overriding the shortcut
void Part::sendInput | ( | const QString & | text | ) | [virtual] |
void Part::showEditCurrentProfileDialog | ( | QWidget * | parent | ) | [slot] |
Shows the dialog used to edit the profile used by the active session.
The dialog will be non-modal and will delete itself when it is closed.
This is experimental API and not guaranteed to be present in later KDE 4 releases.
- Parameters:
-
parent The parent widget of the new dialog.
void Part::showManageProfilesDialog | ( | QWidget * | parent | ) | [slot] |
Shows the dialog used to manage profiles in Konsole.
The dialog will be non-modal and will delete itself when it is closed.
This is experimental API and not guaranteed to be present in later KDE 4 releases.
- Parameters:
-
parent The parent widget of the new dialog.
void Part::showShellInDir | ( | const QString & | dir | ) | [virtual] |
void Part::startProgram | ( | const QString & | program, | |
const QStringList & | arguments | |||
) | [virtual] |
The documentation for this class was generated from the following files: