TerminalInterface Class Reference

#include <kde_terminal_interface.h>

Inheritance diagram for TerminalInterface:

List of all members.

Public Member Functions
virtual	~TerminalInterface ()
virtual void	sendInput (const QString &text)=0
virtual void	showShellInDir (const QString &dir)=0
virtual void	startProgram (const QString &program, const QStringList &args)=0

---

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* p = service->createInstance<KParts::ReadOnlyPart>(parent, parentWidget, QVariantList());

  if (!p)
  {
      return;
  }

  // cast the konsolepart to the TerminalInterface..
  TerminalInterface* t = qobject_cast<TerminalInterface*>(p);

  if (!t)
  {
      return;
  }

  // now use the interface in all sorts of ways, e.g.
  //    t->showShellInDir( QDir::home().path() );
  // or:
  //    QStringList l;
  //    l.append( "python" );
  //    t->startProgram( QString::fromUtf8( "/usr/bin/python" ), l);
  // or connect to one of the signals.  Connect to the Part object,
  // not to the TerminalInterface, since the latter is no QObject,
  // and as such cannot have signals..:
  //    connect(p, SIGNAL(currentDirectoryChanged(QString)),
  //             this, SLOT(currentDirectoryChanged(QString)));
  // etc.

Author:

Dominique Devriese <devriese@kde.org>

Definition at line 85 of file kde_terminal_interface.h.

---

Constructor & Destructor Documentation

virtual TerminalInterface::~TerminalInterface

(

)

[inline, virtual]

Definition at line 88 of file kde_terminal_interface.h.

---

Member Function Documentation

virtual void TerminalInterface::sendInput

(

const QString &

text

)

[pure virtual]

This sends.

Parameters:

text	as input to the currently running program..

virtual void TerminalInterface::showShellInDir

(

const QString &

dir

)

[pure virtual]

virtual void TerminalInterface::startProgram	(	const QString &	program,
		const QStringList &	args
	)		[pure virtual]

This starts program, with arguments args.

---

The documentation for this class was generated from the following file:

• kde_terminal_interface.h