• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • KDevelop Extension Interfaces Library
 

KDevelop Extension Interfaces Library

Public Slots | Public Member Functions | List of all members
KDevAppFrontend Class Referenceabstract

#include <kdevappfrontend.h>

Inherits KDevPlugin.

Public Slots

virtual void startAppCommand (const TQString &directory, const TQString &program, bool inTerminal)=0
 
virtual void stopApplication ()=0
 
virtual void insertStdoutLine (const TQCString &line)=0
 
virtual void insertStderrLine (const TQCString &line)=0
 
virtual void addPartialStderrLine (const TQCString &line)=0
 
virtual void addPartialStdoutLine (const TQCString &line)=0
 
virtual void clearView ()=0
 

Public Member Functions

 KDevAppFrontend (const KDevPluginInfo *info, TQObject *parent=0, const char *name=0)
 
virtual bool isRunning ()=0
 

Detailed Description

Application frontend interface.

This interface is responsible for handling the running of an application in KDevelop. Currently, this interface defines ways to do the following:

  • check if the application is running;
  • execute the application;
  • stop the currently running application;
  • control the output view as seen in the 'Application' tool dock.

Instances that implement this interface are available through extension architecture:

KDevAppFrontend *apf = extension<KDevAppFrontend>("TDevelop/AppFrontend");
if (apf) {
// do something
} else {
// fail
}
See also
KDevPlugin::extension method documentation.

Definition at line 57 of file kdevappfrontend.h.

Constructor & Destructor Documentation

◆ KDevAppFrontend()

KDevAppFrontend::KDevAppFrontend ( const KDevPluginInfo *  info,
TQObject *  parent = 0,
const char *  name = 0 
)
inline

Constructor.

Parameters
infoImportant information about the plugin - plugin internal and generic (GUI) name, description, a list of authors, etc. That information is used to show plugin information in various places like "about application" dialog, plugin selector dialog, etc. Plugin does not take ownership on info object, also its lifetime should be equal to the lifetime of the plugin.
parentThe parent object for the plugin. Parent object must implement KDevApi interface. Otherwise the plugin will not be constructed.
nameThe internal name which identifies the plugin.

Definition at line 72 of file kdevappfrontend.h.

Member Function Documentation

◆ clearView

virtual void KDevAppFrontend::clearView ( )
pure virtualslot

Clears the output view.

◆ insertStderrLine

virtual void KDevAppFrontend::insertStderrLine ( const TQCString &  line)
pure virtualslot

Inserts a string into the application output view marked as stderr output (usually colored).

Parameters
lineAn error string to insert.

◆ insertStdoutLine

virtual void KDevAppFrontend::insertStdoutLine ( const TQCString &  line)
pure virtualslot

Inserts a string into the application output view.

Parameters
lineA string to insert.

◆ isRunning()

virtual bool KDevAppFrontend::isRunning ( )
pure virtual
Returns
Whether the application is currently running.

◆ startAppCommand

virtual void KDevAppFrontend::startAppCommand ( const TQString &  directory,
const TQString &  program,
bool  inTerminal 
)
pure virtualslot

The component shall start to execute an app-like command.

Running the application is always asynchronous.

Parameters
directoryThe working directory to start the app in, if empty then the user's home directory is used.
programA program to start.
inTerminalIf true then the program is started in an external konsole.

◆ stopApplication

virtual void KDevAppFrontend::stopApplication ( )
pure virtualslot

Stops the currently running application.


The documentation for this class was generated from the following file:
  • kdevappfrontend.h

KDevelop Extension Interfaces Library

Skip menu "KDevelop Extension Interfaces Library"
  • Main Page
  • Alphabetical List
  • Class List
  • File List
  • Class Members

KDevelop Extension Interfaces Library

Skip menu "KDevelop Extension Interfaces Library"
  • buildtools
  •   lib
  •     base
  •     parsers
  •       autotools
  •       qmake
  •     widgets
  •   api
  • languages
  •   lib
  •     debugger
  •     designer_integration
  •     interfaces
  • lib
  •   catalog
  •   interfaces
  •     extensions
  •     external
  •     extras
  •   util
  •   widgets
  •     propeditor
  • parts
  •   documentation
  •     interfaces
  • src
  •   profileengine
  •     lib
Generated for KDevelop Extension Interfaces Library by doxygen 1.8.13
This website is maintained by Timothy Pearson.