Detailed Description

TerminalInterface is an interface implemented by KonsolePart to allow developers access to the KonsolePart in ways that are not possible through the normal KPart interface.

Note that besides the functions below here, KonsolePart also has some signals you can connect to. They aren't in this class cause we can't have signals without having a QObject, which TerminalInterface is not.

These are some signals you can connect to: void currentDirectoryChanged(const QString& dir);

See the example code below for how to connect to these.

Use it like this:

// Query the .desktop file to get service information about konsolepart
KService::Ptr service = KService::serviceByDesktopName("konsolepart");

if (!service) {
    QMessageBox::critical(this, tr("Konsole not installed"), tr("Please install the kde konsole and try again!"), QMessageBox::Ok);
    return ;
}

// Create one instance of konsolepart
KParts::ReadOnlyPart *part = service->createInstance<KParts::ReadOnlyPart>(parent, parentWidget, QVariantList());

if (!part) {
    return;
}

// Cast the konsolepart to the TerminalInterface..
TerminalInterface *terminalIface = qobject_cast<TerminalInterface *>(part);

if (!terminalIface) {
    return;
}

// Now use the interface in all sorts of ways, e.g.
//    terminalIface->showShellInDir(QDir::home().path());
// Or:
//    QStringList list;
//    list.append("python");
//    terminalIface->startProgram( QString::fromUtf8( "/usr/bin/python" ), list);
// Or connect to one of the signals. Connect to the Part object,
// not to the TerminalInterface, since the latter is not a QObject,
// and as such does not have signals..:
connect(part, &KParts::ReadOnlyPart::currentDirectoryChanged, this, [this](const QString &dirPath) {
    currentDirectoryChanged(dirPath);
});
// etc.

@author Dominique Devriese <devriese@kde.org>