KDevMakeFrontend Class Reference

#include <kdevmakefrontend.h>

Signals
void	commandFinished (const TQString &command)
void	commandFailed (const TQString &command)

Public Member Functions
	KDevMakeFrontend (const KDevPluginInfo *info, TQObject *parent=0, const char *name=0)
virtual TQWidget *	widget ()
virtual void	queueCommand (const TQString &dir, const TQString &command)=0
virtual bool	isRunning ()=0
virtual void	updateSettingsFromConfig ()=0

Detailed Description

KDevelop make frontend interface.

This is the abstract base class for plugins that are able to run "make" or similar commands to build a project, api documentation, etc.

Instances that implement this interface are available through extension architecture:

KDevMakeFrontend *mf = extension<KDevMakeFrontend>("TDevelop/MakeFrontend");
if (mf) {
    // do something
} else {
    // fail
}

See also

KDevPlugin::extension method documentation.

Definition at line 53 of file kdevmakefrontend.h.

Constructor & Destructor Documentation

KDevMakeFrontend()

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

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 69 of file kdevmakefrontend.h.

Member Function Documentation

commandFailed

void KDevMakeFrontend::commandFailed ( const TQString & command )

signal

Emitted if a command failed.

commandFinished

void KDevMakeFrontend::commandFinished ( const TQString & command )

signal

Only emitted if the command was succesfully finished.

isRunning()

virtual bool KDevMakeFrontend::isRunning ( )

pure virtual

Returns

Whether the application is currently running.

queueCommand()

virtual void KDevMakeFrontend::queueCommand ( const TQString & dir, const TQString & command )

pure virtual

The component shall start to execute a make-like command.

Commands are always asynchronous. You can submit several jobs without caring about another job already running. There are executed in the order in which they are submitted. If one of then fails, all following jobs are dropped. You should not make any assumptions about the directory in which the command is started. If the command depends on that, put and explicit 'cd' into the command.

Parameters

dir	A starting directory to find files when parsing compiler error messages.
command	A shell command to execute.

updateSettingsFromConfig()

virtual void KDevMakeFrontend::updateSettingsFromConfig ( )

pure virtual

Advices to synchronize the settings from TDEConfig because they were changed externally.

widget()

virtual TQWidget * KDevMakeFrontend::widget ( )

inlinevirtual

Returns

The widget where the make output is shown.

Definition at line 73 of file kdevmakefrontend.h.

---

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

• kdevmakefrontend.h