KDE API ReferenceKonsole
#include <Part.h>
Public Slots | |
| void | changeSessionSettings (const QString &text) |
| void | createSession (const QString &profileName=QString(), const QString &directory=QString()) |
| QString | currentWorkingDirectory () const |
| void | openTeletype (int ptyMasterFd) |
| QStringList | profileNameList () const |
| void | setMonitorActivityEnabled (bool enabled) |
| void | setMonitorSilenceEnabled (bool enabled) |
| void | showEditCurrentProfileDialog (QWidget *parent) |
| void | showManageProfilesDialog (QWidget *parent) |
Signals | |
| void | activityDetected () |
| void | currentDirectoryChanged (const QString &dir) |
| void | overrideShortcut (QKeyEvent *event, bool &override) |
| void | silenceDetected () |
Public Member Functions | |
| Part (QWidget *parentWidget, QObject *parent, const QVariantList &) | |
| virtual | ~Part () |
| virtual int | foregroundProcessId () |
| virtual QString | foregroundProcessName () |
| virtual void | sendInput (const QString &text) |
| virtual void | showShellInDir (const QString &dir) |
| virtual void | startProgram (const QString &program, const QStringList &arguments) |
| virtual int | terminalProcessId () |
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.
Constructor & Destructor Documentation
Member Function Documentation
|
signal |
Emitted when activity has been detected in the active session.
Monitoring for activity has to be enabled first using setMonitorActivityEnabled().
|
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.
|
slot |
creates and run a session using the specified profile and directory
- Parameters
-
profileName Specifies the name of the profile to create session directory specifies The initial working directory of the created session
This is highly experimental. Do not use it at the moment
|
signal |
Emitted when the current working directory of the active session has changed.
|
slot |
Returns the current working directory of the active session.
TODO: this should better be moved into TerminalInterfaceV2.
|
virtual |
Reimplemented from TerminalInterfaceV2.
|
virtual |
Reimplemented from TerminalInterfaceV2.
|
protectedvirtual |
|
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
|
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
|
slot |
|
virtual |
|
slot |
Toggles monitoring for activity in the active session.
If activity is detected, the activityDetected() signal is emitted.
- Parameters
-
enabled Whether to enable or disable monitoring for activity.
|
slot |
Toggles monitoring for silence in the active session.
If silence is detected, the silenceDetected() signal is emitted.
- Parameters
-
enabled Whether to enable or disable monitoring for silence.
|
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.
|
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.
|
virtual |
|
signal |
Emitted when silence has been detected in the active session.
Monitoring for silence has to be enabled first using setMonitorSilenceEnabled().
|
virtual |
|
virtual |
Reimplemented from TerminalInterfaceV2.
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.
