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()
|
inline |
Constructor.
- Parameters
-
info Important 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. parent The parent object for the plugin. Parent object must implement KDevApi interface. Otherwise the plugin will not be constructed. name The internal name which identifies the plugin.
Definition at line 72 of file kdevappfrontend.h.
Member Function Documentation
◆ clearView
|
pure virtualslot |
Clears the output view.
◆ insertStderrLine
|
pure virtualslot |
Inserts a string into the application output view marked as stderr output (usually colored).
- Parameters
-
line An error string to insert.
◆ insertStdoutLine
|
pure virtualslot |
Inserts a string into the application output view.
- Parameters
-
line A string to insert.
◆ isRunning()
|
pure virtual |
- Returns
- Whether the application is currently running.
◆ startAppCommand
|
pure virtualslot |
The component shall start to execute an app-like command.
Running the application is always asynchronous.
- Parameters
-
directory The working directory to start the app in, if empty then the user's home directory is used. program A program to start. inTerminal If true then the program is started in an external konsole.
◆ stopApplication
|
pure virtualslot |
Stops the currently running application.
The documentation for this class was generated from the following file: